Blame - docs/dyn/lifesciences_v2beta.projects.locations.pipelines.html - platform/external/python/google-api-python-client

<h1><a href="lifesciences_v2beta.html">Cloud Life Sciences API</a> . <a href="lifesciences_v2beta.projects.html">projects</a> . <a href="lifesciences_v2beta.projects.locations.html">locations</a> . <a href="lifesciences_v2beta.projects.locations.pipelines.html">pipelines</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#run">run(parent, body=None, x__xgafv=None)</a></code></p>

79

<p class="firstline">Runs a pipeline. The returned Operation's metadata field will contain a</p>

80

<h3>Method Details</h3>

81

82

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

83

<pre>Runs a pipeline. The returned Operation's metadata field will contain a

84

google.cloud.lifesciences.v2beta.Metadata object describing the status

85

of the pipeline execution. The

86

response field will contain a

87

google.cloud.lifesciences.v2beta.RunPipelineResponse object if the

88

pipeline completes successfully.

89

90

**Note:** Before you can use this method, the *Life Sciences Service Agent*

91

must have access to your project. This is done automatically when the

92

Cloud Life Sciences API is first enabled, but if you delete this permission

93

you must disable and re-enable the API to grant the Life Sciences

94

Service Agent the required permissions.

95

Authorization requires the following [Google

96

IAM](https://cloud.google.com/iam/) permission:

97

98

* `lifesciences.workflows.run`

99

100

Args:

101

parent: string, The project and location that this request should be executed against. (required)

102

body: object, The request body.

103

The object takes the form of:

104

105

{ # The arguments to the `RunPipeline` method. The requesting user must have

106

# the `iam.serviceAccounts.actAs` permission for the Cloud Life Sciences

107

# service account or the request will fail.

Bu Sun Kim

6502091

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

[diff] [blame]

108

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

Bu Sun Kim

6502091

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

[diff] [blame]

109

"timeout": "A String", # The maximum amount of time to give the pipeline to complete. This includes

110

# the time spent waiting for a worker to be allocated. If the pipeline fails

111

# to complete before the timeout, it will be cancelled and the error code

112

# will be set to DEADLINE_EXCEEDED.

113

#

114

# If unspecified, it will default to 7 days.

115

"resources": { # The system resources for the pipeline run. # The resources required for execution.

116

#

117

# At least one zone or region must be specified or the pipeline run will fail.

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

118

"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

123

# must not be set.

124

"A String",

125

],

Bu Sun Kim

6502091

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

[diff] [blame]

126

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

127

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

128

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

129

#

130

# See https://cloud.google.com/compute/docs/disks/performance for more

131

# information about disk type, size, and performance considerations.

132

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

133

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

134

"sizeGb": 42, # The size, in GB, of the disk to attach. If the size is not

135

# specified, a default is chosen to ensure reasonable I/O performance.

136

#

137

# If the disk type is specified as `local-ssd`, multiple local drives are

138

# automatically combined to provide the requested size. Note, however, that

139

# each physical SSD is 375GB in size, and no more than 8 drives can be

140

# attached to a single instance.

141

"name": "A String", # A user-supplied name for the disk. Used when mounting the disk into

142

# actions. The name must contain only upper and lowercase alphanumeric

143

# characters and hyphens and cannot start with a hyphen.

144

},

145

],

146

"serviceAccount": { # Carries information about a Google Cloud service account. # The service account to install on the VM. This account does not need

147

# any permissions other than those required by the pipeline.

148

"email": "A String", # Email address of the service account. If not specified, the default

149

# Compute Engine service account for the project will be used.

150

"scopes": [ # List of scopes to be enabled for this service account on the VM, in

151

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

156

#

157

# Currently, only Container-Optimized OS images can be used.

158

#

159

# The default value is `projects/cos-cloud/global/images/family/cos-stable`,

160

# which selects the latest stable release of Container-Optimized OS.

161

#

162

# This option is provided to allow testing against the beta release of the

163

# operating system to ensure that the new version does not interact

164

# negatively with production pipelines.

165

#

166

# To test a pipeline against the beta release of Container-Optimized OS,

167

# use the value `projects/cos-cloud/global/images/family/cos-beta`.

Bu Sun Kim

6502091

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

[diff] [blame]

168

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

169

"subnetwork": "A String", # If the specified network is configured for custom subnet creation, the

170

# name of the subnetwork to attach the instance to must be specified here.

171

#

172

# The value is prefixed with `regions/*/subnetworks/` unless it contains a

173

# `/`, in which case it is assumed to be a fully specified subnetwork

174

# resource URL.

175

#

176

# If the `*` character appears in the value, it is replaced with the region

177

# that the virtual machine has been allocated in.

178

"network": "A String", # The network name to attach the VM's network interface to. The value will

179

# be prefixed with `global/networks/` unless it contains a `/`, in which

180

# case it is assumed to be a fully specified network resource URL.

181

#

182

# If unspecified, the global default network is used.

183

"usePrivateAddress": True or False, # If set to true, do not attach a public IP address to the VM. Note that

184

# without a public IP address, additional configuration is required to

185

# allow the VM to access Google services.

186

#

187

# See https://cloud.google.com/vpc/docs/configure-private-google-access

188

# for more information.

189

},

190

"bootDiskSizeGb": 42, # The size of the boot disk, in GB. The boot disk must be large

191

# enough to accommodate all of the Docker images from each action in the

192

# pipeline at the same time. If not specified, a small but reasonable

193

# default value is used.

194

"nvidiaDriverVersion": "A String", # The NVIDIA driver version to use when attaching an NVIDIA GPU accelerator.

195

# The version specified here must be compatible with the GPU libraries

196

# contained in the container being executed, and must be one of the drivers

197

# hosted in the `nvidia-drivers-us-public` bucket on Google Cloud Storage.

198

"labels": { # Optional set of labels to apply to the VM and any attached disk resources.

199

# These labels must adhere to the [name and value

200

# restrictions](https://cloud.google.com/compute/docs/labeling-resources) on

201

# VM labels imposed by Compute Engine.

202

#

203

# Labels keys with the prefix 'google-' are reserved for use by Google.

204

#

205

# Labels applied at creation time to the VM. Applied on a best-effort basis

206

# to attached disk resources shortly after VM creation.

207

"a_key": "A String",

208

},

209

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

210

"cpuPlatform": "A String", # The CPU platform to request. An instance based on a newer platform can be

211

# allocated, but never one with fewer capabilities. The value of this

212

# parameter must be a valid Compute Engine CPU platform name (such as "Intel

213

# Skylake"). This parameter is only useful for carefully optimized work

214

# loads where the CPU platform has a significant impact.

215

#

216

# For more information about the effect of this parameter, see

217

# https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.

218

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

219

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

220

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

221

"type": "A String", # The accelerator type string (for example, "nvidia-tesla-k80").

222

#

223

# Only NVIDIA GPU accelerators are currently supported. If an NVIDIA GPU is

224

# attached, the required runtime libraries will be made available to all

225

# containers under `/usr/local/nvidia`. The driver version to install must

226

# be specified using the NVIDIA driver version parameter on the virtual

227

# machine specification. Note that attaching a GPU increases the worker VM

228

# startup time by a few minutes.

229

},

230

],

231

"machineType": "A String", # Required. The machine type of the virtual machine to create. Must be the short name

232

# of a standard machine type (such as "n1-standard-1") or a custom machine

233

# type (such as "custom-1-4096", where "1" indicates the number of vCPUs and

234

# "4096" indicates the memory in MB). See

235

# [Creating an instance with a custom machine

236

# type](https://cloud.google.com/compute/docs/instances/creating-instance-with-custom-machine-type#create)

237

# for more specifications on creating a custom machine type.

238

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

Bu Sun Kim

6502091

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

[diff] [blame]

239

},

Bu Sun Kim

6502091

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

[diff] [blame]

240

},

241

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

242

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

Bu Sun Kim

6502091

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

[diff] [blame]

243

"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

244

# Container Registry, the credentials required to pull the image must be

245

# specified here as an encrypted secret.

246

#

247

# The secret must decrypt to a JSON-encoded dictionary containing both

248

# `username` and `password` keys.

249

# by the worker VM when running the pipeline.

250

"keyName": "A String", # The name of the Cloud KMS key that will be used to decrypt the secret

251

# value. The VM service account must have the required permissions and

252

# authentication scopes to invoke the `decrypt` method on the specified key.

253

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

254

# is intentionally unaudited.

255

},

256

"imageUri": "A String", # Required. The URI to pull the container image from. Note that all images referenced

257

# by actions in the pipeline are pulled before the first action runs. If

258

# multiple actions reference the same image, it is only pulled once,

259

# ensuring that the same image is used for all actions in a single pipeline.

260

#

261

# The image URI can be either a complete host and image specification (e.g.,

262

# quay.io/biocontainers/samtools), a library and image name (e.g.,

263

# google/cloud-sdk) or a bare image name ('bash') to pull from the default

264

# library. No schema is required in any of these cases.

265

#

266

# If the specified image is not public, the service account specified for

267

# the Virtual Machine must have access to pull the images from GCR, or

268

# appropriate credentials must be specified in the

269

# google.cloud.lifesciences.v2beta.Action.credentials field.

270

"commands": [ # If specified, overrides the `CMD` specified in the container. If the

271

# container also has an `ENTRYPOINT` the values are used as entrypoint

272

# arguments. Otherwise, they are used as a command and arguments to run

273

# inside the container.

274

"A String",

275

],

276

"ignoreExitStatus": True or False, # Normally, a non-zero exit status causes the pipeline to fail. This flag

277

# allows execution of other actions to continue instead.

278

"runInBackground": True or False, # This flag allows an action to continue running in the background while

279

# executing subsequent actions. This is useful to provide services to

280

# other actions (or to provide debugging support tools like SSH servers).

281

"enableFuse": True or False, # Enable access to the FUSE device for this action. Filesystems can then

282

# be mounted into disks shared with other actions. The other actions do

283

# not need the `enable_fuse` flag to access the mounted filesystem.

284

#

285

# This has the effect of causing the container to be executed with

286

# `CAP_SYS_ADMIN` and exposes `/dev/fuse` to the container, so use it only

287

# for containers you trust.

288

"labels": { # Labels to associate with the action. This field is provided to assist

289

# workflow engine authors in identifying actions (for example, to indicate

290

# what sort of action they perform, such as localization or debugging).

291

# They are returned in the operation metadata, but are otherwise ignored.

292

"a_key": "A String",

293

},

294

"portMappings": { # A map of containers to host port mappings for this container. If the

295

# container already specifies exposed ports, use the

296

# `PUBLISH_EXPOSED_PORTS` flag instead.

297

#

298

# The host port number must be less than 65536. If it is zero, an unused

299

# random port is assigned. To determine the resulting port number, consult

300

# the `ContainerStartedEvent` in the operation metadata.

301

"a_key": 42,

302

},

303

"environment": { # The environment to pass into the container. This environment is merged

304

# with values specified in the google.cloud.lifesciences.v2beta.Pipeline

305

# message, overwriting any duplicate values.

306

#

307

# In addition to the values passed here, a few other values are

308

# automatically injected into the environment. These cannot be hidden or

309

# overwritten.

310

#

311

# `GOOGLE_PIPELINE_FAILED` will be set to "1" if the pipeline failed

312

# because an action has exited with a non-zero status (and did not have the

313

# `IGNORE_EXIT_STATUS` flag set). This can be used to determine if additional

314

# debug or logging actions should execute.

315

#

316

# `GOOGLE_LAST_EXIT_STATUS` will be set to the exit status of the last

317

# non-background action that executed. This can be used by workflow engine

318

# authors to determine whether an individual action has succeeded or failed.

319

"a_key": "A String",

320

},

321

"containerName": "A String", # An optional name for the container. The container hostname will be set to

322

# this name, making it useful for inter-container communication. The name

323

# must contain only upper and lowercase alphanumeric characters and hyphens

324

# and cannot start with a hyphen.

325

"disableImagePrefetch": True or False, # All container images are typically downloaded before any actions are

326

# executed. This helps prevent typos in URIs or issues like lack of disk

327

# space from wasting large amounts of compute resources.

328

#

329

# If set, this flag prevents the worker from downloading the image until

330

# just before the action is executed.

331

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

332

"alwaysRun": True or False, # By default, after an action fails, no further actions are run. This flag

333

# indicates that this action must be run even if the pipeline has already

334

# failed. This is useful for actions that copy output files off of the VM

335

# or for debugging. Note that no actions will be run if image prefetching

336

# fails.

337

"disableStandardErrorCapture": True or False, # A small portion of the container's standard error stream is typically

338

# captured and returned inside the `ContainerStoppedEvent`. Setting this

339

# flag disables this functionality.

340

"pidNamespace": "A String", # An optional identifier for a PID namespace to run the action inside.

341

# Multiple actions should use the same string to share a namespace. If

342

# unspecified, a separate isolated namespace is used.

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

343

"mounts": [ # A list of mounts to make available to the action.

344

#

345

# In addition to the values specified here, every action has a special

346

# virtual disk mounted under `/google` that contains log files and other

347

# operational components.

348

#

349

# <ul>

350

# <li><code>/google/logs</code> All logs written during the pipeline

351

# execution.</li>

352

# <li><code>/google/logs/output</code> The combined standard output and

353

# standard error of all actions run as part of the pipeline

354

# execution.</li>

355

# <li><code>/google/logs/action/*/stdout</code> The complete contents of

356

# each individual action's standard output.</li>

357

# <li><code>/google/logs/action/*/stderr</code> The complete contents of

358

# each individual action's standard error output.</li>

359

# </ul>

360

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

361

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

362

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

363

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

364

},

365

],

366

"publishExposedPorts": True or False, # Exposes all ports specified by `EXPOSE` statements in the container. To

367

# discover the host side port numbers, consult the `ACTION_STARTED` event

368

# in the operation metadata.

369

"timeout": "A String", # The maximum amount of time to give the action to complete. If the action

370

# fails to complete before the timeout, it will be terminated and the exit

371

# status will be non-zero. The pipeline will continue or terminate based

372

# on the rules defined by the `ALWAYS_RUN` and `IGNORE_EXIT_STATUS` flags.

Bu Sun Kim

6502091

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

[diff] [blame]

373

},

374

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

375

"environment": { # The environment to pass into every action. Each action can also specify

376

# additional environment variables but cannot delete an entry from this map

377

# (though they can overwrite it with a different value).

"a_key": "A String",

},

},

"labels": { # User-defined labels to associate with the returned operation. These

382

# labels are not propagated to any Google Cloud Platform resources used by

383

# the operation, and can be modified at any time.

384

#

385

# To associate labels with resources created while executing the operation,

386

# see the appropriate resource message (for example, `VirtualMachine`).

387

"a_key": "A String",

Bu Sun Kim

6502091

2020-05-20 12:08:20 -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:

398

399

{ # This resource represents a long-running operation that is the result of a

400

# network API call.

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

401

"done": True or False, # If the value is `false`, it means the operation is still in progress.

402

# If `true`, the operation is completed, and either `error` or `response` is

403

# available.

Bu Sun Kim

6502091

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

[diff] [blame]

404

"response": { # An Empty object.

405

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

406

},

407

"name": "A String", # The server-assigned name for the operation. This may be passed to the other operation methods to retrieve information about the operation's status.

408

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

409

# different programming environments, including REST APIs and RPC APIs. It is

410

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

411

# three pieces of data: error code, error message, and error details.

412

#

413

# You can find out more about this error model and how to work with it in the

414

# [API Design Guide](https://cloud.google.com/apis/design/errors).