docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/genomics_v1alpha2.pipelines.html b/docs/dyn/genomics_v1alpha2.pipelines.html
index 169d6b6..ec8a23e 100644
--- a/docs/dyn/genomics_v1alpha2.pipelines.html
+++ b/docs/dyn/genomics_v1alpha2.pipelines.html
@@ -87,7 +87,7 @@
<code><a href="#getControllerConfig">getControllerConfig(operationId=None, validationToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets controller configuration information. Should only be called</p>
<p class="toc_element">
- <code><a href="#list">list(namePrefix=None, pageToken=None, pageSize=None, projectId=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(pageToken=None, pageSize=None, projectId=None, namePrefix=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists pipelines.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -118,6 +118,15 @@
# is run on a Google Compute Engine VM. A pipeline can be created with the
# `create` method and then later run with the `run` method, or a pipeline can
# be defined and run all at once with the `run` method.
+ "name": "A String", # Required. A user specified pipeline name that does not have to be unique.
+ # This name can be used for filtering Pipelines in ListPipelines.
+ "pipelineId": "A String", # Unique pipeline id that is generated by the service when CreatePipeline
+ # is called. Cannot be specified in the Pipeline used in the
+ # CreatePipelineRequest, and will be populated in the response to
+ # CreatePipeline and all subsequent Get and List calls. Indicates that the
+ # service has registered this pipeline.
+ "projectId": "A String", # Required. The project in which to create the pipeline. The caller must have
+ # WRITE access.
"outputParameters": [ # Output parameters of the pipeline.
{ # Parameters facilitate setting and delivering data into the
# pipeline's execution environment. They are defined at create time,
@@ -231,8 +240,6 @@
},
],
"docker": { # The Docker execuctor specification. # Specifies the docker run information.
- "imageName": "A String", # Required. Image name from either Docker Hub or Google Container Registry.
- # Users that run pipelines must have READ access to the image.
"cmd": "A String", # Required. The command or newline delimited script to run. The command
# string will be executed within a bash shell.
#
@@ -241,6 +248,8 @@
# `error` field will be populated.
#
# Maximum command string length is 16384.
+ "imageName": "A String", # Required. Image name from either Docker Hub or Google Container Registry.
+ # Users that run pipelines must have READ access to the image.
},
"description": "A String", # User-specified description.
"inputParameters": [ # Input parameters of the pipeline.
@@ -363,15 +372,14 @@
#
# *
# minimumRamGb
+ "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
"preemptible": True or False, # Whether to use preemptible VMs. Defaults to `false`. In order to use this,
# must be true for both create time and run time. Cannot be true at run time
# if false at create time.
- "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
"zones": [ # List of Google Compute Engine availability zones to which resource
# creation will restricted. If empty, any zone may be chosen.
"A String",
],
- "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
"acceleratorCount": "A String", # Optional. The number of accelerators of the specified type to attach.
# By specifying this parameter, you will download and install the following
# third-party software onto your managed Compute Engine instances:
@@ -382,6 +390,7 @@
# Tesla® drivers and NVIDIA® CUDA toolkit.
# Please see https://cloud.google.com/compute/docs/gpus/ for a list of
# available accelerator types.
+ "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
"noAddress": True or False, # Whether to assign an external IP to the instance. This is an experimental
# feature that may go away. Defaults to false.
# Corresponds to `--no_address` flag for [gcloud compute instances create]
@@ -396,6 +405,14 @@
# IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips).
"disks": [ # Disks to attach.
{ # A Google Compute Engine disk resource specification.
+ "name": "A String", # Required. The name of the disk that can be used in the pipeline
+ # parameters. Must be 1 - 63 characters.
+ # The name "boot" is reserved for system use.
+ "type": "A String", # Required. The type of the disk to create.
+ "autoDelete": True or False, # Deprecated. Disks created by the Pipelines API will be deleted at the end
+ # of the pipeline run, regardless of what this field is set to.
+ "sizeGb": 42, # The size of the disk. Defaults to 500 (GB).
+ # This field is not applicable for local SSD.
"mountPoint": "A String", # Required at create time and cannot be overridden at run time.
# Specifies the path in the docker container where files on
# this disk should be located. For example, if `mountPoint`
@@ -411,27 +428,10 @@
# and
# https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots
# for more details.
- "name": "A String", # Required. The name of the disk that can be used in the pipeline
- # parameters. Must be 1 - 63 characters.
- # The name "boot" is reserved for system use.
- "type": "A String", # Required. The type of the disk to create.
- "autoDelete": True or False, # Deprecated. Disks created by the Pipelines API will be deleted at the end
- # of the pipeline run, regardless of what this field is set to.
- "sizeGb": 42, # The size of the disk. Defaults to 500 (GB).
- # This field is not applicable for local SSD.
},
],
"bootDiskSizeGb": 42, # The size of the boot disk. Defaults to 10 (GB).
},
- "name": "A String", # Required. A user specified pipeline name that does not have to be unique.
- # This name can be used for filtering Pipelines in ListPipelines.
- "projectId": "A String", # Required. The project in which to create the pipeline. The caller must have
- # WRITE access.
- "pipelineId": "A String", # Unique pipeline id that is generated by the service when CreatePipeline
- # is called. Cannot be specified in the Pipeline used in the
- # CreatePipelineRequest, and will be populated in the response to
- # CreatePipeline and all subsequent Get and List calls. Indicates that the
- # service has registered this pipeline.
}
x__xgafv: string, V1 error format.
@@ -448,6 +448,15 @@
# is run on a Google Compute Engine VM. A pipeline can be created with the
# `create` method and then later run with the `run` method, or a pipeline can
# be defined and run all at once with the `run` method.
+ "name": "A String", # Required. A user specified pipeline name that does not have to be unique.
+ # This name can be used for filtering Pipelines in ListPipelines.
+ "pipelineId": "A String", # Unique pipeline id that is generated by the service when CreatePipeline
+ # is called. Cannot be specified in the Pipeline used in the
+ # CreatePipelineRequest, and will be populated in the response to
+ # CreatePipeline and all subsequent Get and List calls. Indicates that the
+ # service has registered this pipeline.
+ "projectId": "A String", # Required. The project in which to create the pipeline. The caller must have
+ # WRITE access.
"outputParameters": [ # Output parameters of the pipeline.
{ # Parameters facilitate setting and delivering data into the
# pipeline's execution environment. They are defined at create time,
@@ -561,8 +570,6 @@
},
],
"docker": { # The Docker execuctor specification. # Specifies the docker run information.
- "imageName": "A String", # Required. Image name from either Docker Hub or Google Container Registry.
- # Users that run pipelines must have READ access to the image.
"cmd": "A String", # Required. The command or newline delimited script to run. The command
# string will be executed within a bash shell.
#
@@ -571,6 +578,8 @@
# `error` field will be populated.
#
# Maximum command string length is 16384.
+ "imageName": "A String", # Required. Image name from either Docker Hub or Google Container Registry.
+ # Users that run pipelines must have READ access to the image.
},
"description": "A String", # User-specified description.
"inputParameters": [ # Input parameters of the pipeline.
@@ -693,15 +702,14 @@
#
# *
# minimumRamGb
+ "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
"preemptible": True or False, # Whether to use preemptible VMs. Defaults to `false`. In order to use this,
# must be true for both create time and run time. Cannot be true at run time
# if false at create time.
- "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
"zones": [ # List of Google Compute Engine availability zones to which resource
# creation will restricted. If empty, any zone may be chosen.
"A String",
],
- "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
"acceleratorCount": "A String", # Optional. The number of accelerators of the specified type to attach.
# By specifying this parameter, you will download and install the following
# third-party software onto your managed Compute Engine instances:
@@ -712,6 +720,7 @@
# Tesla® drivers and NVIDIA® CUDA toolkit.
# Please see https://cloud.google.com/compute/docs/gpus/ for a list of
# available accelerator types.
+ "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
"noAddress": True or False, # Whether to assign an external IP to the instance. This is an experimental
# feature that may go away. Defaults to false.
# Corresponds to `--no_address` flag for [gcloud compute instances create]
@@ -726,6 +735,14 @@
# IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips).
"disks": [ # Disks to attach.
{ # A Google Compute Engine disk resource specification.
+ "name": "A String", # Required. The name of the disk that can be used in the pipeline
+ # parameters. Must be 1 - 63 characters.
+ # The name "boot" is reserved for system use.
+ "type": "A String", # Required. The type of the disk to create.
+ "autoDelete": True or False, # Deprecated. Disks created by the Pipelines API will be deleted at the end
+ # of the pipeline run, regardless of what this field is set to.
+ "sizeGb": 42, # The size of the disk. Defaults to 500 (GB).
+ # This field is not applicable for local SSD.
"mountPoint": "A String", # Required at create time and cannot be overridden at run time.
# Specifies the path in the docker container where files on
# this disk should be located. For example, if `mountPoint`
@@ -741,27 +758,10 @@
# and
# https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots
# for more details.
- "name": "A String", # Required. The name of the disk that can be used in the pipeline
- # parameters. Must be 1 - 63 characters.
- # The name "boot" is reserved for system use.
- "type": "A String", # Required. The type of the disk to create.
- "autoDelete": True or False, # Deprecated. Disks created by the Pipelines API will be deleted at the end
- # of the pipeline run, regardless of what this field is set to.
- "sizeGb": 42, # The size of the disk. Defaults to 500 (GB).
- # This field is not applicable for local SSD.
},
],
"bootDiskSizeGb": 42, # The size of the boot disk. Defaults to 10 (GB).
},
- "name": "A String", # Required. A user specified pipeline name that does not have to be unique.
- # This name can be used for filtering Pipelines in ListPipelines.
- "projectId": "A String", # Required. The project in which to create the pipeline. The caller must have
- # WRITE access.
- "pipelineId": "A String", # Unique pipeline id that is generated by the service when CreatePipeline
- # is called. Cannot be specified in the Pipeline used in the
- # CreatePipelineRequest, and will be populated in the response to
- # CreatePipeline and all subsequent Get and List calls. Indicates that the
- # service has registered this pipeline.
}</pre>
</div>
@@ -817,6 +817,15 @@
# is run on a Google Compute Engine VM. A pipeline can be created with the
# `create` method and then later run with the `run` method, or a pipeline can
# be defined and run all at once with the `run` method.
+ "name": "A String", # Required. A user specified pipeline name that does not have to be unique.
+ # This name can be used for filtering Pipelines in ListPipelines.
+ "pipelineId": "A String", # Unique pipeline id that is generated by the service when CreatePipeline
+ # is called. Cannot be specified in the Pipeline used in the
+ # CreatePipelineRequest, and will be populated in the response to
+ # CreatePipeline and all subsequent Get and List calls. Indicates that the
+ # service has registered this pipeline.
+ "projectId": "A String", # Required. The project in which to create the pipeline. The caller must have
+ # WRITE access.
"outputParameters": [ # Output parameters of the pipeline.
{ # Parameters facilitate setting and delivering data into the
# pipeline's execution environment. They are defined at create time,
@@ -930,8 +939,6 @@
},
],
"docker": { # The Docker execuctor specification. # Specifies the docker run information.
- "imageName": "A String", # Required. Image name from either Docker Hub or Google Container Registry.
- # Users that run pipelines must have READ access to the image.
"cmd": "A String", # Required. The command or newline delimited script to run. The command
# string will be executed within a bash shell.
#
@@ -940,6 +947,8 @@
# `error` field will be populated.
#
# Maximum command string length is 16384.
+ "imageName": "A String", # Required. Image name from either Docker Hub or Google Container Registry.
+ # Users that run pipelines must have READ access to the image.
},
"description": "A String", # User-specified description.
"inputParameters": [ # Input parameters of the pipeline.
@@ -1062,15 +1071,14 @@
#
# *
# minimumRamGb
+ "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
"preemptible": True or False, # Whether to use preemptible VMs. Defaults to `false`. In order to use this,
# must be true for both create time and run time. Cannot be true at run time
# if false at create time.
- "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
"zones": [ # List of Google Compute Engine availability zones to which resource
# creation will restricted. If empty, any zone may be chosen.
"A String",
],
- "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
"acceleratorCount": "A String", # Optional. The number of accelerators of the specified type to attach.
# By specifying this parameter, you will download and install the following
# third-party software onto your managed Compute Engine instances:
@@ -1081,6 +1089,7 @@
# Tesla® drivers and NVIDIA® CUDA toolkit.
# Please see https://cloud.google.com/compute/docs/gpus/ for a list of
# available accelerator types.
+ "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
"noAddress": True or False, # Whether to assign an external IP to the instance. This is an experimental
# feature that may go away. Defaults to false.
# Corresponds to `--no_address` flag for [gcloud compute instances create]
@@ -1095,6 +1104,14 @@
# IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips).
"disks": [ # Disks to attach.
{ # A Google Compute Engine disk resource specification.
+ "name": "A String", # Required. The name of the disk that can be used in the pipeline
+ # parameters. Must be 1 - 63 characters.
+ # The name "boot" is reserved for system use.
+ "type": "A String", # Required. The type of the disk to create.
+ "autoDelete": True or False, # Deprecated. Disks created by the Pipelines API will be deleted at the end
+ # of the pipeline run, regardless of what this field is set to.
+ "sizeGb": 42, # The size of the disk. Defaults to 500 (GB).
+ # This field is not applicable for local SSD.
"mountPoint": "A String", # Required at create time and cannot be overridden at run time.
# Specifies the path in the docker container where files on
# this disk should be located. For example, if `mountPoint`
@@ -1110,27 +1127,10 @@
# and
# https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots
# for more details.
- "name": "A String", # Required. The name of the disk that can be used in the pipeline
- # parameters. Must be 1 - 63 characters.
- # The name "boot" is reserved for system use.
- "type": "A String", # Required. The type of the disk to create.
- "autoDelete": True or False, # Deprecated. Disks created by the Pipelines API will be deleted at the end
- # of the pipeline run, regardless of what this field is set to.
- "sizeGb": 42, # The size of the disk. Defaults to 500 (GB).
- # This field is not applicable for local SSD.
},
],
"bootDiskSizeGb": 42, # The size of the boot disk. Defaults to 10 (GB).
},
- "name": "A String", # Required. A user specified pipeline name that does not have to be unique.
- # This name can be used for filtering Pipelines in ListPipelines.
- "projectId": "A String", # Required. The project in which to create the pipeline. The caller must have
- # WRITE access.
- "pipelineId": "A String", # Unique pipeline id that is generated by the service when CreatePipeline
- # is called. Cannot be specified in the Pipeline used in the
- # CreatePipelineRequest, and will be populated in the response to
- # CreatePipeline and all subsequent Get and List calls. Indicates that the
- # service has registered this pipeline.
}</pre>
</div>
@@ -1153,6 +1153,8 @@
{ # Stores the information that the controller will fetch from the
# server in order to run. Should only be used by VMs created by the
# Pipelines Service and not by end users.
+ "machineType": "A String",
+ "cmd": "A String",
"vars": {
"a_key": "A String",
},
@@ -1175,27 +1177,25 @@
"disks": {
"a_key": "A String",
},
- "machineType": "A String",
- "cmd": "A String",
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(namePrefix=None, pageToken=None, pageSize=None, projectId=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(pageToken=None, pageSize=None, projectId=None, namePrefix=None, x__xgafv=None)</code>
<pre>Lists pipelines.
Caller must have READ permission to the project.
Args:
- namePrefix: string, Pipelines with names that match this prefix should be
-returned. If unspecified, all pipelines in the project, up to
-`pageSize`, will be returned.
pageToken: string, Token to use to indicate where to start getting results.
If unspecified, returns the first page of results.
pageSize: integer, Number of pipelines to return at once. Defaults to 256, and max
is 2048.
projectId: string, Required. The name of the project to search for pipelines. Caller
must have READ access to this project.
+ namePrefix: string, Pipelines with names that match this prefix should be
+returned. If unspecified, all pipelines in the project, up to
+`pageSize`, will be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -1209,6 +1209,7 @@
# exist, then `nextPageToken` will be populated and should be
# used as the `pageToken` argument to a subsequent ListPipelines
# request.
+ "nextPageToken": "A String", # The token to use to get the next page of results.
"pipelines": [ # The matched pipelines.
{ # The pipeline object. Represents a transformation from a set of input
# parameters to a set of output parameters. The transformation is defined
@@ -1216,6 +1217,15 @@
# is run on a Google Compute Engine VM. A pipeline can be created with the
# `create` method and then later run with the `run` method, or a pipeline can
# be defined and run all at once with the `run` method.
+ "name": "A String", # Required. A user specified pipeline name that does not have to be unique.
+ # This name can be used for filtering Pipelines in ListPipelines.
+ "pipelineId": "A String", # Unique pipeline id that is generated by the service when CreatePipeline
+ # is called. Cannot be specified in the Pipeline used in the
+ # CreatePipelineRequest, and will be populated in the response to
+ # CreatePipeline and all subsequent Get and List calls. Indicates that the
+ # service has registered this pipeline.
+ "projectId": "A String", # Required. The project in which to create the pipeline. The caller must have
+ # WRITE access.
"outputParameters": [ # Output parameters of the pipeline.
{ # Parameters facilitate setting and delivering data into the
# pipeline's execution environment. They are defined at create time,
@@ -1329,8 +1339,6 @@
},
],
"docker": { # The Docker execuctor specification. # Specifies the docker run information.
- "imageName": "A String", # Required. Image name from either Docker Hub or Google Container Registry.
- # Users that run pipelines must have READ access to the image.
"cmd": "A String", # Required. The command or newline delimited script to run. The command
# string will be executed within a bash shell.
#
@@ -1339,6 +1347,8 @@
# `error` field will be populated.
#
# Maximum command string length is 16384.
+ "imageName": "A String", # Required. Image name from either Docker Hub or Google Container Registry.
+ # Users that run pipelines must have READ access to the image.
},
"description": "A String", # User-specified description.
"inputParameters": [ # Input parameters of the pipeline.
@@ -1461,15 +1471,14 @@
#
# *
# minimumRamGb
+ "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
"preemptible": True or False, # Whether to use preemptible VMs. Defaults to `false`. In order to use this,
# must be true for both create time and run time. Cannot be true at run time
# if false at create time.
- "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
"zones": [ # List of Google Compute Engine availability zones to which resource
# creation will restricted. If empty, any zone may be chosen.
"A String",
],
- "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
"acceleratorCount": "A String", # Optional. The number of accelerators of the specified type to attach.
# By specifying this parameter, you will download and install the following
# third-party software onto your managed Compute Engine instances:
@@ -1480,6 +1489,7 @@
# Tesla® drivers and NVIDIA® CUDA toolkit.
# Please see https://cloud.google.com/compute/docs/gpus/ for a list of
# available accelerator types.
+ "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
"noAddress": True or False, # Whether to assign an external IP to the instance. This is an experimental
# feature that may go away. Defaults to false.
# Corresponds to `--no_address` flag for [gcloud compute instances create]
@@ -1494,6 +1504,14 @@
# IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips).
"disks": [ # Disks to attach.
{ # A Google Compute Engine disk resource specification.
+ "name": "A String", # Required. The name of the disk that can be used in the pipeline
+ # parameters. Must be 1 - 63 characters.
+ # The name "boot" is reserved for system use.
+ "type": "A String", # Required. The type of the disk to create.
+ "autoDelete": True or False, # Deprecated. Disks created by the Pipelines API will be deleted at the end
+ # of the pipeline run, regardless of what this field is set to.
+ "sizeGb": 42, # The size of the disk. Defaults to 500 (GB).
+ # This field is not applicable for local SSD.
"mountPoint": "A String", # Required at create time and cannot be overridden at run time.
# Specifies the path in the docker container where files on
# this disk should be located. For example, if `mountPoint`
@@ -1509,30 +1527,12 @@
# and
# https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots
# for more details.
- "name": "A String", # Required. The name of the disk that can be used in the pipeline
- # parameters. Must be 1 - 63 characters.
- # The name "boot" is reserved for system use.
- "type": "A String", # Required. The type of the disk to create.
- "autoDelete": True or False, # Deprecated. Disks created by the Pipelines API will be deleted at the end
- # of the pipeline run, regardless of what this field is set to.
- "sizeGb": 42, # The size of the disk. Defaults to 500 (GB).
- # This field is not applicable for local SSD.
},
],
"bootDiskSizeGb": 42, # The size of the boot disk. Defaults to 10 (GB).
},
- "name": "A String", # Required. A user specified pipeline name that does not have to be unique.
- # This name can be used for filtering Pipelines in ListPipelines.
- "projectId": "A String", # Required. The project in which to create the pipeline. The caller must have
- # WRITE access.
- "pipelineId": "A String", # Unique pipeline id that is generated by the service when CreatePipeline
- # is called. Cannot be specified in the Pipeline used in the
- # CreatePipelineRequest, and will be populated in the response to
- # CreatePipeline and all subsequent Get and List calls. Indicates that the
- # service has registered this pipeline.
},
],
- "nextPageToken": "A String", # The token to use to get the next page of results.
}</pre>
</div>
@@ -1579,12 +1579,6 @@
# Compute Engine) will be used.
"clientId": "A String", # This field is deprecated. Use `labels` instead. Client-specified pipeline
# operation identifier.
- "inputs": { # Pipeline input arguments; keys are defined in the pipeline documentation.
- # All input parameters that do not have default values must be specified.
- # If parameters with defaults are specified here, the defaults will be
- # overridden.
- "a_key": "A String",
- },
"serviceAccount": { # A Google Cloud Service Account. # The Google Cloud Service Account that will be used to access data and
# services. By default, the compute service account associated with
# `projectId` is used.
@@ -1601,16 +1595,11 @@
"A String",
],
},
- "logging": { # The logging options for the pipeline run. # Required. Logging options. Used by the service to communicate results
- # to the user.
- "gcsPath": "A String", # The location in Google Cloud Storage to which the pipeline logs
- # will be copied. Can be specified as a fully qualified directory
- # path, in which case logs will be output with a unique identifier
- # as the filename in that directory, or as a fully specified path,
- # which must end in `.log`, in which case that path will be
- # used, and the user must ensure that logs are not
- # overwritten. Stdout and stderr logs from the run are also
- # generated and output as `-stdout.log` and `-stderr.log`.
+ "inputs": { # Pipeline input arguments; keys are defined in the pipeline documentation.
+ # All input parameters that do not have default values must be specified.
+ # If parameters with defaults are specified here, the defaults will be
+ # overridden.
+ "a_key": "A String",
},
"labels": { # Labels to apply to this pipeline run. Labels will also be applied to
# compute resources (VM, disks) created by this pipeline run. When listing
@@ -1625,22 +1614,29 @@
# be a dash.
"a_key": "A String",
},
- "outputs": { # Pipeline output arguments; keys are defined in the pipeline
- # documentation. All output parameters of without default values
- # must be specified. If parameters with defaults are specified
- # here, the defaults will be overridden.
- "a_key": "A String",
+ "logging": { # The logging options for the pipeline run. # Required. Logging options. Used by the service to communicate results
+ # to the user.
+ "gcsPath": "A String", # The location in Google Cloud Storage to which the pipeline logs
+ # will be copied. Can be specified as a fully qualified directory
+ # path, in which case logs will be output with a unique identifier
+ # as the filename in that directory, or as a fully specified path,
+ # which must end in `.log`, in which case that path will be
+ # used, and the user must ensure that logs are not
+ # overwritten. Stdout and stderr logs from the run are also
+ # generated and output as `-stdout.log` and `-stderr.log`.
},
+ "keepVmAliveOnFailureDuration": "A String", # How long to keep the VM up after a failure (for example docker command
+ # failed, copying input or output files failed, etc). While the VM is up, one
+ # can ssh into the VM to debug. Default is 0; maximum allowed value is 1 day.
"resources": { # The system resources for the pipeline run. # Specifies resource requirements/overrides for the pipeline run.
+ "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
"preemptible": True or False, # Whether to use preemptible VMs. Defaults to `false`. In order to use this,
# must be true for both create time and run time. Cannot be true at run time
# if false at create time.
- "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
"zones": [ # List of Google Compute Engine availability zones to which resource
# creation will restricted. If empty, any zone may be chosen.
"A String",
],
- "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
"acceleratorCount": "A String", # Optional. The number of accelerators of the specified type to attach.
# By specifying this parameter, you will download and install the following
# third-party software onto your managed Compute Engine instances:
@@ -1651,6 +1647,7 @@
# Tesla® drivers and NVIDIA® CUDA toolkit.
# Please see https://cloud.google.com/compute/docs/gpus/ for a list of
# available accelerator types.
+ "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
"noAddress": True or False, # Whether to assign an external IP to the instance. This is an experimental
# feature that may go away. Defaults to false.
# Corresponds to `--no_address` flag for [gcloud compute instances create]
@@ -1665,6 +1662,14 @@
# IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips).
"disks": [ # Disks to attach.
{ # A Google Compute Engine disk resource specification.
+ "name": "A String", # Required. The name of the disk that can be used in the pipeline
+ # parameters. Must be 1 - 63 characters.
+ # The name "boot" is reserved for system use.
+ "type": "A String", # Required. The type of the disk to create.
+ "autoDelete": True or False, # Deprecated. Disks created by the Pipelines API will be deleted at the end
+ # of the pipeline run, regardless of what this field is set to.
+ "sizeGb": 42, # The size of the disk. Defaults to 500 (GB).
+ # This field is not applicable for local SSD.
"mountPoint": "A String", # Required at create time and cannot be overridden at run time.
# Specifies the path in the docker container where files on
# this disk should be located. For example, if `mountPoint`
@@ -1680,21 +1685,16 @@
# and
# https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots
# for more details.
- "name": "A String", # Required. The name of the disk that can be used in the pipeline
- # parameters. Must be 1 - 63 characters.
- # The name "boot" is reserved for system use.
- "type": "A String", # Required. The type of the disk to create.
- "autoDelete": True or False, # Deprecated. Disks created by the Pipelines API will be deleted at the end
- # of the pipeline run, regardless of what this field is set to.
- "sizeGb": 42, # The size of the disk. Defaults to 500 (GB).
- # This field is not applicable for local SSD.
},
],
"bootDiskSizeGb": 42, # The size of the boot disk. Defaults to 10 (GB).
},
- "keepVmAliveOnFailureDuration": "A String", # How long to keep the VM up after a failure (for example docker command
- # failed, copying input or output files failed, etc). While the VM is up, one
- # can ssh into the VM to debug. Default is 0; maximum allowed value is 1 day.
+ "outputs": { # Pipeline output arguments; keys are defined in the pipeline
+ # documentation. All output parameters of without default values
+ # must be specified. If parameters with defaults are specified
+ # here, the defaults will be overridden.
+ "a_key": "A String",
+ },
},
"pipelineId": "A String", # The already created pipeline to run.
"ephemeralPipeline": { # The pipeline object. Represents a transformation from a set of input # A new pipeline object to run once and then delete.
@@ -1703,6 +1703,15 @@
# is run on a Google Compute Engine VM. A pipeline can be created with the
# `create` method and then later run with the `run` method, or a pipeline can
# be defined and run all at once with the `run` method.
+ "name": "A String", # Required. A user specified pipeline name that does not have to be unique.
+ # This name can be used for filtering Pipelines in ListPipelines.
+ "pipelineId": "A String", # Unique pipeline id that is generated by the service when CreatePipeline
+ # is called. Cannot be specified in the Pipeline used in the
+ # CreatePipelineRequest, and will be populated in the response to
+ # CreatePipeline and all subsequent Get and List calls. Indicates that the
+ # service has registered this pipeline.
+ "projectId": "A String", # Required. The project in which to create the pipeline. The caller must have
+ # WRITE access.
"outputParameters": [ # Output parameters of the pipeline.
{ # Parameters facilitate setting and delivering data into the
# pipeline's execution environment. They are defined at create time,
@@ -1816,8 +1825,6 @@
},
],
"docker": { # The Docker execuctor specification. # Specifies the docker run information.
- "imageName": "A String", # Required. Image name from either Docker Hub or Google Container Registry.
- # Users that run pipelines must have READ access to the image.
"cmd": "A String", # Required. The command or newline delimited script to run. The command
# string will be executed within a bash shell.
#
@@ -1826,6 +1833,8 @@
# `error` field will be populated.
#
# Maximum command string length is 16384.
+ "imageName": "A String", # Required. Image name from either Docker Hub or Google Container Registry.
+ # Users that run pipelines must have READ access to the image.
},
"description": "A String", # User-specified description.
"inputParameters": [ # Input parameters of the pipeline.
@@ -1948,15 +1957,14 @@
#
# *
# minimumRamGb
+ "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
"preemptible": True or False, # Whether to use preemptible VMs. Defaults to `false`. In order to use this,
# must be true for both create time and run time. Cannot be true at run time
# if false at create time.
- "minimumRamGb": 3.14, # The minimum amount of RAM to use. Defaults to 3.75 (GB)
"zones": [ # List of Google Compute Engine availability zones to which resource
# creation will restricted. If empty, any zone may be chosen.
"A String",
],
- "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
"acceleratorCount": "A String", # Optional. The number of accelerators of the specified type to attach.
# By specifying this parameter, you will download and install the following
# third-party software onto your managed Compute Engine instances:
@@ -1967,6 +1975,7 @@
# Tesla® drivers and NVIDIA® CUDA toolkit.
# Please see https://cloud.google.com/compute/docs/gpus/ for a list of
# available accelerator types.
+ "minimumCpuCores": 42, # The minimum number of cores to use. Defaults to 1.
"noAddress": True or False, # Whether to assign an external IP to the instance. This is an experimental
# feature that may go away. Defaults to false.
# Corresponds to `--no_address` flag for [gcloud compute instances create]
@@ -1981,6 +1990,14 @@
# IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips).
"disks": [ # Disks to attach.
{ # A Google Compute Engine disk resource specification.
+ "name": "A String", # Required. The name of the disk that can be used in the pipeline
+ # parameters. Must be 1 - 63 characters.
+ # The name "boot" is reserved for system use.
+ "type": "A String", # Required. The type of the disk to create.
+ "autoDelete": True or False, # Deprecated. Disks created by the Pipelines API will be deleted at the end
+ # of the pipeline run, regardless of what this field is set to.
+ "sizeGb": 42, # The size of the disk. Defaults to 500 (GB).
+ # This field is not applicable for local SSD.
"mountPoint": "A String", # Required at create time and cannot be overridden at run time.
# Specifies the path in the docker container where files on
# this disk should be located. For example, if `mountPoint`
@@ -1996,27 +2013,10 @@
# and
# https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots
# for more details.
- "name": "A String", # Required. The name of the disk that can be used in the pipeline
- # parameters. Must be 1 - 63 characters.
- # The name "boot" is reserved for system use.
- "type": "A String", # Required. The type of the disk to create.
- "autoDelete": True or False, # Deprecated. Disks created by the Pipelines API will be deleted at the end
- # of the pipeline run, regardless of what this field is set to.
- "sizeGb": 42, # The size of the disk. Defaults to 500 (GB).
- # This field is not applicable for local SSD.
},
],
"bootDiskSizeGb": 42, # The size of the boot disk. Defaults to 10 (GB).
},
- "name": "A String", # Required. A user specified pipeline name that does not have to be unique.
- # This name can be used for filtering Pipelines in ListPipelines.
- "projectId": "A String", # Required. The project in which to create the pipeline. The caller must have
- # WRITE access.
- "pipelineId": "A String", # Unique pipeline id that is generated by the service when CreatePipeline
- # is called. Cannot be specified in the Pipeline used in the
- # CreatePipelineRequest, and will be populated in the response to
- # CreatePipeline and all subsequent Get and List calls. Indicates that the
- # service has registered this pipeline.
},
}
@@ -2030,12 +2030,6 @@
{ # 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.
- },
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example&#58; `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
@@ -2044,6 +2038,7 @@
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
@@ -2053,11 +2048,16 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
"metadata": { # An OperationMetadata or 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.
+ "response": { # An Empty object.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
}</pre>
</div>
@@ -2073,7 +2073,6 @@
{ # Request to set operation status. Should only be used by VMs
# created by the Pipelines Service and not by end users.
- "operationId": "A String",
"errorMessage": "A String",
"validationToken": "A String",
"errorCode": "A String",
@@ -2084,6 +2083,7 @@
"description": "A String", # String indicating the type of event
},
],
+ "operationId": "A String",
}
x__xgafv: string, V1 error format.