google-cloud-dataproc-v1 0.23.1 → 0.24.0

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

@@ -0,0 +1,295 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 Dataproc
+      module V1
+        # A request to create a session.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource where this session will be created.
+        # @!attribute [rw] session
+        #   @return [::Google::Cloud::Dataproc::V1::Session]
+        #     Required. The interactive session to create.
+        # @!attribute [rw] session_id
+        #   @return [::String]
+        #     Required. The ID to use for the session, which becomes the final component
+        #     of the session's resource name.
+        #
+        #     This value must be 4-63 characters. Valid characters
+        #     are /[a-z][0-9]-/.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. A unique ID used to identify the request. If the service
+        #     receives two
+        #     [CreateSessionRequests](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateSessionRequest)s
+        #     with the same ID, the second request is ignored, and the
+        #     first {::Google::Cloud::Dataproc::V1::Session Session} is created and stored in
+        #     the backend.
+        #
+        #     Recommendation: Set this value to a
+        #     [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
+        #
+        #     The value must contain only letters (a-z, A-Z), numbers (0-9),
+        #     underscores (_), and hyphens (-). The maximum length is 40 characters.
+        class CreateSessionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request to get the resource representation for a session.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the session to retrieve.
+        class GetSessionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request to list sessions in a project.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent, which owns this collection of sessions.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of sessions to return in each response.
+        #     The service may return fewer than this value.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token received from a previous `ListSessions` call.
+        #     Provide this token to retrieve the subsequent page.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. A filter for the sessions to return in the response.
+        #
+        #     A filter is a logical expression constraining the values of various fields
+        #     in each session resource. Filters are case sensitive, and may contain
+        #     multiple clauses combined with logical operators (AND, OR).
+        #     Supported fields are `session_id`, `session_uuid`, `state`, and
+        #     `create_time`.
+        #
+        #     Example: `state = ACTIVE and create_time < "2023-01-01T00:00:00Z"`
+        #     is a filter for sessions in an ACTIVE state that were created before
+        #     2023-01-01.
+        #
+        #     See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed
+        #     description of the filter syntax and a list of supported comparators.
+        class ListSessionsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A list of interactive sessions.
+        # @!attribute [r] sessions
+        #   @return [::Array<::Google::Cloud::Dataproc::V1::Session>]
+        #     Output only. The sessions from the specified collection.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token, which can be sent as `page_token`, to retrieve the next page.
+        #     If this field is omitted, there are no subsequent pages.
+        class ListSessionsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request to terminate an interactive session.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the session resource to terminate.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. A unique ID used to identify the request. If the service
+        #     receives two
+        #     [TerminateSessionRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.TerminateSessionRequest)s
+        #     with the same ID, the second request is ignored.
+        #
+        #     Recommendation: Set this value to a
+        #     [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
+        #
+        #     The value must contain only letters (a-z, A-Z), numbers (0-9),
+        #     underscores (_), and hyphens (-). The maximum length is 40 characters.
+        class TerminateSessionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request to delete a session.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the session resource to delete.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. A unique ID used to identify the request. If the service
+        #     receives two
+        #     [DeleteSessionRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.DeleteSessionRequest)s
+        #     with the same ID, the second request is ignored.
+        #
+        #     Recommendation: Set this value to a
+        #     [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
+        #
+        #     The value must contain only letters (a-z, A-Z), numbers (0-9),
+        #     underscores (_), and hyphens (-). The maximum length is 40 characters.
+        class DeleteSessionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A representation of a session.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the session.
+        # @!attribute [r] uuid
+        #   @return [::String]
+        #     Output only. A session UUID (Unique Universal Identifier). The service
+        #     generates this value when it creates the session.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when the session was created.
+        # @!attribute [rw] jupyter_session
+        #   @return [::Google::Cloud::Dataproc::V1::JupyterConfig]
+        #     Optional. Jupyter session config.
+        # @!attribute [r] runtime_info
+        #   @return [::Google::Cloud::Dataproc::V1::RuntimeInfo]
+        #     Output only. Runtime information about session execution.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::Dataproc::V1::Session::State]
+        #     Output only. A state of the session.
+        # @!attribute [r] state_message
+        #   @return [::String]
+        #     Output only. Session state details, such as the failure
+        #     description if the state is `FAILED`.
+        # @!attribute [r] state_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when the session entered the current state.
+        # @!attribute [r] creator
+        #   @return [::String]
+        #     Output only. The email address of the user who created the session.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. The labels to associate with the session.
+        #     Label **keys** must contain 1 to 63 characters, and must conform to
+        #     [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
+        #     Label **values** may be empty, but, if present, must contain 1 to 63
+        #     characters, and must conform to [RFC
+        #     1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
+        #     associated with a session.
+        # @!attribute [rw] runtime_config
+        #   @return [::Google::Cloud::Dataproc::V1::RuntimeConfig]
+        #     Optional. Runtime configuration for the session execution.
+        # @!attribute [rw] environment_config
+        #   @return [::Google::Cloud::Dataproc::V1::EnvironmentConfig]
+        #     Optional. Environment configuration for the session execution.
+        # @!attribute [rw] user
+        #   @return [::String]
+        #     Optional. The email address of the user who owns the session.
+        # @!attribute [r] state_history
+        #   @return [::Array<::Google::Cloud::Dataproc::V1::Session::SessionStateHistory>]
+        #     Output only. Historical state information for the session.
+        # @!attribute [rw] session_template
+        #   @return [::String]
+        #     Optional. The session template used by the session.
+        #
+        #     Only resource names, including project ID and location, are valid.
+        #
+        #     Example:
+        #     * `https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]`
+        #     * `projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]`
+        #
+        #     The template must be in the same project and Dataproc region as the
+        #     session.
+        class Session
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Historical state information.
+          # @!attribute [r] state
+          #   @return [::Google::Cloud::Dataproc::V1::Session::State]
+          #     Output only. The state of the session at this point in the session
+          #     history.
+          # @!attribute [r] state_message
+          #   @return [::String]
+          #     Output only. Details about the state at this point in the session
+          #     history.
+          # @!attribute [r] state_start_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. The time when the session entered the historical state.
+          class SessionStateHistory
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The session state.
+          module State
+            # The session state is unknown.
+            STATE_UNSPECIFIED = 0
+
+            # The session is created prior to running.
+            CREATING = 1
+
+            # The session is running.
+            ACTIVE = 2
+
+            # The session is terminating.
+            TERMINATING = 3
+
+            # The session is terminated successfully.
+            TERMINATED = 4
+
+            # The session is no longer running due to an error.
+            FAILED = 5
+          end
+        end
+
+        # Jupyter configuration for an interactive session.
+        # @!attribute [rw] kernel
+        #   @return [::Google::Cloud::Dataproc::V1::JupyterConfig::Kernel]
+        #     Optional. Kernel
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Optional. Display name, shown in the Jupyter kernelspec card.
+        class JupyterConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Jupyter kernel types.
+          module Kernel
+            # The kernel is unknown.
+            KERNEL_UNSPECIFIED = 0
+
+            # Python kernel.
+            PYTHON = 1
+
+            # Scala kernel.
+            SCALA = 2
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -33,6 +33,9 @@ module Google
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     Optional. A mapping of property names to values, which are used to
         #     configure workload execution.
+        # @!attribute [rw] repository_config
+        #   @return [::Google::Cloud::Dataproc::V1::RepositoryConfig]
+        #     Optional. Dependency repository configuration.
         class RuntimeConfig
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -75,18 +78,34 @@ module Google
         # @!attribute [rw] kms_key
         #   @return [::String]
         #     Optional. The Cloud KMS key to use for encryption.
-        # @!attribute [rw] ttl
+        # @!attribute [rw] idle_ttl
         #   @return [::Google::Protobuf::Duration]
-        #     Optional. The duration after which the workload will be terminated.
-        #     When the workload passes this ttl, it will be unconditionally killed
-        #     without waiting for ongoing work to finish.
-        #     Minimum value is 10 minutes; maximum value is 14 days (see JSON
-        #     representation of
+        #     Optional. Applies to sessions only. The duration to keep the session alive
+        #     while it's idling. Exceeding this threshold causes the session to
+        #     terminate. This field cannot be set on a batch workload. Minimum value is
+        #     10 minutes; maximum value is 14 days (see JSON representation of
         #     [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json)).
-        #     If both ttl and idle_ttl are specified, the conditions are treated as
-        #     and OR: the workload will be terminated when it has been idle for idle_ttl
-        #     or when the ttl has passed, whichever comes first.
-        #     If ttl is not specified for a session, it defaults to 24h.
+        #     Defaults to 1 hour if not set.
+        #     If both `ttl` and `idle_ttl` are specified for an interactive session,
+        #     the conditions are treated as `OR` conditions: the workload will be
+        #     terminated when it has been idle for `idle_ttl` or when `ttl` has been
+        #     exceeded, whichever occurs first.
+        # @!attribute [rw] ttl
+        #   @return [::Google::Protobuf::Duration]
+        #     Optional. The duration after which the workload will be terminated,
+        #     specified as the JSON representation for
+        #     [Duration](https://protobuf.dev/programming-guides/proto3/#json).
+        #     When the workload exceeds this duration, it will be unconditionally
+        #     terminated without waiting for ongoing work to finish. If `ttl` is not
+        #     specified for a batch workload, the workload will be allowed to run until
+        #     it exits naturally (or run forever without exiting). If `ttl` is not
+        #     specified for an interactive session, it defaults to 24 hours. If `ttl` is
+        #     not specified for a batch that uses 2.1+ runtime version, it defaults to 4
+        #     hours. Minimum value is 10 minutes; maximum value is 14 days. If both `ttl`
+        #     and `idle_ttl` are specified (for an interactive session), the conditions
+        #     are treated as `OR` conditions: the workload will be terminated when it has
+        #     been idle for `idle_ttl` or when `ttl` has been exceeded, whichever occurs
+        #     first.
         # @!attribute [rw] staging_bucket
         #   @return [::String]
         #     Optional. A Cloud Storage bucket used to stage workload dependencies,
@@ -146,9 +165,17 @@ module Google
         #     Output only. A URI pointing to the location of the diagnostics tarball.
         # @!attribute [r] approximate_usage
         #   @return [::Google::Cloud::Dataproc::V1::UsageMetrics]
-        #     Output only. Approximate workload resource usage calculated after workload
-        #     finishes (see [Dataproc Serverless pricing]
+        #     Output only. Approximate workload resource usage, calculated when
+        #     the workload completes (see [Dataproc Serverless pricing]
         #     (https://cloud.google.com/dataproc-serverless/pricing)).
+        #
+        #     **Note:** This metric calculation may change in the future, for
+        #     example, to capture cumulative workload resource
+        #     consumption during workload execution (see the
+        #     [Dataproc Serverless release notes]
+        #     (https://cloud.google.com/dataproc-serverless/docs/release-notes)
+        #     for announcements, changes, fixes
+        #     and other Dataproc developments).
         # @!attribute [r] current_usage
         #   @return [::Google::Cloud::Dataproc::V1::UsageSnapshot]
         #     Output only. Snapshot of current workload resource usage.
@@ -177,12 +204,20 @@ module Google
         #     Optional. Shuffle storage usage in (`GB` x `seconds`) (see
         #     [Dataproc Serverless pricing]
         #     (https://cloud.google.com/dataproc-serverless/pricing)).
+        # @!attribute [rw] milli_accelerator_seconds
+        #   @return [::Integer]
+        #     Optional. Accelerator usage in (`milliAccelerator` x `seconds`) (see
+        #     [Dataproc Serverless pricing]
+        #     (https://cloud.google.com/dataproc-serverless/pricing)).
+        # @!attribute [rw] accelerator_type
+        #   @return [::String]
+        #     Optional. Accelerator type being used, if any
         class UsageMetrics
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The usage snaphot represents the resources consumed by a workload at a
+        # The usage snapshot represents the resources consumed by a workload at a
         # specified time.
         # @!attribute [rw] milli_dcu
         #   @return [::Integer]
@@ -193,6 +228,23 @@ module Google
         #   @return [::Integer]
         #     Optional. Shuffle Storage in gigabytes (GB). (see [Dataproc Serverless
         #     pricing] (https://cloud.google.com/dataproc-serverless/pricing))
+        # @!attribute [rw] milli_dcu_premium
+        #   @return [::Integer]
+        #     Optional. Milli (one-thousandth) Dataproc Compute Units (DCUs) charged at
+        #     premium tier (see [Dataproc Serverless pricing]
+        #     (https://cloud.google.com/dataproc-serverless/pricing)).
+        # @!attribute [rw] shuffle_storage_gb_premium
+        #   @return [::Integer]
+        #     Optional. Shuffle Storage in gigabytes (GB) charged at premium tier. (see
+        #     [Dataproc Serverless pricing]
+        #     (https://cloud.google.com/dataproc-serverless/pricing))
+        # @!attribute [rw] milli_accelerator
+        #   @return [::Integer]
+        #     Optional. Milli (one-thousandth) accelerator. (see [Dataproc
+        #     Serverless pricing] (https://cloud.google.com/dataproc-serverless/pricing))
+        # @!attribute [rw] accelerator_type
+        #   @return [::String]
+        #     Optional. Accelerator type being used, if any
         # @!attribute [rw] snapshot_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Optional. The timestamp of the usage snapshot.
@@ -456,16 +508,33 @@ module Google
           end
         end
 
+        # Configuration for dependency repositories
+        # @!attribute [rw] pypi_repository_config
+        #   @return [::Google::Cloud::Dataproc::V1::PyPiRepositoryConfig]
+        #     Optional. Configuration for PyPi repository.
+        class RepositoryConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Configuration for PyPi repository
+        # @!attribute [rw] pypi_repository
+        #   @return [::String]
+        #     Optional. PyPi repository address
+        class PyPiRepositoryConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Cluster components that can be activated.
         module Component
           # Unspecified component. Specifying this will cause Cluster creation to fail.
           COMPONENT_UNSPECIFIED = 0
 
           # The Anaconda python distribution. The Anaconda component is not supported
-          # in the Dataproc
-          # <a
-          # href="/dataproc/docs/concepts/versioning/dataproc-release-2.0">2.0
-          # image</a>. The 2.0 image is pre-installed with Miniconda.
+          # in the Dataproc [2.0 image]
+          # (/https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-release-2.0).
+          # The 2.0 image is pre-installed with Miniconda.
           ANACONDA = 5
 
           # Docker

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-dataproc-v1
 version: !ruby/object:Gem::Version
-  version: 0.23.1
+  version: 0.24.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-12 00:00:00.000000000 Z
+date: 2024-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -246,6 +246,26 @@ files:
 - lib/google/cloud/dataproc/v1/node_groups_services_pb.rb
 - lib/google/cloud/dataproc/v1/operations_pb.rb
 - lib/google/cloud/dataproc/v1/rest.rb
+- lib/google/cloud/dataproc/v1/session_controller.rb
+- lib/google/cloud/dataproc/v1/session_controller/client.rb
+- lib/google/cloud/dataproc/v1/session_controller/credentials.rb
+- lib/google/cloud/dataproc/v1/session_controller/operations.rb
+- lib/google/cloud/dataproc/v1/session_controller/paths.rb
+- lib/google/cloud/dataproc/v1/session_controller/rest.rb
+- lib/google/cloud/dataproc/v1/session_controller/rest/client.rb
+- lib/google/cloud/dataproc/v1/session_controller/rest/operations.rb
+- lib/google/cloud/dataproc/v1/session_controller/rest/service_stub.rb
+- lib/google/cloud/dataproc/v1/session_template_controller.rb
+- lib/google/cloud/dataproc/v1/session_template_controller/client.rb
+- lib/google/cloud/dataproc/v1/session_template_controller/credentials.rb
+- lib/google/cloud/dataproc/v1/session_template_controller/paths.rb
+- lib/google/cloud/dataproc/v1/session_template_controller/rest.rb
+- lib/google/cloud/dataproc/v1/session_template_controller/rest/client.rb
+- lib/google/cloud/dataproc/v1/session_template_controller/rest/service_stub.rb
+- lib/google/cloud/dataproc/v1/session_templates_pb.rb
+- lib/google/cloud/dataproc/v1/session_templates_services_pb.rb
+- lib/google/cloud/dataproc/v1/sessions_pb.rb
+- lib/google/cloud/dataproc/v1/sessions_services_pb.rb
 - lib/google/cloud/dataproc/v1/shared_pb.rb
 - lib/google/cloud/dataproc/v1/version.rb
 - lib/google/cloud/dataproc/v1/workflow_template_service.rb
@@ -270,6 +290,8 @@ files:
 - proto_docs/google/cloud/dataproc/v1/jobs.rb
 - proto_docs/google/cloud/dataproc/v1/node_groups.rb
 - proto_docs/google/cloud/dataproc/v1/operations.rb
+- proto_docs/google/cloud/dataproc/v1/session_templates.rb
+- proto_docs/google/cloud/dataproc/v1/sessions.rb
 - proto_docs/google/cloud/dataproc/v1/shared.rb
 - proto_docs/google/cloud/dataproc/v1/workflow_templates.rb
 - proto_docs/google/longrunning/operations.rb