Blame - docs/dyn/genomics_v2alpha1.pipelines.html - platform/external/python/google-api-python-client

2019-06-14 16:50:42 -0700

[diff] [blame]

83

<h3>Method Details</h3>

84

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

85

<code class="details" id="close">close()</code>

86

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

90

<code class="details" id="run">run(body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

91

<pre>Runs a pipeline. The returned Operation's metadata field will contain a google.genomics.v2alpha1.Metadata object describing the status of the pipeline execution. The [response] field will contain a google.genomics.v2alpha1.RunPipelineResponse object if the pipeline completes successfully. **Note:** Before you can use this method, the Genomics Service Agent must have access to your project. This is done automatically when the Cloud Genomics API is first enabled, but if you delete this permission, or if you enabled the Cloud Genomics API before the v2alpha1 API launch, you must disable and re-enable the API to grant the Genomics Service Agent the required permissions. Authorization requires the following [Google IAM](https://cloud.google.com/iam/) permission: * `genomics.operations.create` [1]: /genomics/gsa

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

92

93

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

94

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

95

The object takes the form of:

96

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

97

{ # The arguments to the `RunPipeline` method. The requesting user must have the `iam.serviceAccounts.actAs` permission for the Cloud Genomics service account or the request will fail.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

98

"pipeline": { # Specifies a series of actions to execute, expressed as Docker containers. # Required. The description of the pipeline to run.

99

"actions": [ # The list of actions to execute, in the order they are specified.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

100

{ # Specifies a single action that runs a Docker container.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

101

"entrypoint": "A String", # If specified, overrides the `ENTRYPOINT` specified in the container.

102

"labels": { # Labels to associate with the action. This field is provided to assist workflow engine authors in identifying actions (for example, to indicate what sort of action they perform, such as localization or debugging). They are returned in the operation metadata, but are otherwise ignored.

103

"a_key": "A String",

104

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

105

"commands": [ # If specified, overrides the `CMD` specified in the container. If the container also has an `ENTRYPOINT` the values are used as entrypoint arguments. Otherwise, they are used as a command and arguments to run inside the container.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

106

"A String",

107

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

108

"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.

109

"name": "A String", # An optional name for the container. The container hostname will be set to this name, making it useful for inter-container communication. The name must contain only upper and lowercase alphanumeric characters and hypens and cannot start with a hyphen.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

110

"environment": { # The environment to pass into the container. This environment is merged with values specified in the google.genomics.v2alpha1.Pipeline message, overwriting any duplicate values. In addition to the values passed here, a few other values are automatically injected into the environment. These cannot be hidden or overwritten. `GOOGLE_PIPELINE_FAILED` will be set to "1" if the pipeline failed because an action has exited with a non-zero status (and did not have the `IGNORE_EXIT_STATUS` flag set). This can be used to determine if additional debug or logging actions should execute. `GOOGLE_LAST_EXIT_STATUS` will be set to the exit status of the last non-background action that executed. This can be used by workflow engine authors to determine whether an individual action has succeeded or failed.

111

"a_key": "A String",

112

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

113

"imageUri": "A String", # Required. The URI to pull the container image from. Note that all images referenced by actions in the pipeline are pulled before the first action runs. If multiple actions reference the same image, it is only pulled once, ensuring that the same image is used for all actions in a single pipeline. The image URI can be either a complete host and image specification (e.g., quay.io/biocontainers/samtools), a library and image name (e.g., google/cloud-sdk) or a bare image name ('bash') to pull from the default library. No schema is required in any of these cases. If the specified image is not public, the service account specified for the Virtual Machine must have access to pull the images from GCR, or appropriate credentials must be specified in the google.genomics.v2alpha1.Action.credentials field.

114

"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. - /google/logs All logs written during the pipeline execution. - /google/logs/output The combined standard output and standard error of all actions run as part of the pipeline execution. - /google/logs/action/*/stdout The complete contents of each individual action's standard output. - /google/logs/action/*/stderr The complete contents of each individual action's standard error output.

115

{ # Carries information about a particular disk mount inside a container.

116

"path": "A String", # The path to mount the disk inside the container.

117

"readOnly": True or False, # If true, the disk is mounted read-only inside the container.

118

"disk": "A String", # The name of the disk to mount, as specified in the resources section.

119

},

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

120

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

121

"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.

122

"portMappings": { # A map of containers to host port mappings for this container. If the container already specifies exposed ports, use the `PUBLISH_EXPOSED_PORTS` flag instead. The host port number must be less than 65536. If it is zero, an unused random port is assigned. To determine the resulting port number, consult the `ContainerStartedEvent` in the operation metadata.

123

"a_key": 42,

124

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

125

"credentials": { # Holds encrypted information that is only decrypted and stored in RAM by the worker VM when running the pipeline. # 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. The secret must decrypt to a JSON-encoded dictionary containing both `username` and `password` keys.

126

"keyName": "A String", # The name of the Cloud KMS key that will be used to decrypt the secret value. The VM service account must have the required permissions and authentication scopes to invoke the `decrypt` method on the specified key.

127

"cipherText": "A String", # The value of the cipherText response from the `encrypt` method. This field is intentionally unaudited.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

128

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

129

"flags": [ # The set of flags to apply to this action.

130

"A String",

131

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

132

},

133

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

134

"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 will be set to DEADLINE_EXCEEDED. If unspecified, it will default to 7 days.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

135

"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).

136

"a_key": "A String",

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

137

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

138

"resources": { # The system resources for the pipeline run. At least one zone or region must be specified or the pipeline run will fail. # The resources required for execution.

139

"virtualMachine": { # Carries information about a Compute Engine VM resource. # The virtual machine specification.

140

"network": { # VM networking options. # The VM network configuration.

141

"usePrivateAddress": True or False, # If set to true, do not attach a public IP address to the VM. Note that without a public IP address, additional configuration is required to allow the VM to access Google services. See https://cloud.google.com/vpc/docs/configure-private-google-access for more information.

142

"name": "A String", # The network name to attach the VM's network interface to. The value will be prefixed with `global/networks/` unless it contains a `/`, in which case it is assumed to be a fully specified network resource URL. If unspecified, the global default network is used.

143

"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. The value is prefixed with `regions/*/subnetworks/` unless it contains a `/`, in which case it is assumed to be a fully specified subnetwork resource URL. If the `*` character appears in the value, it is replaced with the region that the virtual machine has been allocated in.

144

},

145

"bootDiskSizeGb": 42, # The size of the boot disk, in GB. The boot disk must be large enough to accommodate all of the Docker images from each action in the pipeline at the same time. If not specified, a small but reasonable default value is used.

146

"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.

147

"email": "A String", # Email address of the service account. If not specified, the default Compute Engine service account for the project will be used.

148

"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",

],

},

"volumes": [ # The list of disks and other storage to create or attach to the VM.

153

{ # Carries information about storage that can be attached to a VM.

154

"existingDisk": { # Configuration for an existing disk to be attached to the VM. # Configuration for a existing disk.

155

"disk": "A String", # If `disk` contains slashes, the Cloud Life Sciences API assumes that it is a complete URL for the disk. If `disk` does not contain slashes, the Cloud Life Sciences API assumes that the disk is a zonal disk and a URL will be generated of the form `zones//disks/`, where `` is the zone in which the instance is allocated. The disk must be ext4 formatted. If all `Mount` references to this disk have the `read_only` flag set to true, the disk will be attached in `read-only` mode and can be shared with other instances. Otherwise, the disk will be available for writing but cannot be shared.

156

},

157

"persistentDisk": { # Configuration for a persistent disk to be attached to the VM. See https://cloud.google.com/compute/docs/disks/performance for more information about disk type, size, and performance considerations. # Configuration for a persistent disk.

158

"sourceImage": "A String", # An image to put on the disk before attaching it to the VM.

159

"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.

160

"type": "A String", # The Compute Engine disk type. If unspecified, `pd-standard` is used.

161

},

162

"volume": "A String", # A user-supplied name for the volume. Used when mounting the volume into `Actions`. The name must contain only upper and lowercase alphanumeric characters and hyphens and cannot start with a hyphen.

163

"nfsMount": { # Configuration for an `NFSMount` to be attached to the VM. # Configuration for an NFS mount.

164

"target": "A String", # A target NFS mount. The target must be specified as `address:/mount".

},

},

],

"preemptible": True or False, # If true, allocate a preemptible VM.

169

"labels": { # Optional set of labels to apply to the VM and any attached disk resources. These labels must adhere to the [name and value restrictions](https://cloud.google.com/compute/docs/labeling-resources) on VM labels imposed by Compute Engine. Labels keys with the prefix 'google-' are reserved for use by Google. Labels applied at creation time to the VM. Applied on a best-effort basis to attached disk resources shortly after VM creation.

170

"a_key": "A String",

171

},

172

"disks": [ # The list of disks to create and attach to the VM.

173

{ # 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.

174

"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.

175

"type": "A String", # The Compute Engine disk type. If unspecified, `pd-standard` is used.

176

"sourceImage": "A String", # An optional image to put on the disk before attaching it to the VM.

177

"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 hypens and cannot start with a hyphen.

178

},

179

],

180

"cpuPlatform": "A String", # The CPU platform to request. An instance based on a newer platform can be allocated, but never one with fewer capabilities. The value of this parameter must be a valid Compute Engine CPU platform name (such as "Intel Skylake"). This parameter is only useful for carefully optimized work loads where the CPU platform has a significant impact. For more information about the effect of this parameter, see https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.

181

"dockerCacheImages": [ # The Compute Engine Disk Images to use as a Docker cache. The disks will be mounted into the Docker folder in a way that the images present in the cache will not need to be pulled. The digests of the cached images must match those of the tags used or the latest version will still be pulled. The root directory of the ext4 image must contain `image` and `overlay2` directories copied from the Docker directory of a VM where the desired Docker images have already been pulled. Only a single image is supported.

182

"A String",

183

],

184

"enableStackdriverMonitoring": True or False, # Whether Stackdriver monitoring should be enabled on the VM.

185

"accelerators": [ # The list of accelerators to attach to the VM.

186

{ # Carries information about an accelerator that can be attached to a VM.

187

"count": "A String", # How many accelerators of this type to attach.

188

"type": "A String", # The accelerator type string (for example, "nvidia-tesla-k80"). Only NVIDIA GPU accelerators are currently supported. If an NVIDIA GPU is attached, the required runtime libraries will be made available to all containers under `/usr/local/nvidia`. The driver version to install must be specified using the NVIDIA driver version parameter on the virtual machine specification. Note that attaching a GPU increases the worker VM startup time by a few minutes.

189

},

190

],

191

"machineType": "A String", # Required. The machine type of the virtual machine to create. Must be the short name of a standard machine type (such as "n1-standard-1") or a custom machine type (such as "custom-1-4096", where "1" indicates the number of vCPUs and "4096" indicates the memory in MB). See [Creating an instance with a custom machine type](https://cloud.google.com/compute/docs/instances/creating-instance-with-custom-machine-type#create) for more specifications on creating a custom machine type.

192

"nvidiaDriverVersion": "A String", # The NVIDIA driver version to use when attaching an NVIDIA GPU accelerator. The version specified here must be compatible with the GPU libraries contained in the container being executed, and must be one of the drivers hosted in the `nvidia-drivers-us-public` bucket on Google Cloud Storage.

193

"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`.

194

},

195

"regions": [ # The list of regions allowed for VM allocation. If set, the `zones` field must not be set.

196

"A String",

197

],

198

"zones": [ # The list of zones allowed for VM allocation. If set, the `regions` field must not be set.

199

"A String",

200

],

201

"projectId": "A String", # The project ID to allocate resources in.

202

},

203

},

204

"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`).

205

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

216

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

217

{ # This resource represents a long-running operation that is the result of a network API call.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

218

"metadata": { # An OperationMetadata or Metadata object. This will always be returned with the Operation.

219

"a_key": "", # Properties of the object. Contains field @type with type URL.

220

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

221

"response": { # An Empty object.

222

"a_key": "", # Properties of the object. Contains field @type with type URL.

223

},

224

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

225

"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.

226

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. 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). # The error result of the operation in case of failure or cancellation.

227

"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.

228

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

229

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim