google-cloud-dataproc-v1 0.6.1 → 0.7.1

data/lib/google/cloud/dataproc/v1/workflow_template_service/client.rb

@@ -42,13 +42,12 @@ module Google
             # See {::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all WorkflowTemplateService clients:
-            #
-            #     ::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all WorkflowTemplateService clients
+            #   ::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -68,58 +67,37 @@ module Google
 
                 default_config.rpcs.create_workflow_template.timeout = 600.0
                 default_config.rpcs.create_workflow_template.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
                 }
 
                 default_config.rpcs.get_workflow_template.timeout = 600.0
                 default_config.rpcs.get_workflow_template.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 13, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 13, 14]
                 }
 
                 default_config.rpcs.instantiate_workflow_template.timeout = 600.0
                 default_config.rpcs.instantiate_workflow_template.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
                 }
 
                 default_config.rpcs.instantiate_inline_workflow_template.timeout = 600.0
                 default_config.rpcs.instantiate_inline_workflow_template.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
                 }
 
                 default_config.rpcs.update_workflow_template.timeout = 600.0
                 default_config.rpcs.update_workflow_template.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
                 }
 
                 default_config.rpcs.list_workflow_templates.timeout = 600.0
                 default_config.rpcs.list_workflow_templates.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 13, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 13, 14]
                 }
 
                 default_config.rpcs.delete_workflow_template.timeout = 600.0
                 default_config.rpcs.delete_workflow_template.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
                 }
 
                 default_config
@@ -151,19 +129,15 @@ module Google
             ##
             # Create a new WorkflowTemplateService client object.
             #
-            # ## Examples
-            #
-            # To create a new WorkflowTemplateService client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client.new
             #
-            # To create a new WorkflowTemplateService client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the WorkflowTemplateService client.
             # @yieldparam config [Client::Configuration]
@@ -183,14 +157,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
@@ -259,6 +232,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dataproc/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dataproc::V1::CreateWorkflowTemplateRequest.new
+            #
+            #   # Call the create_workflow_template method.
+            #   result = client.create_workflow_template request
+            #
+            #   # The returned object is of type Google::Cloud::Dataproc::V1::WorkflowTemplate.
+            #   p result
+            #
             def create_workflow_template request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -276,16 +264,20 @@ module Google
                 gapic_version: ::Google::Cloud::Dataproc::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.create_workflow_template.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_workflow_template.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @workflow_template_service_stub.call_rpc :create_workflow_template, request, options: options do |response, operation|
@@ -342,6 +334,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dataproc/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dataproc::V1::GetWorkflowTemplateRequest.new
+            #
+            #   # Call the get_workflow_template method.
+            #   result = client.get_workflow_template request
+            #
+            #   # The returned object is of type Google::Cloud::Dataproc::V1::WorkflowTemplate.
+            #   p result
+            #
             def get_workflow_template request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -359,16 +366,20 @@ module Google
                 gapic_version: ::Google::Cloud::Dataproc::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.get_workflow_template.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_workflow_template.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @workflow_template_service_stub.call_rpc :get_workflow_template, request, options: options do |response, operation|
@@ -456,6 +467,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dataproc/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dataproc::V1::InstantiateWorkflowTemplateRequest.new
+            #
+            #   # Call the instantiate_workflow_template method.
+            #   result = client.instantiate_workflow_template request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def instantiate_workflow_template request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -473,16 +506,20 @@ module Google
                 gapic_version: ::Google::Cloud::Dataproc::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.instantiate_workflow_template.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.instantiate_workflow_template.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @workflow_template_service_stub.call_rpc :instantiate_workflow_template, request, options: options do |response, operation|
@@ -498,8 +535,7 @@ module Google
             # Instantiates a template and begins execution.
             #
             # This method is equivalent to executing the sequence
-            # {::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client#create_workflow_template CreateWorkflowTemplate},
-            # {::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client#instantiate_workflow_template InstantiateWorkflowTemplate},
+            # {::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client#create_workflow_template CreateWorkflowTemplate}, {::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client#instantiate_workflow_template InstantiateWorkflowTemplate},
             # {::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client#delete_workflow_template DeleteWorkflowTemplate}.
             #
             # The returned Operation can be used to track execution of
@@ -568,6 +604,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dataproc/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dataproc::V1::InstantiateInlineWorkflowTemplateRequest.new
+            #
+            #   # Call the instantiate_inline_workflow_template method.
+            #   result = client.instantiate_inline_workflow_template request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def instantiate_inline_workflow_template request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -585,16 +643,20 @@ module Google
                 gapic_version: ::Google::Cloud::Dataproc::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.instantiate_inline_workflow_template.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.instantiate_inline_workflow_template.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @workflow_template_service_stub.call_rpc :instantiate_inline_workflow_template, request, options: options do |response, operation|
@@ -638,6 +700,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dataproc/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dataproc::V1::UpdateWorkflowTemplateRequest.new
+            #
+            #   # Call the update_workflow_template method.
+            #   result = client.update_workflow_template request
+            #
+            #   # The returned object is of type Google::Cloud::Dataproc::V1::WorkflowTemplate.
+            #   p result
+            #
             def update_workflow_template request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -655,16 +732,20 @@ module Google
                 gapic_version: ::Google::Cloud::Dataproc::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "template.name" => request.template.name
-              }
+              header_params = {}
+              if request.template&.name
+                header_params["template.name"] = request.template.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.update_workflow_template.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.update_workflow_template.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @workflow_template_service_stub.call_rpc :update_workflow_template, request, options: options do |response, operation|
@@ -718,6 +799,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dataproc/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dataproc::V1::ListWorkflowTemplatesRequest.new
+            #
+            #   # Call the list_workflow_templates method.
+            #   result = client.list_workflow_templates 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::Dataproc::V1::WorkflowTemplate.
+            #     p response
+            #   end
+            #
             def list_workflow_templates request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -735,16 +837,20 @@ module Google
                 gapic_version: ::Google::Cloud::Dataproc::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.list_workflow_templates.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_workflow_templates.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @workflow_template_service_stub.call_rpc :list_workflow_templates, request, options: options do |response, operation|
@@ -798,6 +904,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dataproc/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dataproc::V1::DeleteWorkflowTemplateRequest.new
+            #
+            #   # Call the delete_workflow_template method.
+            #   result = client.delete_workflow_template request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def delete_workflow_template request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -815,16 +936,20 @@ module Google
                 gapic_version: ::Google::Cloud::Dataproc::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.delete_workflow_template.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_workflow_template.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @workflow_template_service_stub.call_rpc :delete_workflow_template, request, options: options do |response, operation|
@@ -848,22 +973,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 create_workflow_template
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.create_workflow_template.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.create_workflow_template.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # create_workflow_template to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.create_workflow_template.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.create_workflow_template.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.