docs: [google-cloud-batch] Update reservation field to include NO_RESERVATION (googleapis#13308)

gcf-owl-bot[bot] · web-flow · commit 90a49b2b5a4c · 2024-11-27T10:25:43.000-05:00
- [ ] Regenerate this pull request now. --- BEGIN_COMMIT_OVERRIDE docs: Update reservation field to include NO_RESERVATION docs: clarify that user provided labels will also be applied to Cloud Logging END_COMMIT_OVERRIDE PiperOrigin-RevId: 700592805 Source-Link: googleapis/googleapis@ef5e670 Source-Link: https://github.com/googleapis/googleapis-gen/commit/f785d99bae2d43e2b9cb39ee992abe696ef162c9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJhdGNoLy5Pd2xCb3QueWFtbCIsImgiOiJmNzg1ZDk5YmFlMmQ0M2UyYjljYjM5ZWU5OTJhYmU2OTZlZjE2MmM5In0= BEGIN_NESTED_COMMIT docs: [google-cloud-batch] Update reservation field to include NO_RESERVATION --- docs: clarify that user provided labels will also be applied to Cloud Logging --- docs: Clarify Batch only supports global custom instance template now PiperOrigin-RevId: 700490716 Source-Link: googleapis/googleapis@898125d Source-Link: https://github.com/googleapis/googleapis-gen/commit/c0dac7c27e1f65603b2c83db2d58453bfd07561f Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJhdGNoLy5Pd2xCb3QueWFtbCIsImgiOiJjMGRhYzdjMjdlMWY2NTYwM2IyYzgzZGIyZDU4NDUzYmZkMDc1NjFmIn0= END_NESTED_COMMIT --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
diff --git a/packages/google-cloud-batch/google/cloud/batch/gapic_version.py b/packages/google-cloud-batch/google/cloud/batch/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.17.31"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/packages/google-cloud-batch/google/cloud/batch_v1/gapic_version.py b/packages/google-cloud-batch/google/cloud/batch_v1/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.17.31"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/packages/google-cloud-batch/google/cloud/batch_v1/types/job.py b/packages/google-cloud-batch/google/cloud/batch_v1/types/job.py
@@ -60,13 +60,18 @@ class Job(proto.Message):
             Compute resource allocation for all
             TaskGroups in the Job.
         labels (MutableMapping[str, str]):
-            Labels for the Job. Labels could be user provided or system
-            generated. For example, "labels": { "department": "finance",
-            "environment": "test" } You can assign up to 64 labels.
-            `Google Compute Engine label
-            restrictions <https://cloud.google.com/compute/docs/labeling-resources#restrictions>`__
-            apply. Label names that start with "goog-" or "google-" are
-            reserved.
+            Custom labels to apply to the job and any Cloud Logging
+            `LogEntry <https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry>`__
+            that it generates.
+
+            Use labels to group and describe the resources they are
+            applied to. Batch automatically applies predefined labels
+            and supports multiple ``labels`` fields for each job, which
+            each let you apply custom labels to various resources. Label
+            names that start with "goog-" or "google-" are reserved for
+            predefined labels. For more information about labels with
+            Batch, see `Organize resources using
+            labels <https://cloud.google.com/batch/docs/organize-resources-using-labels>`__.
         status (google.cloud.batch_v1.types.JobStatus):
             Output only. Job status. It is read only for
             users.
@@ -446,13 +451,18 @@ class AllocationPolicy(proto.Message):
                account, beyond the default cloud-platform scope. (list
                of strings)
         labels (MutableMapping[str, str]):
-            Labels applied to all VM instances and other resources
-            created by AllocationPolicy. Labels could be user provided
-            or system generated. You can assign up to 64 labels. `Google
-            Compute Engine label
-            restrictions <https://cloud.google.com/compute/docs/labeling-resources#restrictions>`__
-            apply. Label names that start with "goog-" or "google-" are
-            reserved.
+            Custom labels to apply to the job and all the Compute Engine
+            resources that both are created by this allocation policy
+            and support labels.
+
+            Use labels to group and describe the resources they are
+            applied to. Batch automatically applies predefined labels
+            and supports multiple ``labels`` fields for each job, which
+            each let you apply custom labels to various resources. Label
+            names that start with "goog-" or "google-" are reserved for
+            predefined labels. For more information about labels with
+            Batch, see `Organize resources using
+            labels <https://cloud.google.com/batch/docs/organize-resources-using-labels>`__.
         network (google.cloud.batch_v1.types.AllocationPolicy.NetworkPolicy):
             The network policy.
 
@@ -729,10 +739,10 @@ class InstancePolicy(proto.Message):
                 file system or a raw storage drive that is not
                 ready for data storage and accessing.
             reservation (str):
-                Optional. If specified, VMs will consume only
-                the specified reservation. If not specified
-                (default), VMs will consume any applicable
-                reservation.
+                Optional. If specified, VMs will consume only the specified
+                reservation. If not specified (default), VMs will consume
+                any applicable reservation. Additionally, VMs will not
+                consume any reservation if "NO_RESERVATION" is specified.
         """
 
         machine_type: str = proto.Field(
diff --git a/packages/google-cloud-batch/google/cloud/batch_v1alpha/gapic_version.py b/packages/google-cloud-batch/google/cloud/batch_v1alpha/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.17.31"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/packages/google-cloud-batch/google/cloud/batch_v1alpha/types/job.py b/packages/google-cloud-batch/google/cloud/batch_v1alpha/types/job.py
@@ -69,13 +69,18 @@ class Job(proto.Message):
             Compute resource allocation for all
             TaskGroups in the Job.
         labels (MutableMapping[str, str]):
-            Labels for the Job. Labels could be user provided or system
-            generated. For example, "labels": { "department": "finance",
-            "environment": "test" } You can assign up to 64 labels.
-            `Google Compute Engine label
-            restrictions <https://cloud.google.com/compute/docs/labeling-resources#restrictions>`__
-            apply. Label names that start with "goog-" or "google-" are
-            reserved.
+            Custom labels to apply to the job and any Cloud Logging
+            `LogEntry <https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry>`__
+            that it generates.
+
+            Use labels to group and describe the resources they are
+            applied to. Batch automatically applies predefined labels
+            and supports multiple ``labels`` fields for each job, which
+            each let you apply custom labels to various resources. Label
+            names that start with "goog-" or "google-" are reserved for
+            predefined labels. For more information about labels with
+            Batch, see `Organize resources using
+            labels <https://cloud.google.com/batch/docs/organize-resources-using-labels>`__.
         status (google.cloud.batch_v1alpha.types.JobStatus):
             Output only. Job status. It is read only for
             users.
@@ -568,13 +573,18 @@ class AllocationPolicy(proto.Message):
                account, beyond the default cloud-platform scope. (list
                of strings)
         labels (MutableMapping[str, str]):
-            Labels applied to all VM instances and other resources
-            created by AllocationPolicy. Labels could be user provided
-            or system generated. You can assign up to 64 labels. `Google
-            Compute Engine label
-            restrictions <https://cloud.google.com/compute/docs/labeling-resources#restrictions>`__
-            apply. Label names that start with "goog-" or "google-" are
-            reserved.
+            Custom labels to apply to the job and all the Compute Engine
+            resources that both are created by this allocation policy
+            and support labels.
+
+            Use labels to group and describe the resources they are
+            applied to. Batch automatically applies predefined labels
+            and supports multiple ``labels`` fields for each job, which
+            each let you apply custom labels to various resources. Label
+            names that start with "goog-" or "google-" are reserved for
+            predefined labels. For more information about labels with
+            Batch, see `Organize resources using
+            labels <https://cloud.google.com/batch/docs/organize-resources-using-labels>`__.
         network (google.cloud.batch_v1alpha.types.AllocationPolicy.NetworkPolicy):
             The network policy.
 
@@ -861,10 +871,10 @@ class InstancePolicy(proto.Message):
                 file system or a raw storage drive that is not
                 ready for data storage and accessing.
             reservation (str):
-                Optional. If specified, VMs will consume only
-                the specified reservation. If not specified
-                (default), VMs will consume any applicable
-                reservation.
+                Optional. If specified, VMs will consume only the specified
+                reservation. If not specified (default), VMs will consume
+                any applicable reservation. Additionally, VMs will not
+                consume any reservation if "NO_RESERVATION" is specified.
         """
 
         allowed_machine_types: MutableSequence[str] = proto.RepeatedField(
@@ -928,7 +938,11 @@ class InstancePolicyOrTemplate(proto.Message):
             instance_template (str):
                 Name of an instance template used to create VMs. Named the
                 field as 'instance_template' instead of 'template' to avoid
-                c++ keyword conflict.
+                C++ keyword conflict.
+
+                Batch only supports global instance templates. You can
+                specify the global instance template as a full or partial
+                URL.
 
                 This field is a member of `oneof`_ ``policy_template``.
             install_gpu_drivers (bool):
diff --git a/packages/google-cloud-batch/samples/generated_samples/snippet_metadata_google.cloud.batch.v1.json b/packages/google-cloud-batch/samples/generated_samples/snippet_metadata_google.cloud.batch.v1.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-batch",
-    "version": "0.17.31"
+    "version": "0.1.0"
   },
   "snippets": [
     {
diff --git a/packages/google-cloud-batch/samples/generated_samples/snippet_metadata_google.cloud.batch.v1alpha.json b/packages/google-cloud-batch/samples/generated_samples/snippet_metadata_google.cloud.batch.v1alpha.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-batch",
-    "version": "0.17.31"
+    "version": "0.1.0"
   },
   "snippets": [
     {

Original file line number	Diff line number	Diff line change
`@@ -13,4 +13,4 @@`
`13`	`13`	`# See the License for the specific language governing permissions and`
`14`	`14`	`# limitations under the License.`
`15`	`15`	`#`
`16`		`-__version__ = "0.17.31" # {x-release-please-version}`
	`16`	`+__version__ = "0.0.0" # {x-release-please-version}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`],`
`9`	`9`	`"language": "PYTHON",`
`10`	`10`	`"name": "google-cloud-batch",`
`11`		`- "version": "0.17.31"`
	`11`	`+ "version": "0.1.0"`
`12`	`12`	`},`
`13`	`13`	`"snippets": [`
`14`	`14`	`{`