docs: [google-cloud-batch] Polish the field descriptions for enableImageStreaming and CloudLoggingOptions (googleapis#12216)

gcf-owl-bot[bot] · web-flow · commit d23ec544504a · 2024-01-23T10:04:15.000-05:00
- [ ] Regenerate this pull request now. PiperOrigin-RevId: 600746356 Source-Link: googleapis/googleapis@72a708b Source-Link: https://github.com/googleapis/googleapis-gen/commit/57fe15b5f52ff609d1ce3acaa6f2ef4b615bb841 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJhdGNoLy5Pd2xCb3QueWFtbCIsImgiOiI1N2ZlMTViNWY1MmZmNjA5ZDFjZTNhY2FhNmYyZWY0YjYxNWJiODQxIn0= --------- 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.8"  # {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.8"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
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.8"  # {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
@@ -190,8 +190,8 @@ class LogsPolicy(proto.Message):
             path.
         cloud_logging_option (google.cloud.batch_v1alpha.types.LogsPolicy.CloudLoggingOption):
             Optional. Additional settings for Cloud Logging. It will
-            only take effect when the destination of LogsPolicy is set
-            to CLOUD_LOGGING.
+            only take effect when the destination of ``LogsPolicy`` is
+            set to ``CLOUD_LOGGING``.
     """
 
     class Destination(proto.Enum):
@@ -210,13 +210,19 @@ class Destination(proto.Enum):
         PATH = 2
 
     class CloudLoggingOption(proto.Message):
-        r"""CloudLoggingOption contains additional settings for cloud
-        logging generated by Batch job.
+        r"""``CloudLoggingOption`` contains additional settings for Cloud
+        Logging logs generated by Batch job.
 
         Attributes:
             use_generic_task_monitored_resource (bool):
-                Optional. Set this flag to true to use generic_task as
-                monitored resource for Batch job generated cloud logging.
+                Optional. Set this flag to true to change the `monitored
+                resource
+                type <https://cloud.google.com/monitoring/api/resources>`__
+                for Cloud Logging logs generated by this Batch job from the
+                ```batch.googleapis.com/Job`` <https://cloud.google.com/monitoring/api/resources#tag_batch.googleapis.com/Job>`__
+                type to the formerly used
+                ```generic_task`` <https://cloud.google.com/monitoring/api/resources#tag_generic_task>`__
+                type.
         """
 
         use_generic_task_monitored_resource: bool = proto.Field(
@@ -543,9 +549,9 @@ class AllocationPolicy(proto.Message):
             The network policy.
 
             If you define an instance template in the
-            InstancePolicyOrTemplate field, Batch will use
-            the network settings in the instance template
-            instead of this field.
+            ``InstancePolicyOrTemplate`` field, Batch will use the
+            network settings in the instance template instead of this
+            field.
         placement (google.cloud.batch_v1alpha.types.AllocationPolicy.PlacementPolicy):
             The placement policy.
         tags (MutableSequence[str]):
diff --git a/packages/google-cloud-batch/google/cloud/batch_v1alpha/types/task.py b/packages/google-cloud-batch/google/cloud/batch_v1alpha/types/task.py
@@ -366,13 +366,26 @@ class Container(proto.Message):
                 password matches ``projects/*/secrets/*/versions/*`` then
                 Batch will read the password from the Secret Manager;
             enable_image_streaming (bool):
-                Optional. If set to true, container will run with Image
-                streaming. The container runtime will be changed to
-                containerd instead of docker. Currently, only imageUri,
-                commands, entrypoint and volumes are supported and any other
-                fields will be ignored. Please refer
-                `here <https://github.com/GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming>`__
-                for the feature requirements and limitations.
+                Optional. If set to true, this container runnable uses Image
+                streaming.
+
+                Use Image streaming to allow the runnable to initialize
+                without waiting for the entire container image to download,
+                which can significantly reduce startup time for large
+                container images.
+
+                When ``enableImageStreaming`` is set to true, the container
+                runtime is `containerd <https://containerd.io/>`__ instead
+                of Docker. Additionally, this container runnable only
+                supports the following ``container`` subfields:
+                ``imageUri``, ``commands[]``, ``entrypoint``, and
+                ``volumes[]``; any other ``container`` subfields are
+                ignored.
+
+                For more information about the requirements and limitations
+                for using Image streaming with Batch, see the
+                ```image-streaming`` sample on
+                GitHub <https://github.com/GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming>`__.
         """
 
         image_uri: str = proto.Field(
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.8"
+    "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.8"
+    "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.8" # {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.8"`
	`11`	`+ "version": "0.1.0"`
`12`	`12`	`},`
`13`	`13`	`"snippets": [`
`14`	`14`	`{`