google-cloud-batch-v1 0.6.0 → 0.8.0

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

@@ -32,7 +32,8 @@ module Google
         # @!attribute [rw] priority
         #   @return [::Integer]
         #     Priority of the Job.
-        #     The valid value range is [0, 100).
+        #     The valid value range is [0, 100). Default value is 0.
+        #     Higher value indicates higher priority.
         #     A job with higher priority value is more likely to run earlier if all other
         #     requirements are satisfied.
         # @!attribute [rw] task_groups
@@ -274,6 +275,9 @@ module Google
         # @!attribute [rw] network
         #   @return [::Google::Cloud::Batch::V1::AllocationPolicy::NetworkPolicy]
         #     The network policy.
+        # @!attribute [rw] placement
+        #   @return [::Google::Cloud::Batch::V1::AllocationPolicy::PlacementPolicy]
+        #     The placement policy.
         class AllocationPolicy
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -281,12 +285,14 @@ module Google
           # @!attribute [rw] allowed_locations
           #   @return [::Array<::String>]
           #     A list of allowed location names represented by internal URLs.
+          #
           #     Each location can be a region or a zone.
           #     Only one region or multiple zones in one region is supported now.
           #     For example,
           #     ["regions/us-central1"] allow VMs in any zones in region us-central1.
           #     ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs
           #     in zones us-central1-a and us-central1-c.
+          #
           #     All locations end up in different regions would cause errors.
           #     For example,
           #     ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b",
@@ -299,24 +305,28 @@ module Google
 
           # A new persistent disk or a local ssd.
           # A VM can only have one local SSD setting but multiple local SSD partitions.
-          # https://cloud.google.com/compute/docs/disks#pdspecs.
+          # See https://cloud.google.com/compute/docs/disks#pdspecs and
           # https://cloud.google.com/compute/docs/disks#localssds.
           # @!attribute [rw] image
           #   @return [::String]
           #     Name of a public or custom image used as the data source.
           #     For example, the following are all valid URLs:
-          #     (1) Specify the image by its family name:
+          #
+          #     * Specify the image by its family name:
           #     projects/\\{project}/global/images/family/\\{image_family}
-          #     (2) Specify the image version:
+          #     * Specify the image version:
           #     projects/\\{project}/global/images/\\{image_version}
+          #
           #     You can also use Batch customized image in short names.
           #     The following image values are supported for a boot disk:
-          #     "batch-debian": use Batch Debian images.
-          #     "batch-centos": use Batch CentOS images.
-          #     "batch-cos": use Batch Container-Optimized images.
+          #
+          #     * "batch-debian": use Batch Debian images.
+          #     * "batch-centos": use Batch CentOS images.
+          #     * "batch-cos": use Batch Container-Optimized images.
           # @!attribute [rw] snapshot
           #   @return [::String]
           #     Name of a snapshot used as the data source.
+          #     Snapshot is not supported as boot disk now.
           # @!attribute [rw] type
           #   @return [::String]
           #     Disk type as shown in `gcloud compute disk-types list`.
@@ -326,6 +336,7 @@ module Google
           # @!attribute [rw] size_gb
           #   @return [::Integer]
           #     Disk size in GB.
+          #
           #     For persistent disk, this field is ignored if `data_source` is `image` or
           #     `snapshot`.
           #     For local SSD, size_gb should be a multiple of 375GB,
@@ -387,7 +398,7 @@ module Google
           #   @return [::String]
           #     The minimum CPU platform.
           #     See
-          #     `https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform`.
+          #     https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
           #     Not yet implemented.
           # @!attribute [rw] provisioning_model
           #   @return [::Google::Cloud::Batch::V1::AllocationPolicy::ProvisioningModel]
@@ -397,8 +408,9 @@ module Google
           #     The accelerators attached to each VM instance.
           # @!attribute [rw] boot_disk
           #   @return [::Google::Cloud::Batch::V1::AllocationPolicy::Disk]
-          #     Book disk to be created and attached to each VM by this InstancePolicy.
+          #     Boot disk to be created and attached to each VM by this InstancePolicy.
           #     Boot disk will be deleted when the VM is deleted.
+          #     Batch API now only supports booting from image.
           # @!attribute [rw] disks
           #   @return [::Array<::Google::Cloud::Batch::V1::AllocationPolicy::AttachedDisk>]
           #     Non-boot disks to be attached for each VM created by this InstancePolicy.
@@ -433,18 +445,22 @@ module Google
           #   @return [::String]
           #     The URL of an existing network resource.
           #     You can specify the network as a full or partial URL.
+          #
           #     For example, the following are all valid URLs:
-          #     https://www.googleapis.com/compute/v1/projects/\\{project}/global/networks/\\{network}
-          #     projects/\\{project}/global/networks/\\{network}
-          #     global/networks/\\{network}
+          #
+          #     * https://www.googleapis.com/compute/v1/projects/\\{project}/global/networks/\\{network}
+          #     * projects/\\{project}/global/networks/\\{network}
+          #     * global/networks/\\{network}
           # @!attribute [rw] subnetwork
           #   @return [::String]
           #     The URL of an existing subnetwork resource in the network.
           #     You can specify the subnetwork as a full or partial URL.
+          #
           #     For example, the following are all valid URLs:
-          #     https://www.googleapis.com/compute/v1/projects/\\{project}/regions/\\{region}/subnetworks/\\{subnetwork}
-          #     projects/\\{project}/regions/\\{region}/subnetworks/\\{subnetwork}
-          #     regions/\\{region}/subnetworks/\\{subnetwork}
+          #
+          #     * https://www.googleapis.com/compute/v1/projects/\\{project}/regions/\\{region}/subnetworks/\\{subnetwork}
+          #     * projects/\\{project}/regions/\\{region}/subnetworks/\\{subnetwork}
+          #     * regions/\\{region}/subnetworks/\\{subnetwork}
           # @!attribute [rw] no_external_ip_address
           #   @return [::Boolean]
           #     Default is false (with an external IP address). Required if
@@ -468,6 +484,26 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # PlacementPolicy describes a group placement policy for the VMs controlled
+          # by this AllocationPolicy.
+          # @!attribute [rw] collocation
+          #   @return [::String]
+          #     UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you
+          #     want VMs to be located close to each other for low network latency
+          #     between the VMs. No placement policy will be generated when collocation
+          #     is UNSPECIFIED.
+          # @!attribute [rw] max_distance
+          #   @return [::Integer]
+          #     When specified, causes the job to fail if more than max_distance logical
+          #     switches are required between VMs. Batch uses the most compact possible
+          #     placement of VMs even when max_distance is not specified. An explicit
+          #     max_distance makes that level of compactness a strict requirement.
+          #     Not yet implemented
+          class PlacementPolicy
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # @!attribute [rw] key
           #   @return [::String]
           # @!attribute [rw] value
@@ -512,11 +548,12 @@ module Google
         # @!attribute [rw] task_count
         #   @return [::Integer]
         #     Number of Tasks in the TaskGroup.
-        #     default is 1
+        #     Default is 1.
         # @!attribute [rw] parallelism
         #   @return [::Integer]
         #     Max number of tasks that can run in parallel.
         #     Default to min(task_count, 1000).
+        #     Field parallelism must be 1 if the scheduling_policy is IN_ORDER.
         # @!attribute [rw] task_environments
         #   @return [::Array<::Google::Cloud::Batch::V1::Environment>]
         #     An array of environment variable mappings, which are passed to Tasks with

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

@@ -49,6 +49,9 @@ module Google
         # @!attribute [rw] task_execution
         #   @return [::Google::Cloud::Batch::V1::TaskExecution]
         #     Task Execution
+        # @!attribute [rw] task_state
+        #   @return [::Google::Cloud::Batch::V1::TaskStatus::State]
+        #     Task State
         class StatusEvent
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -78,7 +81,7 @@ module Google
 
           # Task states.
           module State
-            # unknown state
+            # Unknown state.
             STATE_UNSPECIFIED = 0
 
             # The Task is created and waiting for resources.
@@ -95,6 +98,9 @@ module Google
 
             # The Task has succeeded.
             SUCCEEDED = 5
+
+            # The Task has not been executed when the Job finishes.
+            UNEXECUTED = 6
           end
         end
 
@@ -135,6 +141,9 @@ module Google
         # @!attribute [rw] timeout
         #   @return [::Google::Protobuf::Duration]
         #     Timeout for this Runnable.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Labels for this Runnable.
         class Runnable
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -163,8 +172,9 @@ module Google
           # @!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'.
+          #     blocked, containers that are with block_external_network as true can
+          #     still communicate with each other, network cannot be specified in the
+          #     `container.options` field.
           # @!attribute [rw] username
           #   @return [::String]
           #     Optional username for logging in to a docker registry. If username
@@ -184,9 +194,23 @@ module Google
           # @!attribute [rw] path
           #   @return [::String]
           #     Script file path on the host VM.
+          #
+          #     To specify an interpreter, please add a `#!<interpreter>`(also known as
+          #     [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the
+          #     first line of the file.(For example, to execute the script using bash,
+          #     `#!/bin/bash` should be the first line of the file. To execute the
+          #     script using`Python3`, `#!/usr/bin/env python3` should be the first
+          #     line of the file.) Otherwise, the file will by default be excuted by
+          #     `/bin/sh`.
           # @!attribute [rw] text
           #   @return [::String]
           #     Shell script text.
+          #
+          #     To specify an interpreter, please add a `#!<interpreter>\n` at the
+          #     beginning of the text.(For example, to execute the script using bash,
+          #     `#!/bin/bash\n` should be added. To execute the script using`Python3`,
+          #     `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will
+          #     by default be excuted by `/bin/sh`.
           class Script
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -201,6 +225,15 @@ module Google
             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
         end
 
         # Spec of a task
@@ -231,13 +264,12 @@ module Google
         # @!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.
+        #     Currently we only support one lifecycle policy.
+        #     When the lifecycle policy condition is met,
+        #     the action in the policy will execute.
+        #     If task execution result does not meet with 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}]
@@ -267,6 +299,10 @@ module Google
         # @!attribute [rw] action
         #   @return [::Google::Cloud::Batch::V1::LifecyclePolicy::Action]
         #     Action to execute when ActionCondition is true.
+        #     When RETRY_TASK is specified, we will retry failed tasks
+        #     if we notice any exit code match and fail tasks if no match is found.
+        #     Likewise, when FAIL_TASK is specified, we will fail tasks
+        #     if we notice any exit code match and retry tasks if no match is found.
         # @!attribute [rw] action_condition
         #   @return [::Google::Cloud::Batch::V1::LifecyclePolicy::ActionCondition]
         #     Conditions that decide why a task failure is dealt with a specific action.

data/proto_docs/google/iam/v1/iam_policy.rb

@@ -0,0 +1,87 @@
+# 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 Iam
+    module V1
+      # Request message for `SetIamPolicy` method.
+      # @!attribute [rw] resource
+      #   @return [::String]
+      #     REQUIRED: The resource for which the policy is being specified.
+      #     See the operation documentation for the appropriate value for this field.
+      # @!attribute [rw] policy
+      #   @return [::Google::Iam::V1::Policy]
+      #     REQUIRED: The complete policy to be applied to the `resource`. The size of
+      #     the policy is limited to a few 10s of KB. An empty policy is a
+      #     valid policy but certain Cloud Platform services (such as Projects)
+      #     might reject them.
+      # @!attribute [rw] update_mask
+      #   @return [::Google::Protobuf::FieldMask]
+      #     OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
+      #     the fields in the mask will be modified. If no mask is provided, the
+      #     following default mask is used:
+      #
+      #     `paths: "bindings, etag"`
+      class SetIamPolicyRequest
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+
+      # Request message for `GetIamPolicy` method.
+      # @!attribute [rw] resource
+      #   @return [::String]
+      #     REQUIRED: The resource for which the policy is being requested.
+      #     See the operation documentation for the appropriate value for this field.
+      # @!attribute [rw] options
+      #   @return [::Google::Iam::V1::GetPolicyOptions]
+      #     OPTIONAL: A `GetPolicyOptions` object for specifying options to
+      #     `GetIamPolicy`.
+      class GetIamPolicyRequest
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+
+      # Request message for `TestIamPermissions` method.
+      # @!attribute [rw] resource
+      #   @return [::String]
+      #     REQUIRED: The resource for which the policy detail is being requested.
+      #     See the operation documentation for the appropriate value for this field.
+      # @!attribute [rw] permissions
+      #   @return [::Array<::String>]
+      #     The set of permissions to check for the `resource`. Permissions with
+      #     wildcards (such as '*' or 'storage.*') are not allowed. For more
+      #     information see
+      #     [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+      class TestIamPermissionsRequest
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+
+      # Response message for `TestIamPermissions` method.
+      # @!attribute [rw] permissions
+      #   @return [::Array<::String>]
+      #     A subset of `TestPermissionsRequest.permissions` that the caller is
+      #     allowed.
+      class TestIamPermissionsResponse
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+    end
+  end
+end

data/proto_docs/google/iam/v1/options.rb

@@ -0,0 +1,50 @@
+# 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 Iam
+    module V1
+      # Encapsulates settings provided to GetIamPolicy.
+      # @!attribute [rw] requested_policy_version
+      #   @return [::Integer]
+      #     Optional. The maximum policy version that will be used to format the
+      #     policy.
+      #
+      #     Valid values are 0, 1, and 3. Requests specifying an invalid value will be
+      #     rejected.
+      #
+      #     Requests for policies with any conditional role bindings must specify
+      #     version 3. Policies with no conditional role bindings may specify any valid
+      #     value or leave the field unset.
+      #
+      #     The policy in the response might use the policy version that you specified,
+      #     or it might use a lower policy version. For example, if you specify version
+      #     3, but the policy has no conditional role bindings, the response uses
+      #     version 1.
+      #
+      #     To learn which resources support conditions in their IAM policies, see the
+      #     [IAM
+      #     documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+      class GetPolicyOptions
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+    end
+  end
+end