google-cloud-dataflow-v1beta3 0.1.0

data/proto_docs/google/dataflow/v1beta3/messages.rb

@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Dataflow
+      module V1beta3
+        # A particular message pertaining to a Dataflow job.
+        # @!attribute [rw] id
+        #   @return [::String]
+        #     Deprecated.
+        # @!attribute [rw] time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The timestamp of the message.
+        # @!attribute [rw] message_text
+        #   @return [::String]
+        #     The text of the message.
+        # @!attribute [rw] message_importance
+        #   @return [::Google::Cloud::Dataflow::V1beta3::JobMessageImportance]
+        #     Importance level of the message.
+        class JobMessage
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A rich message format, including a human readable string, a key for
+        # identifying the message, and structured data associated with the message for
+        # programmatic consumption.
+        # @!attribute [rw] message_text
+        #   @return [::String]
+        #     Human-readable version of message.
+        # @!attribute [rw] message_key
+        #   @return [::String]
+        #     Identifier for this message type.  Used by external systems to
+        #     internationalize or personalize message.
+        # @!attribute [rw] parameters
+        #   @return [::Array<::Google::Cloud::Dataflow::V1beta3::StructuredMessage::Parameter>]
+        #     The structured data associated with this message.
+        class StructuredMessage
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Structured data associated with this message.
+          # @!attribute [rw] key
+          #   @return [::String]
+          #     Key or name for this parameter.
+          # @!attribute [rw] value
+          #   @return [::Google::Protobuf::Value]
+          #     Value for this parameter.
+          class Parameter
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # A structured message reporting an autoscaling decision made by the Dataflow
+        # service.
+        # @!attribute [rw] current_num_workers
+        #   @return [::Integer]
+        #     The current number of workers the job has.
+        # @!attribute [rw] target_num_workers
+        #   @return [::Integer]
+        #     The target number of workers the worker pool wants to resize to use.
+        # @!attribute [rw] event_type
+        #   @return [::Google::Cloud::Dataflow::V1beta3::AutoscalingEvent::AutoscalingEventType]
+        #     The type of autoscaling event to report.
+        # @!attribute [rw] description
+        #   @return [::Google::Cloud::Dataflow::V1beta3::StructuredMessage]
+        #     A message describing why the system decided to adjust the current
+        #     number of workers, why it failed, or why the system decided to
+        #     not make any changes to the number of workers.
+        # @!attribute [rw] time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time this event was emitted to indicate a new target or current
+        #     num_workers value.
+        # @!attribute [rw] worker_pool
+        #   @return [::String]
+        #     A short and friendly name for the worker pool this event refers to,
+        #     populated from the value of PoolStageRelation::user_pool_name.
+        class AutoscalingEvent
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Indicates the type of autoscaling event.
+          module AutoscalingEventType
+            # Default type for the enum.  Value should never be returned.
+            TYPE_UNKNOWN = 0
+
+            # The TARGET_NUM_WORKERS_CHANGED type should be used when the target
+            # worker pool size has changed at the start of an actuation. An event
+            # should always be specified as TARGET_NUM_WORKERS_CHANGED if it reflects
+            # a change in the target_num_workers.
+            TARGET_NUM_WORKERS_CHANGED = 1
+
+            # The CURRENT_NUM_WORKERS_CHANGED type should be used when actual worker
+            # pool size has been changed, but the target_num_workers has not changed.
+            CURRENT_NUM_WORKERS_CHANGED = 2
+
+            # The ACTUATION_FAILURE type should be used when we want to report
+            # an error to the user indicating why the current number of workers
+            # in the pool could not be changed.
+            # Displayed in the current status and history widgets.
+            ACTUATION_FAILURE = 3
+
+            # Used when we want to report to the user a reason why we are
+            # not currently adjusting the number of workers.
+            # Should specify both target_num_workers, current_num_workers and a
+            # decision_message.
+            NO_CHANGE = 4
+          end
+        end
+
+        # Request to list job messages.
+        # Up to max_results messages will be returned in the time range specified
+        # starting with the oldest messages first. If no time range is specified
+        # the results with start with the oldest message.
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     A project id.
+        # @!attribute [rw] job_id
+        #   @return [::String]
+        #     The job to get messages about.
+        # @!attribute [rw] minimum_importance
+        #   @return [::Google::Cloud::Dataflow::V1beta3::JobMessageImportance]
+        #     Filter to only get messages with importance >= level
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     If specified, determines the maximum number of messages to
+        #     return.  If unspecified, the service may choose an appropriate
+        #     default, or may return an arbitrarily large number of results.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     If supplied, this should be the value of next_page_token returned
+        #     by an earlier call. This will cause the next page of results to
+        #     be returned.
+        # @!attribute [rw] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     If specified, return only messages with timestamps >= start_time.
+        #     The default is the job creation time (i.e. beginning of messages).
+        # @!attribute [rw] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Return only messages with timestamps < end_time. The default is now
+        #     (i.e. return up to the latest messages available).
+        # @!attribute [rw] location
+        #   @return [::String]
+        #     The [regional endpoint]
+        #     (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
+        #     contains the job specified by job_id.
+        class ListJobMessagesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response to a request to list job messages.
+        # @!attribute [rw] job_messages
+        #   @return [::Array<::Google::Cloud::Dataflow::V1beta3::JobMessage>]
+        #     Messages in ascending timestamp order.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     The token to obtain the next page of results if there are more.
+        # @!attribute [rw] autoscaling_events
+        #   @return [::Array<::Google::Cloud::Dataflow::V1beta3::AutoscalingEvent>]
+        #     Autoscaling events in ascending timestamp order.
+        class ListJobMessagesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Indicates the importance of the message.
+        module JobMessageImportance
+          # The message importance isn't specified, or is unknown.
+          JOB_MESSAGE_IMPORTANCE_UNKNOWN = 0
+
+          # The message is at the 'debug' level: typically only useful for
+          # software engineers working on the code the job is running.
+          # Typically, Dataflow pipeline runners do not display log messages
+          # at this level by default.
+          JOB_MESSAGE_DEBUG = 1
+
+          # The message is at the 'detailed' level: somewhat verbose, but
+          # potentially useful to users.  Typically, Dataflow pipeline
+          # runners do not display log messages at this level by default.
+          # These messages are displayed by default in the Dataflow
+          # monitoring UI.
+          JOB_MESSAGE_DETAILED = 2
+
+          # The message is at the 'basic' level: useful for keeping
+          # track of the execution of a Dataflow pipeline.  Typically,
+          # Dataflow pipeline runners display log messages at this level by
+          # default, and these messages are displayed by default in the
+          # Dataflow monitoring UI.
+          JOB_MESSAGE_BASIC = 5
+
+          # The message is at the 'warning' level: indicating a condition
+          # pertaining to a job which may require human intervention.
+          # Typically, Dataflow pipeline runners display log messages at this
+          # level by default, and these messages are displayed by default in
+          # the Dataflow monitoring UI.
+          JOB_MESSAGE_WARNING = 3
+
+          # The message is at the 'error' level: indicating a condition
+          # preventing a job from succeeding.  Typically, Dataflow pipeline
+          # runners display log messages at this level by default, and these
+          # messages are displayed by default in the Dataflow monitoring UI.
+          JOB_MESSAGE_ERROR = 4
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/dataflow/v1beta3/metrics.rb

@@ -0,0 +1,367 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Dataflow
+      module V1beta3
+        # Identifies a metric, by describing the source which generated the
+        # metric.
+        # @!attribute [rw] origin
+        #   @return [::String]
+        #     Origin (namespace) of metric name. May be blank for user-define metrics;
+        #     will be "dataflow" for metrics defined by the Dataflow service or SDK.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Worker-defined metric name.
+        # @!attribute [rw] context
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Zero or more labeled fields which identify the part of the job this
+        #     metric is associated with, such as the name of a step or collection.
+        #
+        #     For example, built-in counters associated with steps will have
+        #     context['step'] = <step-name>. Counters associated with PCollections
+        #     in the SDK will have context['pcollection'] = <pcollection-name>.
+        class MetricStructuredName
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class ContextEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Describes the state of a metric.
+        # @!attribute [rw] name
+        #   @return [::Google::Cloud::Dataflow::V1beta3::MetricStructuredName]
+        #     Name of the metric.
+        # @!attribute [rw] kind
+        #   @return [::String]
+        #     Metric aggregation kind.  The possible metric aggregation kinds are
+        #     "Sum", "Max", "Min", "Mean", "Set", "And", "Or", and "Distribution".
+        #     The specified aggregation kind is case-insensitive.
+        #
+        #     If omitted, this is not an aggregated value but instead
+        #     a single metric sample value.
+        # @!attribute [rw] cumulative
+        #   @return [::Boolean]
+        #     True if this metric is reported as the total cumulative aggregate
+        #     value accumulated since the worker started working on this WorkItem.
+        #     By default this is false, indicating that this metric is reported
+        #     as a delta that is not associated with any WorkItem.
+        # @!attribute [rw] scalar
+        #   @return [::Google::Protobuf::Value]
+        #     Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min",
+        #     "And", and "Or".  The possible value types are Long, Double, and Boolean.
+        # @!attribute [rw] mean_sum
+        #   @return [::Google::Protobuf::Value]
+        #     Worker-computed aggregate value for the "Mean" aggregation kind.
+        #     This holds the sum of the aggregated values and is used in combination
+        #     with mean_count below to obtain the actual mean aggregate value.
+        #     The only possible value types are Long and Double.
+        # @!attribute [rw] mean_count
+        #   @return [::Google::Protobuf::Value]
+        #     Worker-computed aggregate value for the "Mean" aggregation kind.
+        #     This holds the count of the aggregated values and is used in combination
+        #     with mean_sum above to obtain the actual mean aggregate value.
+        #     The only possible value type is Long.
+        # @!attribute [rw] set
+        #   @return [::Google::Protobuf::Value]
+        #     Worker-computed aggregate value for the "Set" aggregation kind.  The only
+        #     possible value type is a list of Values whose type can be Long, Double,
+        #     or String, according to the metric's type.  All Values in the list must
+        #     be of the same type.
+        # @!attribute [rw] distribution
+        #   @return [::Google::Protobuf::Value]
+        #     A struct value describing properties of a distribution of numeric values.
+        # @!attribute [rw] gauge
+        #   @return [::Google::Protobuf::Value]
+        #     A struct value describing properties of a Gauge.
+        #     Metrics of gauge type show the value of a metric across time, and is
+        #     aggregated based on the newest value.
+        # @!attribute [rw] internal
+        #   @return [::Google::Protobuf::Value]
+        #     Worker-computed aggregate value for internal use by the Dataflow
+        #     service.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Timestamp associated with the metric value. Optional when workers are
+        #     reporting work progress; it will be filled in responses from the
+        #     metrics API.
+        class MetricUpdate
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request to get job metrics.
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     A project id.
+        # @!attribute [rw] job_id
+        #   @return [::String]
+        #     The job to get metrics for.
+        # @!attribute [rw] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Return only metric data that has changed since this time.
+        #     Default is to return all information about all metrics for the job.
+        # @!attribute [rw] location
+        #   @return [::String]
+        #     The [regional endpoint]
+        #     (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
+        #     contains the job specified by job_id.
+        class GetJobMetricsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # JobMetrics contains a collection of metrics describing the detailed progress
+        # of a Dataflow job. Metrics correspond to user-defined and system-defined
+        # metrics in the job.
+        #
+        # This resource captures only the most recent values of each metric;
+        # time-series data can be queried for them (under the same metric names)
+        # from Cloud Monitoring.
+        # @!attribute [rw] metric_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Timestamp as of which metric values are current.
+        # @!attribute [rw] metrics
+        #   @return [::Array<::Google::Cloud::Dataflow::V1beta3::MetricUpdate>]
+        #     All metrics for this job.
+        class JobMetrics
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request to get job execution details.
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     A project id.
+        # @!attribute [rw] job_id
+        #   @return [::String]
+        #     The job to get execution details for.
+        # @!attribute [rw] location
+        #   @return [::String]
+        #     The [regional endpoint]
+        #     (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
+        #     contains the job specified by job_id.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     If specified, determines the maximum number of stages to
+        #     return.  If unspecified, the service may choose an appropriate
+        #     default, or may return an arbitrarily large number of results.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     If supplied, this should be the value of next_page_token returned
+        #     by an earlier call. This will cause the next page of results to
+        #     be returned.
+        class GetJobExecutionDetailsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Information about the progress of some component of job execution.
+        # @!attribute [rw] current_progress
+        #   @return [::Float]
+        #     The current progress of the component, in the range [0,1].
+        # @!attribute [rw] data_points
+        #   @return [::Array<::Google::Cloud::Dataflow::V1beta3::ProgressTimeseries::Point>]
+        #     History of progress for the component.
+        #
+        #     Points are sorted by time.
+        class ProgressTimeseries
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # A point in the timeseries.
+          # @!attribute [rw] time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The timestamp of the point.
+          # @!attribute [rw] value
+          #   @return [::Float]
+          #     The value of the point.
+          class Point
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Information about a particular execution stage of a job.
+        # @!attribute [rw] stage_id
+        #   @return [::String]
+        #     ID of this stage
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::Dataflow::V1beta3::ExecutionState]
+        #     State of this stage.
+        # @!attribute [rw] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Start time of this stage.
+        # @!attribute [rw] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     End time of this stage.
+        #
+        #     If the work item is completed, this is the actual end time of the stage.
+        #     Otherwise, it is the predicted end time.
+        # @!attribute [rw] progress
+        #   @return [::Google::Cloud::Dataflow::V1beta3::ProgressTimeseries]
+        #     Progress for this stage.
+        #     Only applicable to Batch jobs.
+        # @!attribute [rw] metrics
+        #   @return [::Array<::Google::Cloud::Dataflow::V1beta3::MetricUpdate>]
+        #     Metrics for this stage.
+        class StageSummary
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Information about the execution of a job.
+        # @!attribute [rw] stages
+        #   @return [::Array<::Google::Cloud::Dataflow::V1beta3::StageSummary>]
+        #     The stages of the job execution.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     If present, this response does not contain all requested tasks.  To obtain
+        #     the next page of results, repeat the request with page_token set to this
+        #     value.
+        class JobExecutionDetails
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request to get information about a particular execution stage of a job.
+        # Currently only tracked for Batch jobs.
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     A project id.
+        # @!attribute [rw] job_id
+        #   @return [::String]
+        #     The job to get execution details for.
+        # @!attribute [rw] location
+        #   @return [::String]
+        #     The [regional endpoint]
+        #     (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
+        #     contains the job specified by job_id.
+        # @!attribute [rw] stage_id
+        #   @return [::String]
+        #     The stage for which to fetch information.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     If specified, determines the maximum number of work items to
+        #     return.  If unspecified, the service may choose an appropriate
+        #     default, or may return an arbitrarily large number of results.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     If supplied, this should be the value of next_page_token returned
+        #     by an earlier call. This will cause the next page of results to
+        #     be returned.
+        # @!attribute [rw] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Lower time bound of work items to include, by start time.
+        # @!attribute [rw] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Upper time bound of work items to include, by start time.
+        class GetStageExecutionDetailsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Information about an individual work item execution.
+        # @!attribute [rw] task_id
+        #   @return [::String]
+        #     Name of this work item.
+        # @!attribute [rw] attempt_id
+        #   @return [::String]
+        #     Attempt ID of this work item
+        # @!attribute [rw] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Start time of this work item attempt.
+        # @!attribute [rw] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     End time of this work item attempt.
+        #
+        #     If the work item is completed, this is the actual end time of the work
+        #     item.  Otherwise, it is the predicted end time.
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::Dataflow::V1beta3::ExecutionState]
+        #     State of this work item.
+        # @!attribute [rw] progress
+        #   @return [::Google::Cloud::Dataflow::V1beta3::ProgressTimeseries]
+        #     Progress of this work item.
+        # @!attribute [rw] metrics
+        #   @return [::Array<::Google::Cloud::Dataflow::V1beta3::MetricUpdate>]
+        #     Metrics for this work item.
+        class WorkItemDetails
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Information about a worker
+        # @!attribute [rw] worker_name
+        #   @return [::String]
+        #     Name of this worker
+        # @!attribute [rw] work_items
+        #   @return [::Array<::Google::Cloud::Dataflow::V1beta3::WorkItemDetails>]
+        #     Work items processed by this worker, sorted by time.
+        class WorkerDetails
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Information about the workers and work items within a stage.
+        # @!attribute [rw] workers
+        #   @return [::Array<::Google::Cloud::Dataflow::V1beta3::WorkerDetails>]
+        #     Workers that have done work on the stage.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     If present, this response does not contain all requested tasks.  To obtain
+        #     the next page of results, repeat the request with page_token set to this
+        #     value.
+        class StageExecutionDetails
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The state of some component of job execution.
+        module ExecutionState
+          # The component state is unknown or unspecified.
+          EXECUTION_STATE_UNKNOWN = 0
+
+          # The component is not yet running.
+          EXECUTION_STATE_NOT_STARTED = 1
+
+          # The component is currently running.
+          EXECUTION_STATE_RUNNING = 2
+
+          # The component succeeded.
+          EXECUTION_STATE_SUCCEEDED = 3
+
+          # The component failed.
+          EXECUTION_STATE_FAILED = 4
+
+          # Execution of the component was cancelled.
+          EXECUTION_STATE_CANCELLED = 5
+        end
+      end
+    end
+  end
+end