google-cloud-dataflow-v1beta3 0.1.0 → 0.1.4

data/lib/google/cloud/dataflow/v1beta3/messages/client.rb

@@ -40,13 +40,12 @@ module Google
             # See {::Google::Cloud::Dataflow::V1beta3::Messages::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all Messages clients:
-            #
-            #     ::Google::Cloud::Dataflow::V1beta3::Messages::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all Messages clients
+            #   ::Google::Cloud::Dataflow::V1beta3::Messages::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -95,19 +94,15 @@ module Google
             ##
             # Create a new Messages client object.
             #
-            # ## Examples
-            #
-            # To create a new Messages client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::Dataflow::V1beta3::Messages::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Dataflow::V1beta3::Messages::Client.new
             #
-            # To create a new Messages client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Dataflow::V1beta3::Messages::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Dataflow::V1beta3::Messages::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Messages client.
             # @yieldparam config [Client::Configuration]
@@ -127,14 +122,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -208,6 +202,27 @@ module Google
             #
             # @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::Messages::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dataflow::V1beta3::ListJobMessagesRequest.new
+            #
+            #   # Call the list_job_messages method.
+            #   result = client.list_job_messages 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::JobMessage.
+            #     p response
+            #   end
+            #
             def list_job_messages request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -228,7 +243,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.list_job_messages.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_job_messages.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @messages_stub.call_rpc :list_job_messages, request, options: options do |response, operation|
@@ -253,22 +270,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for list_job_messages
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Dataflow::V1beta3::Messages::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_job_messages.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Dataflow::V1beta3::Messages::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_job_messages.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # list_job_messages to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Dataflow::V1beta3::Messages::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_job_messages.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Dataflow::V1beta3::Messages::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_job_messages.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

data/lib/google/cloud/dataflow/v1beta3/metrics/client.rb

@@ -40,13 +40,12 @@ module Google
             # See {::Google::Cloud::Dataflow::V1beta3::Metrics::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all Metrics clients:
-            #
-            #     ::Google::Cloud::Dataflow::V1beta3::Metrics::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all Metrics clients
+            #   ::Google::Cloud::Dataflow::V1beta3::Metrics::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -95,19 +94,15 @@ module Google
             ##
             # Create a new Metrics client object.
             #
-            # ## Examples
-            #
-            # To create a new Metrics client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::Dataflow::V1beta3::Metrics::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Dataflow::V1beta3::Metrics::Client.new
             #
-            # To create a new Metrics client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Dataflow::V1beta3::Metrics::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Dataflow::V1beta3::Metrics::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Metrics client.
             # @yieldparam config [Client::Configuration]
@@ -127,14 +122,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -195,6 +189,21 @@ module Google
             #
             # @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?
 
@@ -215,7 +224,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.get_job_metrics.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_job_metrics.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @metrics_stub.call_rpc :get_job_metrics, request, options: options do |response, operation|
@@ -271,6 +282,27 @@ module Google
             #
             # @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?
 
@@ -291,7 +323,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.get_job_execution_details.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_job_execution_details.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @metrics_stub.call_rpc :get_job_execution_details, request, options: options do |response, operation|
@@ -355,6 +389,27 @@ module Google
             #
             # @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?
 
@@ -375,7 +430,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.get_stage_execution_details.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_stage_execution_details.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @metrics_stub.call_rpc :get_stage_execution_details, request, options: options do |response, operation|
@@ -400,22 +457,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for get_job_metrics
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Dataflow::V1beta3::Metrics::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.get_job_metrics.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Dataflow::V1beta3::Metrics::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.get_job_metrics.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # get_job_metrics to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Dataflow::V1beta3::Metrics::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.get_job_metrics.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Dataflow::V1beta3::Metrics::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.get_job_metrics.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

data/lib/google/cloud/dataflow/v1beta3/snapshots/client.rb

@@ -39,13 +39,12 @@ module Google
             # See {::Google::Cloud::Dataflow::V1beta3::Snapshots::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all Snapshots clients:
-            #
-            #     ::Google::Cloud::Dataflow::V1beta3::Snapshots::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all Snapshots clients
+            #   ::Google::Cloud::Dataflow::V1beta3::Snapshots::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -94,19 +93,15 @@ module Google
             ##
             # Create a new Snapshots client object.
             #
-            # ## Examples
-            #
-            # To create a new Snapshots client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::Dataflow::V1beta3::Snapshots::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Dataflow::V1beta3::Snapshots::Client.new
             #
-            # To create a new Snapshots client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Dataflow::V1beta3::Snapshots::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Dataflow::V1beta3::Snapshots::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Snapshots client.
             # @yieldparam config [Client::Configuration]
@@ -126,14 +121,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -183,6 +177,21 @@ module Google
             #
             # @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::Snapshots::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dataflow::V1beta3::GetSnapshotRequest.new
+            #
+            #   # Call the get_snapshot method.
+            #   result = client.get_snapshot request
+            #
+            #   # The returned object is of type Google::Cloud::Dataflow::V1beta3::Snapshot.
+            #   p result
+            #
             def get_snapshot request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -203,7 +212,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.get_snapshot.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_snapshot.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @snapshots_stub.call_rpc :get_snapshot, request, options: options do |response, operation|
@@ -247,6 +258,21 @@ module Google
             #
             # @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::Snapshots::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dataflow::V1beta3::DeleteSnapshotRequest.new
+            #
+            #   # Call the delete_snapshot method.
+            #   result = client.delete_snapshot request
+            #
+            #   # The returned object is of type Google::Cloud::Dataflow::V1beta3::DeleteSnapshotResponse.
+            #   p result
+            #
             def delete_snapshot request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -267,7 +293,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.delete_snapshot.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_snapshot.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @snapshots_stub.call_rpc :delete_snapshot, request, options: options do |response, operation|
@@ -311,6 +339,21 @@ module Google
             #
             # @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::Snapshots::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dataflow::V1beta3::ListSnapshotsRequest.new
+            #
+            #   # Call the list_snapshots method.
+            #   result = client.list_snapshots request
+            #
+            #   # The returned object is of type Google::Cloud::Dataflow::V1beta3::ListSnapshotsResponse.
+            #   p result
+            #
             def list_snapshots request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -331,7 +374,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.list_snapshots.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_snapshots.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @snapshots_stub.call_rpc :list_snapshots, request, options: options do |response, operation|
@@ -355,22 +400,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for get_snapshot
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Dataflow::V1beta3::Snapshots::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.get_snapshot.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Dataflow::V1beta3::Snapshots::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.get_snapshot.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # get_snapshot to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Dataflow::V1beta3::Snapshots::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.get_snapshot.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Dataflow::V1beta3::Snapshots::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.get_snapshot.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.