google-cloud-batch-v1 0.1.0

data/proto_docs/google/cloud/batch/v1/task.rb

@@ -0,0 +1,329 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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 Batch
+      module V1
+        # Compute resource requirements
+        # @!attribute [rw] cpu_milli
+        #   @return [::Integer]
+        #     The milliCPU count.
+        # @!attribute [rw] memory_mib
+        #   @return [::Integer]
+        #     Memory in MiB.
+        # @!attribute [rw] boot_disk_mib
+        #   @return [::Integer]
+        #     Extra boot disk size in MiB for each task.
+        class ComputeResource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Status event
+        # @!attribute [rw] type
+        #   @return [::String]
+        #     Type of the event.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Description of the event.
+        # @!attribute [rw] event_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time this event occurred.
+        # @!attribute [rw] task_execution
+        #   @return [::Google::Cloud::Batch::V1::TaskExecution]
+        #     Task Execution
+        class StatusEvent
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # This Task Execution field includes detail information for
+        # task execution procedures, based on StatusEvent types.
+        # @!attribute [rw] exit_code
+        #   @return [::Integer]
+        #     When task is completed as the status of FAILED or SUCCEEDED,
+        #     exit code is for one task execution result, default is 0 as success.
+        class TaskExecution
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Status of a task
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::Batch::V1::TaskStatus::State]
+        #     Task state
+        # @!attribute [rw] status_events
+        #   @return [::Array<::Google::Cloud::Batch::V1::StatusEvent>]
+        #     Detailed info about why the state is reached.
+        class TaskStatus
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Task states.
+          module State
+            # unknown state
+            STATE_UNSPECIFIED = 0
+
+            # The Task is created and waiting for resources.
+            PENDING = 1
+
+            # The Task is assigned to at least one VM.
+            ASSIGNED = 2
+
+            # The Task is running.
+            RUNNING = 3
+
+            # The Task has failed.
+            FAILED = 4
+
+            # The Task has succeeded.
+            SUCCEEDED = 5
+          end
+        end
+
+        # Runnable describes instructions for executing a specific script or container
+        # as part of a Task.
+        # @!attribute [rw] container
+        #   @return [::Google::Cloud::Batch::V1::Runnable::Container]
+        #     Container runnable.
+        # @!attribute [rw] script
+        #   @return [::Google::Cloud::Batch::V1::Runnable::Script]
+        #     Script runnable.
+        # @!attribute [rw] barrier
+        #   @return [::Google::Cloud::Batch::V1::Runnable::Barrier]
+        #     Barrier runnable.
+        # @!attribute [rw] ignore_exit_status
+        #   @return [::Boolean]
+        #     Normally, a non-zero exit status causes the Task to fail. This flag allows
+        #     execution of other Runnables to continue instead.
+        # @!attribute [rw] background
+        #   @return [::Boolean]
+        #     This flag allows a Runnable to continue running in the background while the
+        #     Task executes subsequent Runnables. This is useful to provide services to
+        #     other Runnables (or to provide debugging support tools like SSH servers).
+        # @!attribute [rw] always_run
+        #   @return [::Boolean]
+        #     By default, after a Runnable fails, no further Runnable are executed. This
+        #     flag indicates that this Runnable must be run even if the Task has already
+        #     failed. This is useful for Runnables that copy output files off of the VM
+        #     or for debugging.
+        #
+        #     The always_run flag does not override the Task's overall max_run_duration.
+        #     If the max_run_duration has expired then no further Runnables will execute,
+        #     not even always_run Runnables.
+        class Runnable
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Container runnable.
+          # @!attribute [rw] image_uri
+          #   @return [::String]
+          #     The URI to pull the container image from.
+          # @!attribute [rw] commands
+          #   @return [::Array<::String>]
+          #     Overrides the `CMD` specified in the container. If there is an ENTRYPOINT
+          #     (either in the container image or with the entrypoint field below) then
+          #     commands are appended as arguments to the ENTRYPOINT.
+          # @!attribute [rw] entrypoint
+          #   @return [::String]
+          #     Overrides the `ENTRYPOINT` specified in the container.
+          # @!attribute [rw] volumes
+          #   @return [::Array<::String>]
+          #     Volumes to mount (bind mount) from the host machine files or directories
+          #     into the container, formatted to match docker run's --volume option,
+          #     e.g. /foo:/bar, or /foo:/bar:ro
+          # @!attribute [rw] options
+          #   @return [::String]
+          #     Arbitrary additional options to include in the "docker run" command when
+          #     running this container, e.g. "--network host".
+          # @!attribute [rw] block_external_network
+          #   @return [::Boolean]
+          #     If set to true, external network access to and from container will be
+          #     blocked. The container will use the default internal network
+          #     'goog-internal'.
+          # @!attribute [rw] username
+          #   @return [::String]
+          #     Optional username for logging in to a docker registry. If username
+          #     matches "projects/*/secrets/*/versions/*" then Batch will read the
+          #     username from the Secret Manager.
+          # @!attribute [rw] password
+          #   @return [::String]
+          #     Optional password for logging in to a docker registry. If password
+          #     matches "projects/*/secrets/*/versions/*" then Batch will read the
+          #     password from the Secret Manager;
+          class Container
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Script runnable.
+          # @!attribute [rw] path
+          #   @return [::String]
+          #     Script file path on the host VM.
+          # @!attribute [rw] text
+          #   @return [::String]
+          #     Shell script text.
+          class Script
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Barrier runnable blocks until all tasks in a taskgroup reach it.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Barriers are identified by their index in runnable list.
+          #     Names are not required, but if present should be an identifier.
+          class Barrier
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Spec of a task
+        # @!attribute [rw] runnables
+        #   @return [::Array<::Google::Cloud::Batch::V1::Runnable>]
+        #     The sequence of scripts or containers to run for this Task. Each Task using
+        #     this TaskSpec executes its list of runnables in order. The Task succeeds if
+        #     all of its runnables either exit with a zero status or any that exit with a
+        #     non-zero status have the ignore_exit_status flag.
+        #
+        #     Background runnables are killed automatically (if they have not already
+        #     exited) a short time after all foreground runnables have completed. Even
+        #     though this is likely to result in a non-zero exit status for the
+        #     background runnable, these automatic kills are not treated as Task
+        #     failures.
+        # @!attribute [rw] compute_resource
+        #   @return [::Google::Cloud::Batch::V1::ComputeResource]
+        #     ComputeResource requirements.
+        # @!attribute [rw] max_run_duration
+        #   @return [::Google::Protobuf::Duration]
+        #     Maximum duration the task should run.
+        #     The task will be killed and marked as FAILED if over this limit.
+        # @!attribute [rw] max_retry_count
+        #   @return [::Integer]
+        #     Maximum number of retries on failures.
+        #     The default, 0, which means never retry.
+        #     The valid value range is [0, 10].
+        # @!attribute [rw] lifecycle_policies
+        #   @return [::Array<::Google::Cloud::Batch::V1::LifecyclePolicy>]
+        #     Lifecycle management schema when any task in a task group is failed.
+        #     The valid size of lifecycle policies are [0, 10].
+        #     For each lifecycle policy, when the condition is met,
+        #     the action in that policy will execute.
+        #     If there are multiple policies that the task execution result matches,
+        #     we use the action from the first matched policy. If task execution result
+        #     does not meet with any of the defined lifecycle policy, we consider it as
+        #     the default policy. Default policy means if the exit code is 0, exit task.
+        #     If task ends with non-zero exit code, retry the task with max_retry_count.
+        # @!attribute [rw] environments
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Environment variables to set before running the Task.
+        #     You can set up to 100 environments.
+        # @!attribute [rw] volumes
+        #   @return [::Array<::Google::Cloud::Batch::V1::Volume>]
+        #     Volumes to mount before running Tasks using this TaskSpec.
+        class TaskSpec
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class EnvironmentsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # LifecyclePolicy describes how to deal with task failures
+        # based on different conditions.
+        # @!attribute [rw] action
+        #   @return [::Google::Cloud::Batch::V1::LifecyclePolicy::Action]
+        #     Action to execute when ActionCondition is true.
+        # @!attribute [rw] action_condition
+        #   @return [::Google::Cloud::Batch::V1::LifecyclePolicy::ActionCondition]
+        #     Conditions that decide why a task failure is dealt with a specific action.
+        class LifecyclePolicy
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Conditions for actions to deal with task failures.
+          # @!attribute [rw] exit_codes
+          #   @return [::Array<::Integer>]
+          #     Exit codes of a task execution.
+          #     If there are more than 1 exit codes,
+          #     when task executes with any of the exit code in the list,
+          #     the condition is met and the action will be executed.
+          class ActionCondition
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Action on task failures based on different conditions.
+          module Action
+            # Action unspecified.
+            ACTION_UNSPECIFIED = 0
+
+            # Action that tasks in the group will be scheduled to re-execute.
+            RETRY_TASK = 1
+
+            # Action that tasks in the group will be stopped immediately.
+            FAIL_TASK = 2
+          end
+        end
+
+        # A Cloud Batch task.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Task name.
+        #     The name is generated from the parent TaskGroup name and 'id' field.
+        #     For example:
+        #     "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01/tasks/task01".
+        # @!attribute [rw] status
+        #   @return [::Google::Cloud::Batch::V1::TaskStatus]
+        #     Task Status.
+        class Task
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # An Environment describes a collection of environment variables to set when
+        # executing Tasks.
+        # @!attribute [rw] variables
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     A map of environment variable names to values.
+        class Environment
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class VariablesEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/batch/v1/volume.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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 Batch
+      module V1
+        # Volume and mount parameters to be associated with a TaskSpec. A TaskSpec
+        # might describe zero, one, or multiple volumes to be mounted as part of the
+        # task.
+        # @!attribute [rw] nfs
+        #   @return [::Google::Cloud::Batch::V1::NFS]
+        #     An NFS source for the volume (could be a Filestore, for example).
+        # @!attribute [rw] gcs
+        #   @return [::Google::Cloud::Batch::V1::GCS]
+        #     A Google Cloud Storage source for the volume.
+        # @!attribute [rw] device_name
+        #   @return [::String]
+        #     Device name of an attached disk
+        # @!attribute [rw] mount_path
+        #   @return [::String]
+        #     Mount path for the volume, e.g. /mnt/share
+        # @!attribute [rw] mount_options
+        #   @return [::Array<::String>]
+        #     Mount options
+        #     For Google Cloud Storage, mount options are the global options supported by
+        #     gcsfuse tool. Batch will use them to mount the volume with the following
+        #     command:
+        #     "gcsfuse [global options] bucket mountpoint".
+        #     For PD, NFS, mount options are these supported by /etc/fstab. Batch will
+        #     use Fstab to mount such volumes.
+        #     https://help.ubuntu.com/community/Fstab
+        class Volume
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Represents an NFS server and remote path: <server>:<remote_path>
+        # @!attribute [rw] server
+        #   @return [::String]
+        #     URI of the NFS server, e.g. an IP address.
+        # @!attribute [rw] remote_path
+        #   @return [::String]
+        #     Remote source path exported from NFS, e.g., "/share".
+        class NFS
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Represents a Google Cloud Storage volume source config.
+        # @!attribute [rw] remote_path
+        #   @return [::String]
+        #     Remote path, either a bucket name or a subdirectory of a bucket, e.g.:
+        #     bucket_name, bucket_name/subdirectory/
+        class GCS
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/longrunning/operations.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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 Longrunning
+    # This resource represents a long-running operation that is the result of a
+    # network API call.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The server-assigned name, which is only unique within the same service that
+    #     originally returns it. If you use the default HTTP mapping, the
+    #     `name` should be a resource name ending with `operations/{unique_id}`.
+    # @!attribute [rw] metadata
+    #   @return [::Google::Protobuf::Any]
+    #     Service-specific metadata associated with the operation.  It typically
+    #     contains progress information and common metadata such as create time.
+    #     Some services might not provide such metadata.  Any method that returns a
+    #     long-running operation should document the metadata type, if any.
+    # @!attribute [rw] done
+    #   @return [::Boolean]
+    #     If the value is `false`, it means the operation is still in progress.
+    #     If `true`, the operation is completed, and either `error` or `response` is
+    #     available.
+    # @!attribute [rw] error
+    #   @return [::Google::Rpc::Status]
+    #     The error result of the operation in case of failure or cancellation.
+    # @!attribute [rw] response
+    #   @return [::Google::Protobuf::Any]
+    #     The normal response of the operation in case of success.  If the original
+    #     method returns no data on success, such as `Delete`, the response is
+    #     `google.protobuf.Empty`.  If the original method is standard
+    #     `Get`/`Create`/`Update`, the response should be the resource.  For other
+    #     methods, the response should have the type `XxxResponse`, where `Xxx`
+    #     is the original method name.  For example, if the original method name
+    #     is `TakeSnapshot()`, the inferred response type is
+    #     `TakeSnapshotResponse`.
+    class Operation
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.GetOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource.
+    class GetOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.ListOperations.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation's parent resource.
+    # @!attribute [rw] filter
+    #   @return [::String]
+    #     The standard list filter.
+    # @!attribute [rw] page_size
+    #   @return [::Integer]
+    #     The standard list page size.
+    # @!attribute [rw] page_token
+    #   @return [::String]
+    #     The standard list page token.
+    class ListOperationsRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The response message for Operations.ListOperations.
+    # @!attribute [rw] operations
+    #   @return [::Array<::Google::Longrunning::Operation>]
+    #     A list of operations that matches the specified filter in the request.
+    # @!attribute [rw] next_page_token
+    #   @return [::String]
+    #     The standard List next-page token.
+    class ListOperationsResponse
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.CancelOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to be cancelled.
+    class CancelOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.DeleteOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to be deleted.
+    class DeleteOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.WaitOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to wait on.
+    # @!attribute [rw] timeout
+    #   @return [::Google::Protobuf::Duration]
+    #     The maximum duration to wait before timing out. If left blank, the wait
+    #     will be at most the time permitted by the underlying HTTP/RPC protocol.
+    #     If RPC context deadline is also specified, the shorter one will be used.
+    class WaitOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # A message representing the message types used by a long-running operation.
+    #
+    # Example:
+    #
+    #   rpc LongRunningRecognize(LongRunningRecognizeRequest)
+    #       returns (google.longrunning.Operation) {
+    #     option (google.longrunning.operation_info) = {
+    #       response_type: "LongRunningRecognizeResponse"
+    #       metadata_type: "LongRunningRecognizeMetadata"
+    #     };
+    #   }
+    # @!attribute [rw] response_type
+    #   @return [::String]
+    #     Required. The message name of the primary return type for this
+    #     long-running operation.
+    #     This type will be used to deserialize the LRO's response.
+    #
+    #     If the response is in a different package from the rpc, a fully-qualified
+    #     message name must be used (e.g. `google.protobuf.Struct`).
+    #
+    #     Note: Altering this value constitutes a breaking change.
+    # @!attribute [rw] metadata_type
+    #   @return [::String]
+    #     Required. The message name of the metadata type for this long-running
+    #     operation.
+    #
+    #     If the response is in a different package from the rpc, a fully-qualified
+    #     message name must be used (e.g. `google.protobuf.Struct`).
+    #
+    #     Note: Altering this value constitutes a breaking change.
+    class OperationInfo
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end