google-cloud-dataflow-v1beta3 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +169 -0
- data/LICENSE.md +201 -0
- data/README.md +139 -0
- data/lib/google-cloud-dataflow-v1beta3.rb +21 -0
- data/lib/google/cloud/dataflow/v1beta3.rb +43 -0
- data/lib/google/cloud/dataflow/v1beta3/flex_templates_service.rb +48 -0
- data/lib/google/cloud/dataflow/v1beta3/flex_templates_service/client.rb +376 -0
- data/lib/google/cloud/dataflow/v1beta3/flex_templates_service/credentials.rb +54 -0
- data/lib/google/cloud/dataflow/v1beta3/jobs.rb +49 -0
- data/lib/google/cloud/dataflow/v1beta3/jobs/client.rb +868 -0
- data/lib/google/cloud/dataflow/v1beta3/jobs/credentials.rb +54 -0
- data/lib/google/cloud/dataflow/v1beta3/messages.rb +49 -0
- data/lib/google/cloud/dataflow/v1beta3/messages/client.rb +399 -0
- data/lib/google/cloud/dataflow/v1beta3/messages/credentials.rb +54 -0
- data/lib/google/cloud/dataflow/v1beta3/metrics.rb +49 -0
- data/lib/google/cloud/dataflow/v1beta3/metrics/client.rb +560 -0
- data/lib/google/cloud/dataflow/v1beta3/metrics/credentials.rb +54 -0
- data/lib/google/cloud/dataflow/v1beta3/snapshots.rb +48 -0
- data/lib/google/cloud/dataflow/v1beta3/snapshots/client.rb +515 -0
- data/lib/google/cloud/dataflow/v1beta3/snapshots/credentials.rb +54 -0
- data/lib/google/cloud/dataflow/v1beta3/templates_service.rb +48 -0
- data/lib/google/cloud/dataflow/v1beta3/templates_service/client.rb +543 -0
- data/lib/google/cloud/dataflow/v1beta3/templates_service/credentials.rb +54 -0
- data/lib/google/cloud/dataflow/v1beta3/version.rb +28 -0
- data/lib/google/dataflow/v1beta3/environment_pb.rb +167 -0
- data/lib/google/dataflow/v1beta3/jobs_pb.rb +292 -0
- data/lib/google/dataflow/v1beta3/jobs_services_pb.rb +83 -0
- data/lib/google/dataflow/v1beta3/messages_pb.rb +83 -0
- data/lib/google/dataflow/v1beta3/messages_services_pb.rb +52 -0
- data/lib/google/dataflow/v1beta3/metrics_pb.rb +126 -0
- data/lib/google/dataflow/v1beta3/metrics_services_pb.rb +61 -0
- data/lib/google/dataflow/v1beta3/snapshots_pb.rb +75 -0
- data/lib/google/dataflow/v1beta3/snapshots_services_pb.rb +49 -0
- data/lib/google/dataflow/v1beta3/streaming_pb.rb +105 -0
- data/lib/google/dataflow/v1beta3/templates_pb.rb +213 -0
- data/lib/google/dataflow/v1beta3/templates_services_pb.rb +65 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/field_behavior.rb +65 -0
- data/proto_docs/google/api/resource.rb +283 -0
- data/proto_docs/google/dataflow/v1beta3/environment.rb +583 -0
- data/proto_docs/google/dataflow/v1beta3/jobs.rb +927 -0
- data/proto_docs/google/dataflow/v1beta3/messages.rb +226 -0
- data/proto_docs/google/dataflow/v1beta3/metrics.rb +367 -0
- data/proto_docs/google/dataflow/v1beta3/snapshots.rb +160 -0
- data/proto_docs/google/dataflow/v1beta3/streaming.rb +280 -0
- data/proto_docs/google/dataflow/v1beta3/templates.rb +669 -0
- data/proto_docs/google/protobuf/any.rb +141 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/struct.rb +96 -0
- data/proto_docs/google/protobuf/timestamp.rb +129 -0
- data/proto_docs/google/rpc/status.rb +46 -0
- metadata +243 -0
@@ -0,0 +1,226 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2021 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module Dataflow
|
23
|
+
module V1beta3
|
24
|
+
# A particular message pertaining to a Dataflow job.
|
25
|
+
# @!attribute [rw] id
|
26
|
+
# @return [::String]
|
27
|
+
# Deprecated.
|
28
|
+
# @!attribute [rw] time
|
29
|
+
# @return [::Google::Protobuf::Timestamp]
|
30
|
+
# The timestamp of the message.
|
31
|
+
# @!attribute [rw] message_text
|
32
|
+
# @return [::String]
|
33
|
+
# The text of the message.
|
34
|
+
# @!attribute [rw] message_importance
|
35
|
+
# @return [::Google::Cloud::Dataflow::V1beta3::JobMessageImportance]
|
36
|
+
# Importance level of the message.
|
37
|
+
class JobMessage
|
38
|
+
include ::Google::Protobuf::MessageExts
|
39
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
40
|
+
end
|
41
|
+
|
42
|
+
# A rich message format, including a human readable string, a key for
|
43
|
+
# identifying the message, and structured data associated with the message for
|
44
|
+
# programmatic consumption.
|
45
|
+
# @!attribute [rw] message_text
|
46
|
+
# @return [::String]
|
47
|
+
# Human-readable version of message.
|
48
|
+
# @!attribute [rw] message_key
|
49
|
+
# @return [::String]
|
50
|
+
# Identifier for this message type. Used by external systems to
|
51
|
+
# internationalize or personalize message.
|
52
|
+
# @!attribute [rw] parameters
|
53
|
+
# @return [::Array<::Google::Cloud::Dataflow::V1beta3::StructuredMessage::Parameter>]
|
54
|
+
# The structured data associated with this message.
|
55
|
+
class StructuredMessage
|
56
|
+
include ::Google::Protobuf::MessageExts
|
57
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
58
|
+
|
59
|
+
# Structured data associated with this message.
|
60
|
+
# @!attribute [rw] key
|
61
|
+
# @return [::String]
|
62
|
+
# Key or name for this parameter.
|
63
|
+
# @!attribute [rw] value
|
64
|
+
# @return [::Google::Protobuf::Value]
|
65
|
+
# Value for this parameter.
|
66
|
+
class Parameter
|
67
|
+
include ::Google::Protobuf::MessageExts
|
68
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
69
|
+
end
|
70
|
+
end
|
71
|
+
|
72
|
+
# A structured message reporting an autoscaling decision made by the Dataflow
|
73
|
+
# service.
|
74
|
+
# @!attribute [rw] current_num_workers
|
75
|
+
# @return [::Integer]
|
76
|
+
# The current number of workers the job has.
|
77
|
+
# @!attribute [rw] target_num_workers
|
78
|
+
# @return [::Integer]
|
79
|
+
# The target number of workers the worker pool wants to resize to use.
|
80
|
+
# @!attribute [rw] event_type
|
81
|
+
# @return [::Google::Cloud::Dataflow::V1beta3::AutoscalingEvent::AutoscalingEventType]
|
82
|
+
# The type of autoscaling event to report.
|
83
|
+
# @!attribute [rw] description
|
84
|
+
# @return [::Google::Cloud::Dataflow::V1beta3::StructuredMessage]
|
85
|
+
# A message describing why the system decided to adjust the current
|
86
|
+
# number of workers, why it failed, or why the system decided to
|
87
|
+
# not make any changes to the number of workers.
|
88
|
+
# @!attribute [rw] time
|
89
|
+
# @return [::Google::Protobuf::Timestamp]
|
90
|
+
# The time this event was emitted to indicate a new target or current
|
91
|
+
# num_workers value.
|
92
|
+
# @!attribute [rw] worker_pool
|
93
|
+
# @return [::String]
|
94
|
+
# A short and friendly name for the worker pool this event refers to,
|
95
|
+
# populated from the value of PoolStageRelation::user_pool_name.
|
96
|
+
class AutoscalingEvent
|
97
|
+
include ::Google::Protobuf::MessageExts
|
98
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
99
|
+
|
100
|
+
# Indicates the type of autoscaling event.
|
101
|
+
module AutoscalingEventType
|
102
|
+
# Default type for the enum. Value should never be returned.
|
103
|
+
TYPE_UNKNOWN = 0
|
104
|
+
|
105
|
+
# The TARGET_NUM_WORKERS_CHANGED type should be used when the target
|
106
|
+
# worker pool size has changed at the start of an actuation. An event
|
107
|
+
# should always be specified as TARGET_NUM_WORKERS_CHANGED if it reflects
|
108
|
+
# a change in the target_num_workers.
|
109
|
+
TARGET_NUM_WORKERS_CHANGED = 1
|
110
|
+
|
111
|
+
# The CURRENT_NUM_WORKERS_CHANGED type should be used when actual worker
|
112
|
+
# pool size has been changed, but the target_num_workers has not changed.
|
113
|
+
CURRENT_NUM_WORKERS_CHANGED = 2
|
114
|
+
|
115
|
+
# The ACTUATION_FAILURE type should be used when we want to report
|
116
|
+
# an error to the user indicating why the current number of workers
|
117
|
+
# in the pool could not be changed.
|
118
|
+
# Displayed in the current status and history widgets.
|
119
|
+
ACTUATION_FAILURE = 3
|
120
|
+
|
121
|
+
# Used when we want to report to the user a reason why we are
|
122
|
+
# not currently adjusting the number of workers.
|
123
|
+
# Should specify both target_num_workers, current_num_workers and a
|
124
|
+
# decision_message.
|
125
|
+
NO_CHANGE = 4
|
126
|
+
end
|
127
|
+
end
|
128
|
+
|
129
|
+
# Request to list job messages.
|
130
|
+
# Up to max_results messages will be returned in the time range specified
|
131
|
+
# starting with the oldest messages first. If no time range is specified
|
132
|
+
# the results with start with the oldest message.
|
133
|
+
# @!attribute [rw] project_id
|
134
|
+
# @return [::String]
|
135
|
+
# A project id.
|
136
|
+
# @!attribute [rw] job_id
|
137
|
+
# @return [::String]
|
138
|
+
# The job to get messages about.
|
139
|
+
# @!attribute [rw] minimum_importance
|
140
|
+
# @return [::Google::Cloud::Dataflow::V1beta3::JobMessageImportance]
|
141
|
+
# Filter to only get messages with importance >= level
|
142
|
+
# @!attribute [rw] page_size
|
143
|
+
# @return [::Integer]
|
144
|
+
# If specified, determines the maximum number of messages to
|
145
|
+
# return. If unspecified, the service may choose an appropriate
|
146
|
+
# default, or may return an arbitrarily large number of results.
|
147
|
+
# @!attribute [rw] page_token
|
148
|
+
# @return [::String]
|
149
|
+
# If supplied, this should be the value of next_page_token returned
|
150
|
+
# by an earlier call. This will cause the next page of results to
|
151
|
+
# be returned.
|
152
|
+
# @!attribute [rw] start_time
|
153
|
+
# @return [::Google::Protobuf::Timestamp]
|
154
|
+
# If specified, return only messages with timestamps >= start_time.
|
155
|
+
# The default is the job creation time (i.e. beginning of messages).
|
156
|
+
# @!attribute [rw] end_time
|
157
|
+
# @return [::Google::Protobuf::Timestamp]
|
158
|
+
# Return only messages with timestamps < end_time. The default is now
|
159
|
+
# (i.e. return up to the latest messages available).
|
160
|
+
# @!attribute [rw] location
|
161
|
+
# @return [::String]
|
162
|
+
# The [regional endpoint]
|
163
|
+
# (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
|
164
|
+
# contains the job specified by job_id.
|
165
|
+
class ListJobMessagesRequest
|
166
|
+
include ::Google::Protobuf::MessageExts
|
167
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
168
|
+
end
|
169
|
+
|
170
|
+
# Response to a request to list job messages.
|
171
|
+
# @!attribute [rw] job_messages
|
172
|
+
# @return [::Array<::Google::Cloud::Dataflow::V1beta3::JobMessage>]
|
173
|
+
# Messages in ascending timestamp order.
|
174
|
+
# @!attribute [rw] next_page_token
|
175
|
+
# @return [::String]
|
176
|
+
# The token to obtain the next page of results if there are more.
|
177
|
+
# @!attribute [rw] autoscaling_events
|
178
|
+
# @return [::Array<::Google::Cloud::Dataflow::V1beta3::AutoscalingEvent>]
|
179
|
+
# Autoscaling events in ascending timestamp order.
|
180
|
+
class ListJobMessagesResponse
|
181
|
+
include ::Google::Protobuf::MessageExts
|
182
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
183
|
+
end
|
184
|
+
|
185
|
+
# Indicates the importance of the message.
|
186
|
+
module JobMessageImportance
|
187
|
+
# The message importance isn't specified, or is unknown.
|
188
|
+
JOB_MESSAGE_IMPORTANCE_UNKNOWN = 0
|
189
|
+
|
190
|
+
# The message is at the 'debug' level: typically only useful for
|
191
|
+
# software engineers working on the code the job is running.
|
192
|
+
# Typically, Dataflow pipeline runners do not display log messages
|
193
|
+
# at this level by default.
|
194
|
+
JOB_MESSAGE_DEBUG = 1
|
195
|
+
|
196
|
+
# The message is at the 'detailed' level: somewhat verbose, but
|
197
|
+
# potentially useful to users. Typically, Dataflow pipeline
|
198
|
+
# runners do not display log messages at this level by default.
|
199
|
+
# These messages are displayed by default in the Dataflow
|
200
|
+
# monitoring UI.
|
201
|
+
JOB_MESSAGE_DETAILED = 2
|
202
|
+
|
203
|
+
# The message is at the 'basic' level: useful for keeping
|
204
|
+
# track of the execution of a Dataflow pipeline. Typically,
|
205
|
+
# Dataflow pipeline runners display log messages at this level by
|
206
|
+
# default, and these messages are displayed by default in the
|
207
|
+
# Dataflow monitoring UI.
|
208
|
+
JOB_MESSAGE_BASIC = 5
|
209
|
+
|
210
|
+
# The message is at the 'warning' level: indicating a condition
|
211
|
+
# pertaining to a job which may require human intervention.
|
212
|
+
# Typically, Dataflow pipeline runners display log messages at this
|
213
|
+
# level by default, and these messages are displayed by default in
|
214
|
+
# the Dataflow monitoring UI.
|
215
|
+
JOB_MESSAGE_WARNING = 3
|
216
|
+
|
217
|
+
# The message is at the 'error' level: indicating a condition
|
218
|
+
# preventing a job from succeeding. Typically, Dataflow pipeline
|
219
|
+
# runners display log messages at this level by default, and these
|
220
|
+
# messages are displayed by default in the Dataflow monitoring UI.
|
221
|
+
JOB_MESSAGE_ERROR = 4
|
222
|
+
end
|
223
|
+
end
|
224
|
+
end
|
225
|
+
end
|
226
|
+
end
|
@@ -0,0 +1,367 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2021 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module Dataflow
|
23
|
+
module V1beta3
|
24
|
+
# Identifies a metric, by describing the source which generated the
|
25
|
+
# metric.
|
26
|
+
# @!attribute [rw] origin
|
27
|
+
# @return [::String]
|
28
|
+
# Origin (namespace) of metric name. May be blank for user-define metrics;
|
29
|
+
# will be "dataflow" for metrics defined by the Dataflow service or SDK.
|
30
|
+
# @!attribute [rw] name
|
31
|
+
# @return [::String]
|
32
|
+
# Worker-defined metric name.
|
33
|
+
# @!attribute [rw] context
|
34
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
35
|
+
# Zero or more labeled fields which identify the part of the job this
|
36
|
+
# metric is associated with, such as the name of a step or collection.
|
37
|
+
#
|
38
|
+
# For example, built-in counters associated with steps will have
|
39
|
+
# context['step'] = <step-name>. Counters associated with PCollections
|
40
|
+
# in the SDK will have context['pcollection'] = <pcollection-name>.
|
41
|
+
class MetricStructuredName
|
42
|
+
include ::Google::Protobuf::MessageExts
|
43
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
44
|
+
|
45
|
+
# @!attribute [rw] key
|
46
|
+
# @return [::String]
|
47
|
+
# @!attribute [rw] value
|
48
|
+
# @return [::String]
|
49
|
+
class ContextEntry
|
50
|
+
include ::Google::Protobuf::MessageExts
|
51
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
52
|
+
end
|
53
|
+
end
|
54
|
+
|
55
|
+
# Describes the state of a metric.
|
56
|
+
# @!attribute [rw] name
|
57
|
+
# @return [::Google::Cloud::Dataflow::V1beta3::MetricStructuredName]
|
58
|
+
# Name of the metric.
|
59
|
+
# @!attribute [rw] kind
|
60
|
+
# @return [::String]
|
61
|
+
# Metric aggregation kind. The possible metric aggregation kinds are
|
62
|
+
# "Sum", "Max", "Min", "Mean", "Set", "And", "Or", and "Distribution".
|
63
|
+
# The specified aggregation kind is case-insensitive.
|
64
|
+
#
|
65
|
+
# If omitted, this is not an aggregated value but instead
|
66
|
+
# a single metric sample value.
|
67
|
+
# @!attribute [rw] cumulative
|
68
|
+
# @return [::Boolean]
|
69
|
+
# True if this metric is reported as the total cumulative aggregate
|
70
|
+
# value accumulated since the worker started working on this WorkItem.
|
71
|
+
# By default this is false, indicating that this metric is reported
|
72
|
+
# as a delta that is not associated with any WorkItem.
|
73
|
+
# @!attribute [rw] scalar
|
74
|
+
# @return [::Google::Protobuf::Value]
|
75
|
+
# Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min",
|
76
|
+
# "And", and "Or". The possible value types are Long, Double, and Boolean.
|
77
|
+
# @!attribute [rw] mean_sum
|
78
|
+
# @return [::Google::Protobuf::Value]
|
79
|
+
# Worker-computed aggregate value for the "Mean" aggregation kind.
|
80
|
+
# This holds the sum of the aggregated values and is used in combination
|
81
|
+
# with mean_count below to obtain the actual mean aggregate value.
|
82
|
+
# The only possible value types are Long and Double.
|
83
|
+
# @!attribute [rw] mean_count
|
84
|
+
# @return [::Google::Protobuf::Value]
|
85
|
+
# Worker-computed aggregate value for the "Mean" aggregation kind.
|
86
|
+
# This holds the count of the aggregated values and is used in combination
|
87
|
+
# with mean_sum above to obtain the actual mean aggregate value.
|
88
|
+
# The only possible value type is Long.
|
89
|
+
# @!attribute [rw] set
|
90
|
+
# @return [::Google::Protobuf::Value]
|
91
|
+
# Worker-computed aggregate value for the "Set" aggregation kind. The only
|
92
|
+
# possible value type is a list of Values whose type can be Long, Double,
|
93
|
+
# or String, according to the metric's type. All Values in the list must
|
94
|
+
# be of the same type.
|
95
|
+
# @!attribute [rw] distribution
|
96
|
+
# @return [::Google::Protobuf::Value]
|
97
|
+
# A struct value describing properties of a distribution of numeric values.
|
98
|
+
# @!attribute [rw] gauge
|
99
|
+
# @return [::Google::Protobuf::Value]
|
100
|
+
# A struct value describing properties of a Gauge.
|
101
|
+
# Metrics of gauge type show the value of a metric across time, and is
|
102
|
+
# aggregated based on the newest value.
|
103
|
+
# @!attribute [rw] internal
|
104
|
+
# @return [::Google::Protobuf::Value]
|
105
|
+
# Worker-computed aggregate value for internal use by the Dataflow
|
106
|
+
# service.
|
107
|
+
# @!attribute [rw] update_time
|
108
|
+
# @return [::Google::Protobuf::Timestamp]
|
109
|
+
# Timestamp associated with the metric value. Optional when workers are
|
110
|
+
# reporting work progress; it will be filled in responses from the
|
111
|
+
# metrics API.
|
112
|
+
class MetricUpdate
|
113
|
+
include ::Google::Protobuf::MessageExts
|
114
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
115
|
+
end
|
116
|
+
|
117
|
+
# Request to get job metrics.
|
118
|
+
# @!attribute [rw] project_id
|
119
|
+
# @return [::String]
|
120
|
+
# A project id.
|
121
|
+
# @!attribute [rw] job_id
|
122
|
+
# @return [::String]
|
123
|
+
# The job to get metrics for.
|
124
|
+
# @!attribute [rw] start_time
|
125
|
+
# @return [::Google::Protobuf::Timestamp]
|
126
|
+
# Return only metric data that has changed since this time.
|
127
|
+
# Default is to return all information about all metrics for the job.
|
128
|
+
# @!attribute [rw] location
|
129
|
+
# @return [::String]
|
130
|
+
# The [regional endpoint]
|
131
|
+
# (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
|
132
|
+
# contains the job specified by job_id.
|
133
|
+
class GetJobMetricsRequest
|
134
|
+
include ::Google::Protobuf::MessageExts
|
135
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
136
|
+
end
|
137
|
+
|
138
|
+
# JobMetrics contains a collection of metrics describing the detailed progress
|
139
|
+
# of a Dataflow job. Metrics correspond to user-defined and system-defined
|
140
|
+
# metrics in the job.
|
141
|
+
#
|
142
|
+
# This resource captures only the most recent values of each metric;
|
143
|
+
# time-series data can be queried for them (under the same metric names)
|
144
|
+
# from Cloud Monitoring.
|
145
|
+
# @!attribute [rw] metric_time
|
146
|
+
# @return [::Google::Protobuf::Timestamp]
|
147
|
+
# Timestamp as of which metric values are current.
|
148
|
+
# @!attribute [rw] metrics
|
149
|
+
# @return [::Array<::Google::Cloud::Dataflow::V1beta3::MetricUpdate>]
|
150
|
+
# All metrics for this job.
|
151
|
+
class JobMetrics
|
152
|
+
include ::Google::Protobuf::MessageExts
|
153
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
154
|
+
end
|
155
|
+
|
156
|
+
# Request to get job execution details.
|
157
|
+
# @!attribute [rw] project_id
|
158
|
+
# @return [::String]
|
159
|
+
# A project id.
|
160
|
+
# @!attribute [rw] job_id
|
161
|
+
# @return [::String]
|
162
|
+
# The job to get execution details for.
|
163
|
+
# @!attribute [rw] location
|
164
|
+
# @return [::String]
|
165
|
+
# The [regional endpoint]
|
166
|
+
# (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
|
167
|
+
# contains the job specified by job_id.
|
168
|
+
# @!attribute [rw] page_size
|
169
|
+
# @return [::Integer]
|
170
|
+
# If specified, determines the maximum number of stages to
|
171
|
+
# return. If unspecified, the service may choose an appropriate
|
172
|
+
# default, or may return an arbitrarily large number of results.
|
173
|
+
# @!attribute [rw] page_token
|
174
|
+
# @return [::String]
|
175
|
+
# If supplied, this should be the value of next_page_token returned
|
176
|
+
# by an earlier call. This will cause the next page of results to
|
177
|
+
# be returned.
|
178
|
+
class GetJobExecutionDetailsRequest
|
179
|
+
include ::Google::Protobuf::MessageExts
|
180
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
181
|
+
end
|
182
|
+
|
183
|
+
# Information about the progress of some component of job execution.
|
184
|
+
# @!attribute [rw] current_progress
|
185
|
+
# @return [::Float]
|
186
|
+
# The current progress of the component, in the range [0,1].
|
187
|
+
# @!attribute [rw] data_points
|
188
|
+
# @return [::Array<::Google::Cloud::Dataflow::V1beta3::ProgressTimeseries::Point>]
|
189
|
+
# History of progress for the component.
|
190
|
+
#
|
191
|
+
# Points are sorted by time.
|
192
|
+
class ProgressTimeseries
|
193
|
+
include ::Google::Protobuf::MessageExts
|
194
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
195
|
+
|
196
|
+
# A point in the timeseries.
|
197
|
+
# @!attribute [rw] time
|
198
|
+
# @return [::Google::Protobuf::Timestamp]
|
199
|
+
# The timestamp of the point.
|
200
|
+
# @!attribute [rw] value
|
201
|
+
# @return [::Float]
|
202
|
+
# The value of the point.
|
203
|
+
class Point
|
204
|
+
include ::Google::Protobuf::MessageExts
|
205
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
206
|
+
end
|
207
|
+
end
|
208
|
+
|
209
|
+
# Information about a particular execution stage of a job.
|
210
|
+
# @!attribute [rw] stage_id
|
211
|
+
# @return [::String]
|
212
|
+
# ID of this stage
|
213
|
+
# @!attribute [rw] state
|
214
|
+
# @return [::Google::Cloud::Dataflow::V1beta3::ExecutionState]
|
215
|
+
# State of this stage.
|
216
|
+
# @!attribute [rw] start_time
|
217
|
+
# @return [::Google::Protobuf::Timestamp]
|
218
|
+
# Start time of this stage.
|
219
|
+
# @!attribute [rw] end_time
|
220
|
+
# @return [::Google::Protobuf::Timestamp]
|
221
|
+
# End time of this stage.
|
222
|
+
#
|
223
|
+
# If the work item is completed, this is the actual end time of the stage.
|
224
|
+
# Otherwise, it is the predicted end time.
|
225
|
+
# @!attribute [rw] progress
|
226
|
+
# @return [::Google::Cloud::Dataflow::V1beta3::ProgressTimeseries]
|
227
|
+
# Progress for this stage.
|
228
|
+
# Only applicable to Batch jobs.
|
229
|
+
# @!attribute [rw] metrics
|
230
|
+
# @return [::Array<::Google::Cloud::Dataflow::V1beta3::MetricUpdate>]
|
231
|
+
# Metrics for this stage.
|
232
|
+
class StageSummary
|
233
|
+
include ::Google::Protobuf::MessageExts
|
234
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
235
|
+
end
|
236
|
+
|
237
|
+
# Information about the execution of a job.
|
238
|
+
# @!attribute [rw] stages
|
239
|
+
# @return [::Array<::Google::Cloud::Dataflow::V1beta3::StageSummary>]
|
240
|
+
# The stages of the job execution.
|
241
|
+
# @!attribute [rw] next_page_token
|
242
|
+
# @return [::String]
|
243
|
+
# If present, this response does not contain all requested tasks. To obtain
|
244
|
+
# the next page of results, repeat the request with page_token set to this
|
245
|
+
# value.
|
246
|
+
class JobExecutionDetails
|
247
|
+
include ::Google::Protobuf::MessageExts
|
248
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
249
|
+
end
|
250
|
+
|
251
|
+
# Request to get information about a particular execution stage of a job.
|
252
|
+
# Currently only tracked for Batch jobs.
|
253
|
+
# @!attribute [rw] project_id
|
254
|
+
# @return [::String]
|
255
|
+
# A project id.
|
256
|
+
# @!attribute [rw] job_id
|
257
|
+
# @return [::String]
|
258
|
+
# The job to get execution details for.
|
259
|
+
# @!attribute [rw] location
|
260
|
+
# @return [::String]
|
261
|
+
# The [regional endpoint]
|
262
|
+
# (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
|
263
|
+
# contains the job specified by job_id.
|
264
|
+
# @!attribute [rw] stage_id
|
265
|
+
# @return [::String]
|
266
|
+
# The stage for which to fetch information.
|
267
|
+
# @!attribute [rw] page_size
|
268
|
+
# @return [::Integer]
|
269
|
+
# If specified, determines the maximum number of work items to
|
270
|
+
# return. If unspecified, the service may choose an appropriate
|
271
|
+
# default, or may return an arbitrarily large number of results.
|
272
|
+
# @!attribute [rw] page_token
|
273
|
+
# @return [::String]
|
274
|
+
# If supplied, this should be the value of next_page_token returned
|
275
|
+
# by an earlier call. This will cause the next page of results to
|
276
|
+
# be returned.
|
277
|
+
# @!attribute [rw] start_time
|
278
|
+
# @return [::Google::Protobuf::Timestamp]
|
279
|
+
# Lower time bound of work items to include, by start time.
|
280
|
+
# @!attribute [rw] end_time
|
281
|
+
# @return [::Google::Protobuf::Timestamp]
|
282
|
+
# Upper time bound of work items to include, by start time.
|
283
|
+
class GetStageExecutionDetailsRequest
|
284
|
+
include ::Google::Protobuf::MessageExts
|
285
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
286
|
+
end
|
287
|
+
|
288
|
+
# Information about an individual work item execution.
|
289
|
+
# @!attribute [rw] task_id
|
290
|
+
# @return [::String]
|
291
|
+
# Name of this work item.
|
292
|
+
# @!attribute [rw] attempt_id
|
293
|
+
# @return [::String]
|
294
|
+
# Attempt ID of this work item
|
295
|
+
# @!attribute [rw] start_time
|
296
|
+
# @return [::Google::Protobuf::Timestamp]
|
297
|
+
# Start time of this work item attempt.
|
298
|
+
# @!attribute [rw] end_time
|
299
|
+
# @return [::Google::Protobuf::Timestamp]
|
300
|
+
# End time of this work item attempt.
|
301
|
+
#
|
302
|
+
# If the work item is completed, this is the actual end time of the work
|
303
|
+
# item. Otherwise, it is the predicted end time.
|
304
|
+
# @!attribute [rw] state
|
305
|
+
# @return [::Google::Cloud::Dataflow::V1beta3::ExecutionState]
|
306
|
+
# State of this work item.
|
307
|
+
# @!attribute [rw] progress
|
308
|
+
# @return [::Google::Cloud::Dataflow::V1beta3::ProgressTimeseries]
|
309
|
+
# Progress of this work item.
|
310
|
+
# @!attribute [rw] metrics
|
311
|
+
# @return [::Array<::Google::Cloud::Dataflow::V1beta3::MetricUpdate>]
|
312
|
+
# Metrics for this work item.
|
313
|
+
class WorkItemDetails
|
314
|
+
include ::Google::Protobuf::MessageExts
|
315
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
316
|
+
end
|
317
|
+
|
318
|
+
# Information about a worker
|
319
|
+
# @!attribute [rw] worker_name
|
320
|
+
# @return [::String]
|
321
|
+
# Name of this worker
|
322
|
+
# @!attribute [rw] work_items
|
323
|
+
# @return [::Array<::Google::Cloud::Dataflow::V1beta3::WorkItemDetails>]
|
324
|
+
# Work items processed by this worker, sorted by time.
|
325
|
+
class WorkerDetails
|
326
|
+
include ::Google::Protobuf::MessageExts
|
327
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
328
|
+
end
|
329
|
+
|
330
|
+
# Information about the workers and work items within a stage.
|
331
|
+
# @!attribute [rw] workers
|
332
|
+
# @return [::Array<::Google::Cloud::Dataflow::V1beta3::WorkerDetails>]
|
333
|
+
# Workers that have done work on the stage.
|
334
|
+
# @!attribute [rw] next_page_token
|
335
|
+
# @return [::String]
|
336
|
+
# If present, this response does not contain all requested tasks. To obtain
|
337
|
+
# the next page of results, repeat the request with page_token set to this
|
338
|
+
# value.
|
339
|
+
class StageExecutionDetails
|
340
|
+
include ::Google::Protobuf::MessageExts
|
341
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
342
|
+
end
|
343
|
+
|
344
|
+
# The state of some component of job execution.
|
345
|
+
module ExecutionState
|
346
|
+
# The component state is unknown or unspecified.
|
347
|
+
EXECUTION_STATE_UNKNOWN = 0
|
348
|
+
|
349
|
+
# The component is not yet running.
|
350
|
+
EXECUTION_STATE_NOT_STARTED = 1
|
351
|
+
|
352
|
+
# The component is currently running.
|
353
|
+
EXECUTION_STATE_RUNNING = 2
|
354
|
+
|
355
|
+
# The component succeeded.
|
356
|
+
EXECUTION_STATE_SUCCEEDED = 3
|
357
|
+
|
358
|
+
# The component failed.
|
359
|
+
EXECUTION_STATE_FAILED = 4
|
360
|
+
|
361
|
+
# Execution of the component was cancelled.
|
362
|
+
EXECUTION_STATE_CANCELLED = 5
|
363
|
+
end
|
364
|
+
end
|
365
|
+
end
|
366
|
+
end
|
367
|
+
end
|