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

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

[diff] [blame]

84

<p class="firstline">Batch gets the update history of assets that overlap a time window.</p>

85

Dan O'Meara

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

[diff] [blame]

86

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

Bu Sun Kim

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

[diff] [blame]

87

<p class="firstline">Exports assets with time and resource types to a given Cloud Storage</p>

88

<h3>Method Details</h3>

89

Bu Sun Kim

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

[diff] [blame]

90

<code class="details" id="batchGetAssetsHistory">batchGetAssetsHistory(parent, contentType=None, readTimeWindow_endTime=None, readTimeWindow_startTime=None, assetNames=None, x__xgafv=None)</code>

Bu Sun Kim

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

[diff] [blame]

91

<pre>Batch gets the update history of assets that overlap a time window.

92

For RESOURCE content, this API outputs history with asset in both

93

non-delete or deleted status.

94

For IAM_POLICY content, this API outputs history when the asset and its

95

attached IAM POLICY both exist. This can create gaps in the output history.

96

If a specified asset does not exist, this API returns an INVALID_ARGUMENT

error.

Args:

parent: string, Required. The relative name of the root asset. It can only be an

Bu Sun Kim

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

[diff] [blame]

101

organization number (such as "organizations/123"), a project ID (such as

102

"projects/my-project-id")", or a project number (such as "projects/12345"). (required)

Dan O'Meara

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

[diff] [blame]

103

contentType: string, Optional. The content type.

Bu Sun Kim

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

[diff] [blame]

104

readTimeWindow_endTime: string, End time of the time window (inclusive).

105

Current timestamp if not specified.

106

readTimeWindow_startTime: string, Start time of the time window (exclusive).

Bu Sun Kim

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

[diff] [blame]

107

assetNames: string, A list of the full names of the assets. For example:

108

`//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.

109

See [Resource

110

Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)

111

for more info.

112

113

The request becomes a no-op if the asset name list is empty, and the max

114

size of the asset name list is 100 in one request. (repeated)

Bu Sun Kim

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

[diff] [blame]

115

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

122

123

{ # Batch get assets history response.

Bu Sun Kim

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

[diff] [blame]

124

"assets": [ # A list of assets with valid time windows.

Bu Sun Kim

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

[diff] [blame]

125

{ # Temporal asset. In addition to the asset, the temporal asset includes the

126

# status of the asset and valid from and to time of it.

Bu Sun Kim

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

[diff] [blame]

127

"deleted": True or False, # If the asset is deleted or not.

128

"window": { # A time window of (start_time, end_time]. # The time window when the asset data and state was observed.

Bu Sun Kim

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

[diff] [blame]

129

"startTime": "A String", # Start time of the time window (exclusive).

Bu Sun Kim

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

[diff] [blame]

130

"endTime": "A String", # End time of the time window (inclusive).

Bu Sun Kim

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

[diff] [blame]

131

# Current timestamp if not specified.

Bu Sun Kim

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

[diff] [blame]

132

},

Bu Sun Kim

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

[diff] [blame]

133

"asset": { # Cloud asset. This includes all Google Cloud Platform resources, # Asset.

Bu Sun Kim

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

[diff] [blame]

134

# Cloud IAM policies, and other non-GCP assets.

Bu Sun Kim

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

[diff] [blame]

135

"resource": { # Representation of a cloud resource. # Representation of the resource.

136

"version": "A String", # The API version. Example: "v1".

137

"data": { # The content of the resource, in which some sensitive fields are scrubbed

138

# away and may not be present.

139

"a_key": "", # Properties of the object.

140

},

141

"discoveryDocumentUri": "A String", # The URL of the discovery document containing the resource's JSON schema.

142

# For example:

143

# `"https://www.googleapis.com/discovery/v1/apis/compute/v1/rest"`.

144

# It will be left unspecified for resources without a discovery-based API,

145

# such as Cloud Bigtable.

146

"parent": "A String", # The full name of the immediate parent of this resource. See

147

# [Resource

148

# Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)

149

# for more information.

150

#

151

# For GCP assets, it is the parent resource defined in the [Cloud IAM policy

152

# hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy).

153

# For example:

154

# `"//cloudresourcemanager.googleapis.com/projects/my_project_123"`.

155

#

156

# For third-party assets, it is up to the users to define.

157

"resourceUrl": "A String", # The REST URL for accessing the resource. An HTTP GET operation using this

158

# URL returns the resource itself.

159

# Example:

160

# `https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123`.

161

# It will be left unspecified for resources without a REST API.

162

"discoveryName": "A String", # The JSON schema name listed in the discovery document.

163

# Example: "Project". It will be left unspecified for resources (such as

164

# Cloud Bigtable) without a discovery-based API.

165

},

166

"assetType": "A String", # Type of the asset. Example: "google.compute.Disk".

Bu Sun Kim

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

[diff] [blame]

167

"name": "A String", # The full name of the asset. For example:

168

# `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.

169

# See [Resource

170

# Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)

171

# for more information.

172

"iamPolicy": { # An Identity and Access Management (IAM) policy, which specifies access # Representation of the actual Cloud IAM policy set on a cloud resource. For

Bu Sun Kim

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

[diff] [blame]

173

# each resource, there must be at most one Cloud IAM policy set on it.

Dan O'Meara

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

[diff] [blame]

174

# controls for Google Cloud resources.

Bu Sun Kim

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

[diff] [blame]

175

#

176

#

Dan O'Meara

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

[diff] [blame]

177

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

178

# `members` to a single `role`. Members can be user accounts, service accounts,

179

# Google groups, and domains (such as G Suite). A `role` is a named list of

180

# permissions; each `role` can be an IAM predefined role or a user-created

181

# custom role.

Bu Sun Kim

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

[diff] [blame]

182

#

Bu Sun Kim

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

[diff] [blame]

183

# For some types of Google Cloud resources, a `binding` can also specify a

184

# `condition`, which is a logical expression that allows access to a resource

185

# only if the expression evaluates to `true`. A condition can add constraints

186

# based on attributes of the request, the resource, or both. To learn which

187

# resources support conditions in their IAM policies, see the

188

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

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

[diff] [blame]

189

#

190

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

191

#

192

# {

Bu Sun Kim

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

[diff] [blame]

193

# "bindings": [

Bu Sun Kim

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

[diff] [blame]

194

# {

Bu Sun Kim

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

[diff] [blame]

195

# "role": "roles/resourcemanager.organizationAdmin",

196

# "members": [

197

# "user:mike@example.com",

198

# "group:admins@example.com",

199

# "domain:google.com",

200

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Bu Sun Kim

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

[diff] [blame]

201

# ]

202

# },

203

# {

Bu Sun Kim

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

[diff] [blame]

204

# "role": "roles/resourcemanager.organizationViewer",

Bu Sun Kim

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

[diff] [blame]

205

# "members": [

206

# "user:eve@example.com"

207

# ],

Bu Sun Kim

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

[diff] [blame]

208

# "condition": {

209

# "title": "expirable access",

210

# "description": "Does not grant access after Sep 2020",

211

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

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

[diff] [blame]

212

# }

Bu Sun Kim

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

[diff] [blame]

213

# }

Dan O'Meara

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

[diff] [blame]

214

# ],

Bu Sun Kim

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

[diff] [blame]

215

# "etag": "BwWWja0YfJA=",

216

# "version": 3

Bu Sun Kim

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

[diff] [blame]

217

# }

218

#

Dan O'Meara

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

[diff] [blame]

219

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

224

# - group:admins@example.com

225

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

226

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

227

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

228

# - members:

Dan O'Meara

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

[diff] [blame]

229

# - user:eve@example.com

230

# role: roles/resourcemanager.organizationViewer

231

# condition:

232

# title: expirable access

233

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

234

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

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

[diff] [blame]

235

# - etag: BwWWja0YfJA=

236

# - version: 3

Bu Sun Kim

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

[diff] [blame]

237

#

238

# For a description of IAM and its features, see the

Dan O'Meara

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

[diff] [blame]

239

# [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

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

[diff] [blame]

240

"version": 42, # Specifies the format of the policy.

Bu Sun Kim

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

[diff] [blame]

241

#

Dan O'Meara

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

[diff] [blame]

242

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value

243

# are rejected.

244

#

245

# Any operation that affects conditional role bindings must specify version

246

# `3`. This requirement applies to the following operations:

247

#

248

# * Getting a policy that includes a conditional role binding

249

# * Adding a conditional role binding to a policy

250

# * Changing a conditional role binding in a policy

251

# * Removing any role binding, with or without a condition, from a policy

252

# that includes conditions

253

#

254

# **Important:** If you use IAM Conditions, you must include the `etag` field

255

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

256

# you to overwrite a version `3` policy with a version `1` policy, and all of

257

# the conditions in the version `3` policy are lost.

258

#

259

# If a policy does not include any conditions, operations on that policy may

260

# specify any valid version or leave the field unset.

Bu Sun Kim

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

[diff] [blame]

261

#

262

# To learn which resources support conditions in their IAM policies, see the

263

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

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

[diff] [blame]

264

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

265

{ # Specifies the audit configuration for a service.

266

# The configuration determines which permission types are logged, and what

267

# identities, if any, are exempted from logging.

268

# An AuditConfig must have one or more AuditLogConfigs.

269

#

270

# If there are AuditConfigs for both `allServices` and a specific service,

271

# the union of the two AuditConfigs is used for that service: the log_types

272

# specified in each AuditConfig are enabled, and the exempted_members in each

273

# AuditLogConfig are exempted.

274

#

275

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

281

# "audit_log_configs": [

282

# {

283

# "log_type": "DATA_READ",

284

# "exempted_members": [

285

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

290

# },

291

# {

292

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com"

298

# "audit_log_configs": [

299

# {

300

# "log_type": "DATA_READ",

301

# },

302

# {

303

# "log_type": "DATA_WRITE",

304

# "exempted_members": [

305

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

314

# logging. It also exempts jose@example.com from DATA_READ logging, and

315

# aliya@example.com from DATA_WRITE logging.

316

"service": "A String", # Specifies a service that will be enabled for audit logging.

317

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

318

# `allServices` is a special value that covers all services.

319

"auditLogConfigs": [ # The configuration for logging of each type of permission.

320

{ # Provides the configuration for logging a type of permissions.

# Example:

#

# {

# "audit_log_configs": [

325

# {

326

# "log_type": "DATA_READ",

327

# "exempted_members": [

328

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

338

# jose@example.com from DATA_READ logging.

339

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

340

# permission.

341

# Follows the same format of Binding.members.

342

"A String",

343

],

344

"logType": "A String", # The log type that this config enables.

},

],

},

],

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

Dan O'Meara

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

[diff] [blame]

350

# `condition` that determines how and when the `bindings` are applied. Each

351

# of the `bindings` must contain at least one member.

Bu Sun Kim

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

[diff] [blame]

352

{ # Associates `members` with a `role`.

Bu Sun Kim

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

[diff] [blame]

353

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

Bu Sun Kim

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

[diff] [blame]

354

# `members` can have the following values:

355

#

356

# * `allUsers`: A special identifier that represents anyone who is

357

# on the internet; with or without a Google account.

358

#

359

# * `allAuthenticatedUsers`: A special identifier that represents anyone

360

# who is authenticated with a Google account or a service account.

361

#

362

# * `user:{emailid}`: An email address that represents a specific Google

Dan O'Meara

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

[diff] [blame]

363

# account. For example, `alice@example.com` .

Bu Sun Kim

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

[diff] [blame]

364

#

365

#

366

# * `serviceAccount:{emailid}`: An email address that represents a service

367

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

368

#

369

# * `group:{emailid}`: An email address that represents a Google group.

370

# For example, `admins@example.com`.

371

#

Dan O'Meara

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

[diff] [blame]

372

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

373

# identifier) representing a user that has been recently deleted. For

374

# example, `alice@example.com?uid=123456789012345678901`. If the user is

375

# recovered, this value reverts to `user:{emailid}` and the recovered user

376

# retains the role in the binding.

377

#

378

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

379

# unique identifier) representing a service account that has been recently

380

# deleted. For example,

381

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

382

# If the service account is undeleted, this value reverts to

383

# `serviceAccount:{emailid}` and the undeleted service account retains the

384

# role in the binding.

385

#

386

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

387

# identifier) representing a Google group that has been recently

388

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

389

# the group is recovered, this value reverts to `group:{emailid}` and the

390

# recovered group retains the role in the binding.

391

#

Bu Sun Kim

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

[diff] [blame]

392

#

393

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

394

# users of that domain. For example, `google.com` or `example.com`.

395

#

Bu Sun Kim

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

[diff] [blame]

396

"A String",

Bu Sun Kim

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

[diff] [blame]

397

],

Bu Sun Kim

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

[diff] [blame]

398

"role": "A String", # Role that is assigned to `members`.

399

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

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

[diff] [blame]

400

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

401

#

402

# If the condition evaluates to `true`, then this binding applies to the

403

# current request.

404

#

405

# If the condition evaluates to `false`, then this binding does not apply to

406

# the current request. However, a different role binding might grant the same

407

# role to one or more of the members in this binding.

408

#

409

# To learn which resources support conditions in their IAM policies, see the

410

# [IAM

411

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

412

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

413

# are documented at https://github.com/google/cel-spec.

414

#

415

# Example (Comparison):

416

#

417

# title: "Summary size limit"

418

# description: "Determines if a summary is less than 100 chars"

419

# expression: "document.summary.size() < 100"

420

#

421

# Example (Equality):

422

#

423

# title: "Requestor is owner"

424

# description: "Determines if requestor is the document owner"

425

# expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents"

430

# description: "Determine whether the document should be publicly visible"

431

# expression: "document.type != 'private' && document.type != 'internal'"

432

#

433

# Example (Data Manipulation):

434

#

435

# title: "Notification string"

436

# description: "Create a notification string with a timestamp."

437

# expression: "'New message received at ' + string(document.create_time)"

438

#

439

# The exact variables and functions that may be referenced within an expression

440

# are determined by the service that evaluates it. See the service

441

# documentation for additional information.

442

"expression": "A String", # Textual representation of an expression in Common Expression Language

443

# syntax.

444

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

445

# its purpose. This can be used e.g. in UIs which allow to enter the

446

# expression.

447

"location": "A String", # Optional. String indicating the location of the expression for error

448

# reporting, e.g. a file name and a position in the file.

449

"description": "A String", # Optional. Description of the expression. This is a longer text which

450

# describes the expression, e.g. when hovered over it in a UI.

451

},

Bu Sun Kim

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

[diff] [blame]

452

},

453

],

Bu Sun Kim

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

[diff] [blame]

454

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

Dan O'Meara

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

[diff] [blame]

455

# prevent simultaneous updates of a policy from overwriting each other.

456

# It is strongly suggested that systems make use of the `etag` in the

457

# read-modify-write cycle to perform policy updates in order to avoid race

458

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

459

# systems are expected to put that etag in the request to `setIamPolicy` to

460

# ensure that their change will be applied to the same version of the policy.

461

#

462

# **Important:** If you use IAM Conditions, you must include the `etag` field

463

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

464

# you to overwrite a version `3` policy with a version `1` policy, and all of

465

# the conditions in the version `3` policy are lost.

Bu Sun Kim

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

[diff] [blame]

466

},

Bu Sun Kim

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

[diff] [blame]

},

},

],

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

474

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

Bu Sun Kim

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

[diff] [blame]

475

<pre>Exports assets with time and resource types to a given Cloud Storage

476

location. The output format is newline-delimited JSON.

477

This API implements the google.longrunning.Operation API allowing you

Bu Sun Kim

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

[diff] [blame]

478

to keep track of the export. We recommend intervals of at least 2 seconds

479

with exponential retry to poll the export operation result. For

480

regular-size resource parent, the export operation usually finishes within

481

5 minutes.

Bu Sun Kim

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

[diff] [blame]

482

483

Args:

484

parent: string, Required. The relative name of the root asset. This can only be an

Bu Sun Kim

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

[diff] [blame]

485

organization number (such as "organizations/123"), a project ID (such as

486

"projects/my-project-id"), a project number (such as "projects/12345"), or

487

a folder number (such as "folders/123"). (required)

Dan O'Meara

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

[diff] [blame]

488

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

489

The object takes the form of:

490

491

{ # Export asset request.

Bu Sun Kim

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

[diff] [blame]

492

"assetTypes": [ # A list of asset types of which to take a snapshot for. For example:

493

# "google.compute.Disk". If specified, only matching assets will be returned.

494

# See [Introduction to Cloud Asset

495

# Inventory](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview)

496

# for all supported asset types.

497

"A String",

498

],

Bu Sun Kim

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

[diff] [blame]

499

"readTime": "A String", # Timestamp to take an asset snapshot. This can only be set to a timestamp

Bu Sun Kim

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

[diff] [blame]

500

# between 2018-10-02 UTC (inclusive) and the current time. If not specified,

501

# the current time will be used. Due to delays in resource data collection

502

# and indexing, there is a volatile window during which running the same

503

# query may get different results.

Bu Sun Kim

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

[diff] [blame]

504

"contentType": "A String", # Asset content type. If not specified, no content but the asset name will be

505

# returned.

506

"outputConfig": { # Output configuration for export assets destination. # Required. Output configuration indicating where the results will be output

507

# to. All results will be in newline delimited JSON format.

508

"gcsDestination": { # A Cloud Storage location. # Destination on Cloud Storage.

509

"uri": "A String", # The uri of the Cloud Storage object. It's the same uri that is used by

510

# gsutil. For example: "gs://bucket_name/object_name". See [Viewing and

511

# Editing Object

512

# Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata)

513

# for more information.

514

"uriPrefix": "A String", # The uri prefix of all generated Cloud Storage objects. For example:

515

# "gs://bucket_name/object_name_prefix". Each object uri is in format:

516

# "gs://bucket_name/object_name_prefix/<asset type>/<shard number> and only

517

# contains assets for that type. <shard number> starts from 0. For example:

518

# "gs://bucket_name/object_name_prefix/google.compute.disk/0" is the first

519

# shard of output objects containing all google.compute.disk assets.

520

# An INVALID_ARGUMENT error will be returned if file with the same name

521

# "gs://bucket_name/object_name_prefix" already exists.

522

},

523

},

Bu Sun Kim

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

[diff] [blame]

524

}

525

526

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

533

534

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

535

# network API call.

Bu Sun Kim

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

[diff] [blame]

536

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

537

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

538

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

539

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

540

#

541

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

542

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

543

"message": "A String", # A developer-facing error message, which should be in English. Any

544

# user-facing error message should be localized and sent in the

545

# google.rpc.Status.details field, or localized by the client.

546

"details": [ # A list of messages that carry the error details. There is a common set of

547

# message types for APIs to use.

548

{

549

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

550

},

551

],

552

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

553

},

554

"metadata": { # Service-specific metadata associated with the operation. It typically

555

# contains progress information and common metadata such as create time.

556

# Some services might not provide such metadata. Any method that returns a

557

# long-running operation should document the metadata type, if any.

558

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

559

},

560

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

561

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

562

# available.

Bu Sun Kim

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

[diff] [blame]

563

"response": { # The normal response of the operation in case of success. If the original

Bu Sun Kim

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

[diff] [blame]

564

# method returns no data on success, such as `Delete`, the response is

565

# `google.protobuf.Empty`. If the original method is standard

566

# `Get`/`Create`/`Update`, the response should be the resource. For other

567

# methods, the response should have the type `XxxResponse`, where `Xxx`

568

# is the original method name. For example, if the original method name

569

# is `TakeSnapshot()`, the inferred response type is

570

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

571

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

Bu Sun Kim

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

[diff] [blame]

572

},

Bu Sun Kim

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

[diff] [blame]

573

"name": "A String", # The server-assigned name, which is only unique within the same service that

Bu Sun Kim

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

[diff] [blame]

574

# originally returns it. If you use the default HTTP mapping, the

Dan O'Meara

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

[diff] [blame]

575

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim