docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/lifesciences_v2beta.projects.locations.pipelines.html b/docs/dyn/lifesciences_v2beta.projects.locations.pipelines.html
index 194a69a..dbf69f2 100644
--- a/docs/dyn/lifesciences_v2beta.projects.locations.pipelines.html
+++ b/docs/dyn/lifesciences_v2beta.projects.locations.pipelines.html
@@ -105,20 +105,7 @@
{ # The arguments to the `RunPipeline` method. The requesting user must have
# the `iam.serviceAccounts.actAs` permission for the Cloud Life Sciences
# service account or the request will fail.
- "labels": { # User-defined labels to associate with the returned operation. These
- # labels are not propagated to any Google Cloud Platform resources used by
- # the operation, and can be modified at any time.
- #
- # To associate labels with resources created while executing the operation,
- # see the appropriate resource message (for example, `VirtualMachine`).
- "a_key": "A String",
- },
"pipeline": { # Specifies a series of actions to execute, expressed as Docker containers. # Required. The description of the pipeline to run.
- "environment": { # The environment to pass into every action. Each action can also specify
- # additional environment variables but cannot delete an entry from this map
- # (though they can overwrite it with a different value).
- "a_key": "A String",
- },
"timeout": "A String", # The maximum amount of time to give the pipeline to complete. This includes
# the time spent waiting for a worker to be allocated. If the pipeline fails
# to complete before the timeout, it will be cancelled and the error code
@@ -128,7 +115,56 @@
"resources": { # The system resources for the pipeline run. # The resources required for execution.
#
# At least one zone or region must be specified or the pipeline run will fail.
+ "regions": [ # The list of regions allowed for VM allocation. If set, the `zones` field
+ # must not be set.
+ "A String",
+ ],
+ "zones": [ # The list of zones allowed for VM allocation. If set, the `regions` field
+ # must not be set.
+ "A String",
+ ],
"virtualMachine": { # Carries information about a Compute Engine VM resource. # The virtual machine specification.
+ "disks": [ # The list of disks to create and attach to the VM.
+ { # Carries information about a disk that can be attached to a VM.
+ #
+ # See https://cloud.google.com/compute/docs/disks/performance for more
+ # information about disk type, size, and performance considerations.
+ "type": "A String", # The Compute Engine disk type. If unspecified, `pd-standard` is used.
+ "sourceImage": "A String", # An optional image to put on the disk before attaching it to the VM.
+ "sizeGb": 42, # The size, in GB, of the disk to attach. If the size is not
+ # specified, a default is chosen to ensure reasonable I/O performance.
+ #
+ # If the disk type is specified as `local-ssd`, multiple local drives are
+ # automatically combined to provide the requested size. Note, however, that
+ # each physical SSD is 375GB in size, and no more than 8 drives can be
+ # attached to a single instance.
+ "name": "A String", # A user-supplied name for the disk. Used when mounting the disk into
+ # actions. The name must contain only upper and lowercase alphanumeric
+ # characters and hyphens and cannot start with a hyphen.
+ },
+ ],
+ "serviceAccount": { # Carries information about a Google Cloud service account. # The service account to install on the VM. This account does not need
+ # any permissions other than those required by the pipeline.
+ "email": "A String", # Email address of the service account. If not specified, the default
+ # Compute Engine service account for the project will be used.
+ "scopes": [ # List of scopes to be enabled for this service account on the VM, in
+ # addition to the cloud-platform API scope that will be added by default.
+ "A String",
+ ],
+ },
+ "bootImage": "A String", # The host operating system image to use.
+ #
+ # Currently, only Container-Optimized OS images can be used.
+ #
+ # The default value is `projects/cos-cloud/global/images/family/cos-stable`,
+ # which selects the latest stable release of Container-Optimized OS.
+ #
+ # This option is provided to allow testing against the beta release of the
+ # operating system to ensure that the new version does not interact
+ # negatively with production pipelines.
+ #
+ # To test a pipeline against the beta release of Container-Optimized OS,
+ # use the value `projects/cos-cloud/global/images/family/cos-beta`.
"network": { # VM networking options. # The VM network configuration.
"subnetwork": "A String", # If the specified network is configured for custom subnet creation, the
# name of the subnetwork to attach the instance to must be specified here.
@@ -200,89 +236,10 @@
# type](https://cloud.google.com/compute/docs/instances/creating-instance-with-custom-machine-type#create)
# for more specifications on creating a custom machine type.
"preemptible": True or False, # If true, allocate a preemptible VM.
- "disks": [ # The list of disks to create and attach to the VM.
- { # Carries information about a disk that can be attached to a VM.
- #
- # See https://cloud.google.com/compute/docs/disks/performance for more
- # information about disk type, size, and performance considerations.
- "sizeGb": 42, # The size, in GB, of the disk to attach. If the size is not
- # specified, a default is chosen to ensure reasonable I/O performance.
- #
- # If the disk type is specified as `local-ssd`, multiple local drives are
- # automatically combined to provide the requested size. Note, however, that
- # each physical SSD is 375GB in size, and no more than 8 drives can be
- # attached to a single instance.
- "name": "A String", # A user-supplied name for the disk. Used when mounting the disk into
- # actions. The name must contain only upper and lowercase alphanumeric
- # characters and hyphens and cannot start with a hyphen.
- "type": "A String", # The Compute Engine disk type. If unspecified, `pd-standard` is used.
- "sourceImage": "A String", # An optional image to put on the disk before attaching it to the VM.
- },
- ],
- "serviceAccount": { # Carries information about a Google Cloud service account. # The service account to install on the VM. This account does not need
- # any permissions other than those required by the pipeline.
- "email": "A String", # Email address of the service account. If not specified, the default
- # Compute Engine service account for the project will be used.
- "scopes": [ # List of scopes to be enabled for this service account on the VM, in
- # addition to the cloud-platform API scope that will be added by default.
- "A String",
- ],
- },
- "bootImage": "A String", # The host operating system image to use.
- #
- # Currently, only Container-Optimized OS images can be used.
- #
- # The default value is `projects/cos-cloud/global/images/family/cos-stable`,
- # which selects the latest stable release of Container-Optimized OS.
- #
- # This option is provided to allow testing against the beta release of the
- # operating system to ensure that the new version does not interact
- # negatively with production pipelines.
- #
- # To test a pipeline against the beta release of Container-Optimized OS,
- # use the value `projects/cos-cloud/global/images/family/cos-beta`.
},
- "regions": [ # The list of regions allowed for VM allocation. If set, the `zones` field
- # must not be set.
- "A String",
- ],
- "zones": [ # The list of zones allowed for VM allocation. If set, the `regions` field
- # must not be set.
- "A String",
- ],
},
"actions": [ # The list of actions to execute, in the order they are specified.
{ # Specifies a single action that runs a Docker container.
- "mounts": [ # A list of mounts to make available to the action.
- #
- # In addition to the values specified here, every action has a special
- # virtual disk mounted under `/google` that contains log files and other
- # operational components.
- #
- # <ul>
- # <li><code>/google/logs</code> All logs written during the pipeline
- # execution.</li>
- # <li><code>/google/logs/output</code> The combined standard output and
- # standard error of all actions run as part of the pipeline
- # execution.</li>
- # <li><code>/google/logs/action/*/stdout</code> The complete contents of
- # each individual action's standard output.</li>
- # <li><code>/google/logs/action/*/stderr</code> The complete contents of
- # each individual action's standard error output.</li>
- # </ul>
- { # Carries information about a particular disk mount inside a container.
- "disk": "A String", # The name of the disk to mount, as specified in the resources section.
- "readOnly": True or False, # If true, the disk is mounted read-only inside the container.
- "path": "A String", # The path to mount the disk inside the container.
- },
- ],
- "publishExposedPorts": True or False, # Exposes all ports specified by `EXPOSE` statements in the container. To
- # discover the host side port numbers, consult the `ACTION_STARTED` event
- # in the operation metadata.
- "timeout": "A String", # The maximum amount of time to give the action to complete. If the action
- # fails to complete before the timeout, it will be terminated and the exit
- # status will be non-zero. The pipeline will continue or terminate based
- # on the rules defined by the `ALWAYS_RUN` and `IGNORE_EXIT_STATUS` flags.
"credentials": { # Holds encrypted information that is only decrypted and stored in RAM # If the specified image is hosted on a private registry other than Google
# Container Registry, the credentials required to pull the image must be
# specified here as an encrypted secret.
@@ -383,8 +340,51 @@
"pidNamespace": "A String", # An optional identifier for a PID namespace to run the action inside.
# Multiple actions should use the same string to share a namespace. If
# unspecified, a separate isolated namespace is used.
+ "mounts": [ # A list of mounts to make available to the action.
+ #
+ # In addition to the values specified here, every action has a special
+ # virtual disk mounted under `/google` that contains log files and other
+ # operational components.
+ #
+ # <ul>
+ # <li><code>/google/logs</code> All logs written during the pipeline
+ # execution.</li>
+ # <li><code>/google/logs/output</code> The combined standard output and
+ # standard error of all actions run as part of the pipeline
+ # execution.</li>
+ # <li><code>/google/logs/action/*/stdout</code> The complete contents of
+ # each individual action's standard output.</li>
+ # <li><code>/google/logs/action/*/stderr</code> The complete contents of
+ # each individual action's standard error output.</li>
+ # </ul>
+ { # Carries information about a particular disk mount inside a container.
+ "disk": "A String", # The name of the disk to mount, as specified in the resources section.
+ "readOnly": True or False, # If true, the disk is mounted read-only inside the container.
+ "path": "A String", # The path to mount the disk inside the container.
+ },
+ ],
+ "publishExposedPorts": True or False, # Exposes all ports specified by `EXPOSE` statements in the container. To
+ # discover the host side port numbers, consult the `ACTION_STARTED` event
+ # in the operation metadata.
+ "timeout": "A String", # The maximum amount of time to give the action to complete. If the action
+ # fails to complete before the timeout, it will be terminated and the exit
+ # status will be non-zero. The pipeline will continue or terminate based
+ # on the rules defined by the `ALWAYS_RUN` and `IGNORE_EXIT_STATUS` flags.
},
],
+ "environment": { # The environment to pass into every action. Each action can also specify
+ # additional environment variables but cannot delete an entry from this map
+ # (though they can overwrite it with a different value).
+ "a_key": "A String",
+ },
+ },
+ "labels": { # User-defined labels to associate with the returned operation. These
+ # labels are not propagated to any Google Cloud Platform resources used by
+ # the operation, and can be modified at any time.
+ #
+ # To associate labels with resources created while executing the operation,
+ # see the appropriate resource message (for example, `VirtualMachine`).
+ "a_key": "A String",
},
}
@@ -398,6 +398,9 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "done": True or False, # 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.
"response": { # An Empty object.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
@@ -423,9 +426,6 @@
"metadata": { # An Metadata object. This will always be returned with the Operation.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # 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.
}</pre>
</div>