Blame - docs/dyn/remotebuildexecution_v1alpha.projects.instances.html - platform/external/python/google-api-python-client

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

[diff] [blame^]

83

<code><a href="#close">close()</a></code></p>

84

<p class="firstline">Close httplib2 connections.</p>

85

Dan O'Meara

dd49464

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

[diff] [blame]

86

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

Dmitry Frenkel

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

[diff] [blame^]

87

<p class="firstline">Creates a new instance in the specified region. Returns a long running operation which contains an instance on completion. While the long running operation is in progress, any call to `GetInstance` returns an instance in state `CREATING`.</p>

Bu Sun Kim

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

[diff] [blame]

88

89

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

Dmitry Frenkel

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

[diff] [blame^]

90

<p class="firstline">Deletes the specified instance. Returns a long running operation which contains a `google.protobuf.Empty` response on completion. Deleting an instance with worker pools in it will delete these worker pools.</p>

Bu Sun Kim

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

[diff] [blame]

91

92

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

93

<p class="firstline">Returns the specified instance.</p>

94

95

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

96

<p class="firstline">Lists instances in a project.</p>

Dmitry Frenkel

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

[diff] [blame^]

97

98

<code><a href="#patch">patch(name, body=None, name1=None, loggingEnabled=None, updateMask=None, x__xgafv=None)</a></code></p>

99

<p class="firstline">Updates the specified instance. Returns a long running operation which contains the updated instance in the response on completion.</p>

Bu Sun Kim

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

[diff] [blame]

100

<h3>Method Details</h3>

101

Dmitry Frenkel

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

[diff] [blame^]

102

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

103

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

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

[diff] [blame]

107

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

Dmitry Frenkel

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

[diff] [blame^]

108

<pre>Creates a new instance in the specified region. Returns a long running operation which contains an instance on completion. While the long running operation is in progress, any call to `GetInstance` returns an instance in state `CREATING`.

Bu Sun Kim

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

[diff] [blame]

109

110

Args:

Dmitry Frenkel

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

[diff] [blame^]

111

parent: string, Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`. (required)

Dan O'Meara

dd49464

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

[diff] [blame]

112

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

113

The object takes the form of:

114

115

{ # The request used for `CreateInstance`.

Dmitry Frenkel

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

[diff] [blame^]

116

"instanceId": "A String", # ID of the created instance. A valid `instance_id` must: be 6-50 characters long, contain only lowercase letters, digits, hyphens and underscores, start with a lowercase letter, and end with a lowercase letter or a digit.

117

"parent": "A String", # Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`.

118

"instance": { # Instance conceptually encapsulates all Remote Build Execution resources for remote builds. An instance consists of storage and compute resources (for example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for running remote builds. All Remote Build Execution API calls are scoped to an instance. # Specifies the instance to create. The name in the instance, if specified in the instance, is ignored.

119

"featurePolicy": { # FeaturePolicy defines features allowed to be used on RBE instances, as well as instance-wide behavior changes that take effect without opt-in or opt-out at usage time. # The policy to define whether or not RBE features can be used or how they can be used.

120

"dockerSiblingContainers": { # Defines whether a feature can be used or what values are accepted. # Whether dockerSiblingContainers can be used.

121

"policy": "A String", # The policy of the feature.

122

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

"dockerRuntime": { # Defines whether a feature can be used or what values are accepted. # Whether dockerRuntime is allowed to be set or what runtimes are allowed. Note linux_isolation takes precedence, and if set, docker_runtime values may be rejected if they are incompatible with the selected isolation.

127

"policy": "A String", # The policy of the feature.

128

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

"linuxIsolation": "A String", # linux_isolation allows overriding the docker runtime used for containers started on Linux.

133

"dockerAddCapabilities": { # Defines whether a feature can be used or what values are accepted. # Whether dockerAddCapabilities can be used or what capabilities are allowed.

134

"policy": "A String", # The policy of the feature.

135

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

"dockerPrivileged": { # Defines whether a feature can be used or what values are accepted. # Whether dockerPrivileged can be used.

140

"policy": "A String", # The policy of the feature.

141

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

"dockerChrootPath": { # Defines whether a feature can be used or what values are accepted. # Whether dockerChrootPath can be used.

146

"policy": "A String", # The policy of the feature.

147

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

"dockerNetwork": { # Defines whether a feature can be used or what values are accepted. # Whether dockerNetwork can be used or what network modes are allowed. E.g. one may allow `off` value only via `allowed_values`.

152

"policy": "A String", # The policy of the feature.

153

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

"dockerRunAsRoot": { # Defines whether a feature can be used or what values are accepted. # Whether dockerRunAsRoot can be used.

158

"policy": "A String", # The policy of the feature.

159

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

"containerImageSources": { # Defines whether a feature can be used or what values are accepted. # Which container image sources are allowed. Currently only RBE-supported registry (gcr.io) is allowed. One can allow all repositories under a project or one specific repository only. E.g. container_image_sources { policy: RESTRICTED allowed_values: [ "gcr.io/project-foo", "gcr.io/project-bar/repo-baz", ] } will allow any repositories under "gcr.io/project-foo" plus the repository "gcr.io/project-bar/repo-baz". Default (UNSPECIFIED) is equivalent to any source is allowed.

164

"policy": "A String", # The policy of the feature.

165

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

},

Bu Sun Kim

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

[diff] [blame]

170

"loggingEnabled": True or False, # Output only. Whether stack driver logging is enabled for the instance.

Bu Sun Kim

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

[diff] [blame]

171

"state": "A String", # Output only. State of the instance.

Dmitry Frenkel

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

[diff] [blame^]

172

"name": "A String", # Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be populated when creating an instance since it is provided in the `instance_id` field.

173

"location": "A String", # The location is a GCP region. Currently only `us-central1` is supported.

Bu Sun Kim

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

[diff] [blame]

174

},

Bu Sun Kim

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

[diff] [blame]

175

}

176

177

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

184

Dmitry Frenkel

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

[diff] [blame^]

185

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

186

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

187

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

188

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

189

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

190

},

191

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

192

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

193

},

194

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

195

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

196

"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

4ed7d3f

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

[diff] [blame]

197

{

198

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

199

},

200

],

Dmitry Frenkel

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

[diff] [blame^]

201

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

Bu Sun Kim

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

[diff] [blame]

202

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

Dmitry Frenkel

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

[diff] [blame^]

208

<pre>Deletes the specified instance. Returns a long running operation which contains a `google.protobuf.Empty` response on completion. Deleting an instance with worker pools in it will delete these worker pools.

Bu Sun Kim

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

[diff] [blame]

209

210

Args:

Dmitry Frenkel

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

[diff] [blame^]

211

name: string, Name of the instance to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. (required)

Bu Sun Kim

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

[diff] [blame]

212

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

219

Dmitry Frenkel

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

[diff] [blame^]

220

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

221

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

222

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

223

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

224

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

225

},

226

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

227

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

228

},

229

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

230

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

231

"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

4ed7d3f

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

[diff] [blame]

232

{

233

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

234

},

235

],

Dmitry Frenkel

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

[diff] [blame^]

236

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

Bu Sun Kim

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

[diff] [blame]

237

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

243

<pre>Returns the specified instance.

244

245

Args:

Dmitry Frenkel

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

[diff] [blame^]

246

name: string, Name of the instance to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. (required)

Bu Sun Kim

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

[diff] [blame]

247

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

254

Dmitry Frenkel

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

[diff] [blame^]

255

{ # Instance conceptually encapsulates all Remote Build Execution resources for remote builds. An instance consists of storage and compute resources (for example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for running remote builds. All Remote Build Execution API calls are scoped to an instance.

256

"featurePolicy": { # FeaturePolicy defines features allowed to be used on RBE instances, as well as instance-wide behavior changes that take effect without opt-in or opt-out at usage time. # The policy to define whether or not RBE features can be used or how they can be used.

257

"dockerSiblingContainers": { # Defines whether a feature can be used or what values are accepted. # Whether dockerSiblingContainers can be used.

258

"policy": "A String", # The policy of the feature.

259

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

"dockerRuntime": { # Defines whether a feature can be used or what values are accepted. # Whether dockerRuntime is allowed to be set or what runtimes are allowed. Note linux_isolation takes precedence, and if set, docker_runtime values may be rejected if they are incompatible with the selected isolation.

264

"policy": "A String", # The policy of the feature.

265

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

"linuxIsolation": "A String", # linux_isolation allows overriding the docker runtime used for containers started on Linux.

270

"dockerAddCapabilities": { # Defines whether a feature can be used or what values are accepted. # Whether dockerAddCapabilities can be used or what capabilities are allowed.

271

"policy": "A String", # The policy of the feature.

272

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

"dockerPrivileged": { # Defines whether a feature can be used or what values are accepted. # Whether dockerPrivileged can be used.

277

"policy": "A String", # The policy of the feature.

278

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

"dockerChrootPath": { # Defines whether a feature can be used or what values are accepted. # Whether dockerChrootPath can be used.

283

"policy": "A String", # The policy of the feature.

284

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

"dockerNetwork": { # Defines whether a feature can be used or what values are accepted. # Whether dockerNetwork can be used or what network modes are allowed. E.g. one may allow `off` value only via `allowed_values`.

289

"policy": "A String", # The policy of the feature.

290

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

"dockerRunAsRoot": { # Defines whether a feature can be used or what values are accepted. # Whether dockerRunAsRoot can be used.

295

"policy": "A String", # The policy of the feature.

296

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

"containerImageSources": { # Defines whether a feature can be used or what values are accepted. # Which container image sources are allowed. Currently only RBE-supported registry (gcr.io) is allowed. One can allow all repositories under a project or one specific repository only. E.g. container_image_sources { policy: RESTRICTED allowed_values: [ "gcr.io/project-foo", "gcr.io/project-bar/repo-baz", ] } will allow any repositories under "gcr.io/project-foo" plus the repository "gcr.io/project-bar/repo-baz". Default (UNSPECIFIED) is equivalent to any source is allowed.

301

"policy": "A String", # The policy of the feature.

302

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

},

Bu Sun Kim

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

[diff] [blame]

307

"loggingEnabled": True or False, # Output only. Whether stack driver logging is enabled for the instance.

Bu Sun Kim

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

[diff] [blame]

308

"state": "A String", # Output only. State of the instance.

Dmitry Frenkel

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

[diff] [blame^]

309

"name": "A String", # Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be populated when creating an instance since it is provided in the `instance_id` field.

310

"location": "A String", # The location is a GCP region. Currently only `us-central1` is supported.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

316

<pre>Lists instances in a project.

317

318

Args:

Dmitry Frenkel

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

[diff] [blame^]

319

parent: string, Resource name of the project. Format: `projects/[PROJECT_ID]`. (required)

Bu Sun Kim

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

[diff] [blame]

320

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

327

328

{

Bu Sun Kim

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

[diff] [blame]

329

"instances": [ # The list of instances in a given project.

Dmitry Frenkel

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

[diff] [blame^]

330

{ # Instance conceptually encapsulates all Remote Build Execution resources for remote builds. An instance consists of storage and compute resources (for example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for running remote builds. All Remote Build Execution API calls are scoped to an instance.

331

"featurePolicy": { # FeaturePolicy defines features allowed to be used on RBE instances, as well as instance-wide behavior changes that take effect without opt-in or opt-out at usage time. # The policy to define whether or not RBE features can be used or how they can be used.

332

"dockerSiblingContainers": { # Defines whether a feature can be used or what values are accepted. # Whether dockerSiblingContainers can be used.

333

"policy": "A String", # The policy of the feature.

334

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

"dockerRuntime": { # Defines whether a feature can be used or what values are accepted. # Whether dockerRuntime is allowed to be set or what runtimes are allowed. Note linux_isolation takes precedence, and if set, docker_runtime values may be rejected if they are incompatible with the selected isolation.

339

"policy": "A String", # The policy of the feature.

340

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

"linuxIsolation": "A String", # linux_isolation allows overriding the docker runtime used for containers started on Linux.

345

"dockerAddCapabilities": { # Defines whether a feature can be used or what values are accepted. # Whether dockerAddCapabilities can be used or what capabilities are allowed.

346

"policy": "A String", # The policy of the feature.

347

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

"dockerPrivileged": { # Defines whether a feature can be used or what values are accepted. # Whether dockerPrivileged can be used.

352

"policy": "A String", # The policy of the feature.

353

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

"dockerChrootPath": { # Defines whether a feature can be used or what values are accepted. # Whether dockerChrootPath can be used.

358

"policy": "A String", # The policy of the feature.

359

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

"dockerNetwork": { # Defines whether a feature can be used or what values are accepted. # Whether dockerNetwork can be used or what network modes are allowed. E.g. one may allow `off` value only via `allowed_values`.

364

"policy": "A String", # The policy of the feature.

365

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

"dockerRunAsRoot": { # Defines whether a feature can be used or what values are accepted. # Whether dockerRunAsRoot can be used.

370

"policy": "A String", # The policy of the feature.

371

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

"containerImageSources": { # Defines whether a feature can be used or what values are accepted. # Which container image sources are allowed. Currently only RBE-supported registry (gcr.io) is allowed. One can allow all repositories under a project or one specific repository only. E.g. container_image_sources { policy: RESTRICTED allowed_values: [ "gcr.io/project-foo", "gcr.io/project-bar/repo-baz", ] } will allow any repositories under "gcr.io/project-foo" plus the repository "gcr.io/project-bar/repo-baz". Default (UNSPECIFIED) is equivalent to any source is allowed.

376

"policy": "A String", # The policy of the feature.

377

"allowedValues": [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.

"A String",

],

},

},

Bu Sun Kim

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

[diff] [blame]

382

"loggingEnabled": True or False, # Output only. Whether stack driver logging is enabled for the instance.

Bu Sun Kim

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

[diff] [blame]

383

"state": "A String", # Output only. State of the instance.

Dmitry Frenkel

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

[diff] [blame^]

384

"name": "A String", # Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be populated when creating an instance since it is provided in the `instance_id` field.

385

"location": "A String", # The location is a GCP region. Currently only `us-central1` is supported.

Bu Sun Kim