client.rb in google-cloud-dataflow-v1beta3-0.1.3

- old
+ new

@@ -187,10 +187,25 @@
             #
             # @return [::Google::Cloud::Dataflow::V1beta3::JobMetrics]
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dataflow/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dataflow::V1beta3::Metrics::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dataflow::V1beta3::GetJobMetricsRequest.new
+            #
+            #   # Call the get_job_metrics method.
+            #   result = client.get_job_metrics request
+            #
+            #   # The returned object is of type Google::Cloud::Dataflow::V1beta3::JobMetrics.
+            #   p result
+            #
             def get_job_metrics request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
               request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataflow::V1beta3::GetJobMetricsRequest
 
@@ -265,10 +280,31 @@
             #
             # @return [::Gapic::PagedEnumerable<::Google::Cloud::Dataflow::V1beta3::StageSummary>]
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dataflow/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dataflow::V1beta3::Metrics::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dataflow::V1beta3::GetJobExecutionDetailsRequest.new
+            #
+            #   # Call the get_job_execution_details method.
+            #   result = client.get_job_execution_details request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::Dataflow::V1beta3::StageSummary.
+            #     p response
+            #   end
+            #
             def get_job_execution_details request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
               request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataflow::V1beta3::GetJobExecutionDetailsRequest
 
@@ -350,9 +386,30 @@
             # @yieldparam operation [::GRPC::ActiveCall::Operation]
             #
             # @return [::Gapic::PagedEnumerable<::Google::Cloud::Dataflow::V1beta3::WorkerDetails>]
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/dataflow/v1beta3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dataflow::V1beta3::Metrics::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dataflow::V1beta3::GetStageExecutionDetailsRequest.new
+            #
+            #   # Call the get_stage_execution_details method.
+            #   result = client.get_stage_execution_details request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::Dataflow::V1beta3::WorkerDetails.
+            #     p response
+            #   end
             #
             def get_stage_execution_details request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
               request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataflow::V1beta3::GetStageExecutionDetailsRequest