google-cloud-dataproc-v1 0.19.0 → 0.21.0

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

@@ -237,6 +237,22 @@ module Google
               # @return [::Google::Cloud::Dataproc::V1::WorkflowTemplate]
               #
               # @raise [::Google::Cloud::Error] if the REST call 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::Rest::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?
 
@@ -316,6 +332,22 @@ module Google
               # @return [::Google::Cloud::Dataproc::V1::WorkflowTemplate]
               #
               # @raise [::Google::Cloud::Error] if the REST call 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::Rest::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?
 
@@ -426,6 +458,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call 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::Rest::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 it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "No response received."
+              #   end
+              #
               def instantiate_workflow_template request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -534,6 +589,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call 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::Rest::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 it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "No response received."
+              #   end
+              #
               def instantiate_inline_workflow_template request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -600,6 +678,22 @@ module Google
               # @return [::Google::Cloud::Dataproc::V1::WorkflowTemplate]
               #
               # @raise [::Google::Cloud::Error] if the REST call 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::Rest::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?
 
@@ -676,6 +770,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataproc::V1::WorkflowTemplate>]
               #
               # @raise [::Google::Cloud::Error] if the REST call 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::Rest::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 elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
+              #     # Each element is of type ::Google::Cloud::Dataproc::V1::WorkflowTemplate.
+              #     p item
+              #   end
+              #
               def list_workflow_templates request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -752,6 +866,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call 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::Rest::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?
 

data/lib/google/cloud/dataproc/v1/workflow_template_service/rest/operations.rb

@@ -136,6 +136,26 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/longrunning"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Longrunning::Operations::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Longrunning::ListOperationsRequest.new
+              #
+              #   # Call the list_operations method.
+              #   result = client.list_operations request
+              #
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
+              #     # Each element is of type ::Google::Longrunning::Operation.
+              #     p item
+              #   end
+              #
               def list_operations request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -201,6 +221,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/longrunning"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Longrunning::Operations::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Longrunning::GetOperationRequest.new
+              #
+              #   # Call the get_operation method.
+              #   result = client.get_operation request
+              #
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "No response received."
+              #   end
+              #
               def get_operation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -267,6 +310,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/longrunning"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Longrunning::Operations::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Longrunning::DeleteOperationRequest.new
+              #
+              #   # Call the delete_operation method.
+              #   result = client.delete_operation request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def delete_operation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -338,6 +397,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/longrunning"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Longrunning::Operations::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Longrunning::CancelOperationRequest.new
+              #
+              #   # Call the cancel_operation method.
+              #   result = client.cancel_operation request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def cancel_operation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 

data/proto_docs/google/cloud/dataproc/v1/clusters.rb

@@ -541,22 +541,20 @@ module Google
         #     Platform](https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
         # @!attribute [rw] min_num_instances
         #   @return [::Integer]
-        #     Optional. The minimum number of instances to create.
-        #     If min_num_instances is set, min_num_instances is used for a criteria to
-        #     decide the cluster. Cluster creation will be failed by being an error state
-        #     if the total number of instances created is less than the
-        #     min_num_instances.
-        #     For example, given that num_instances = 5 and min_num_instances = 3,
-        #     * if 4 instances are created and then registered successfully but one
-        #     instance is failed, the failed VM will be deleted and the cluster will be
-        #     resized to 4 instances in running state.
-        #     * if 2 instances are created successfully and 3 instances are failed,
-        #     the cluster will be in an error state and does not delete failed VMs for
-        #     debugging.
-        #     * if 2 instance are created and then registered successfully but 3
-        #     instances are failed to initialize, the cluster will be in an error state
-        #     and does not delete failed VMs for debugging.
-        #     NB: This can only be set for primary workers now.
+        #     Optional. The minimum number of primary worker instances to create.
+        #     If `min_num_instances` is set, cluster creation will succeed if
+        #     the number of primary workers created is at least equal to the
+        #     `min_num_instances` number.
+        #
+        #     Example: Cluster creation request with `num_instances` = `5` and
+        #     `min_num_instances` = `3`:
+        #
+        #     *  If 4 VMs are created and 1 instance fails,
+        #        the failed VM is deleted. The cluster is
+        #        resized to 4 instances and placed in a `RUNNING` state.
+        #     *  If 2 instances are created and 3 instances fail,
+        #        the cluster in placed in an `ERROR` state. The failed VMs
+        #        are not deleted.
         # @!attribute [rw] instance_flexibility_policy
         #   @return [::Google::Cloud::Dataproc::V1::InstanceFlexibilityPolicy]
         #     Optional. Instance flexibility Policy allowing a mixture of VM shapes and
@@ -790,12 +788,12 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
-          # Node group roles.
+          # Node pool roles.
           module Role
             # Required unspecified role.
             ROLE_UNSPECIFIED = 0
 
-            # Job drivers run on the node group.
+            # Job drivers run on the node pool.
             DRIVER = 1
           end
         end
@@ -1524,6 +1522,23 @@ module Google
         # @!attribute [rw] cluster_name
         #   @return [::String]
         #     Required. The cluster name.
+        # @!attribute [rw] tarball_gcs_dir
+        #   @return [::String]
+        #     Optional. The output Cloud Storage directory for the diagnostic
+        #     tarball. If not specified, a task-specific directory in the cluster's
+        #     staging bucket will be used.
+        # @!attribute [rw] diagnosis_interval
+        #   @return [::Google::Type::Interval]
+        #     Optional. Time interval in which diagnosis should be carried out on the
+        #     cluster.
+        # @!attribute [rw] jobs
+        #   @return [::Array<::String>]
+        #     Optional. Specifies a list of jobs on which diagnosis is to be performed.
+        #     Format: projects/\\{project}/regions/\\{region}/jobs/\\{job}
+        # @!attribute [rw] yarn_application_ids
+        #   @return [::Array<::String>]
+        #     Optional. Specifies a list of yarn applications on which diagnosis is to be
+        #     performed.
         class DiagnoseClusterRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/protobuf/wrappers.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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 Protobuf
+    # Wrapper message for `double`.
+    #
+    # The JSON representation for `DoubleValue` is JSON number.
+    # @!attribute [rw] value
+    #   @return [::Float]
+    #     The double value.
+    class DoubleValue
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Wrapper message for `float`.
+    #
+    # The JSON representation for `FloatValue` is JSON number.
+    # @!attribute [rw] value
+    #   @return [::Float]
+    #     The float value.
+    class FloatValue
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Wrapper message for `int64`.
+    #
+    # The JSON representation for `Int64Value` is JSON string.
+    # @!attribute [rw] value
+    #   @return [::Integer]
+    #     The int64 value.
+    class Int64Value
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Wrapper message for `uint64`.
+    #
+    # The JSON representation for `UInt64Value` is JSON string.
+    # @!attribute [rw] value
+    #   @return [::Integer]
+    #     The uint64 value.
+    class UInt64Value
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Wrapper message for `int32`.
+    #
+    # The JSON representation for `Int32Value` is JSON number.
+    # @!attribute [rw] value
+    #   @return [::Integer]
+    #     The int32 value.
+    class Int32Value
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Wrapper message for `uint32`.
+    #
+    # The JSON representation for `UInt32Value` is JSON number.
+    # @!attribute [rw] value
+    #   @return [::Integer]
+    #     The uint32 value.
+    class UInt32Value
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Wrapper message for `bool`.
+    #
+    # The JSON representation for `BoolValue` is JSON `true` and `false`.
+    # @!attribute [rw] value
+    #   @return [::Boolean]
+    #     The bool value.
+    class BoolValue
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Wrapper message for `string`.
+    #
+    # The JSON representation for `StringValue` is JSON string.
+    # @!attribute [rw] value
+    #   @return [::String]
+    #     The string value.
+    class StringValue
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Wrapper message for `bytes`.
+    #
+    # The JSON representation for `BytesValue` is JSON string.
+    # @!attribute [rw] value
+    #   @return [::String]
+    #     The bytes value.
+    class BytesValue
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/type/interval.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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 Type
+    # Represents a time interval, encoded as a Timestamp start (inclusive) and a
+    # Timestamp end (exclusive).
+    #
+    # The start must be less than or equal to the end.
+    # When the start equals the end, the interval is empty (matches no time).
+    # When both start and end are unspecified, the interval matches any time.
+    # @!attribute [rw] start_time
+    #   @return [::Google::Protobuf::Timestamp]
+    #     Optional. Inclusive start of the interval.
+    #
+    #     If specified, a Timestamp matching this interval will have to be the same
+    #     or after the start.
+    # @!attribute [rw] end_time
+    #   @return [::Google::Protobuf::Timestamp]
+    #     Optional. Exclusive end of the interval.
+    #
+    #     If specified, a Timestamp matching this interval will have to be before the
+    #     end.
+    class Interval
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-dataproc-v1
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-04 00:00:00.000000000 Z
+date: 2023-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -278,8 +278,10 @@ files:
 - proto_docs/google/protobuf/empty.rb
 - proto_docs/google/protobuf/field_mask.rb
 - proto_docs/google/protobuf/timestamp.rb
+- proto_docs/google/protobuf/wrappers.rb
 - proto_docs/google/rpc/status.rb
 - proto_docs/google/type/expr.rb
+- proto_docs/google/type/interval.rb
 homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0