Blame - docs/dyn/run_v1.namespaces.domainmappings.html - platform/external/python/google-api-python-client

<h1><a href="run_v1.html">Cloud Run API</a> . <a href="run_v1.namespaces.html">namespaces</a> . <a href="run_v1.namespaces.domainmappings.html">domainmappings</a></h1>

76

<h2>Instance Methods</h2>

77

78

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

79

<p class="firstline">Create a new domain mapping.</p>

80

81

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

82

<p class="firstline">Delete a domain mapping.</p>

83

84

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

85

<p class="firstline">Get information about a domain mapping.</p>

86

87

<code><a href="#list">list(parent, labelSelector=None, fieldSelector=None, includeUninitialized=None, resourceVersion=None, continue=None, limit=None, watch=None, x__xgafv=None)</a></code></p>

88

<p class="firstline">List domain mappings.</p>

89

<h3>Method Details</h3>

90

91

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

92

<pre>Create a new domain mapping.

93

94

Args:

95

parent: string, The namespace in which the domain mapping should be created.

96

For Cloud Run (fully managed), replace {namespace_id} with the project ID

97

or number. (required)

98

body: object, The request body.

99

The object takes the form of:

100

101

{ # Resource to hold the state and status of a user's domain mapping.

102

"status": { # The current state of the Domain Mapping. # The current status of the DomainMapping.

103

"mappedRouteName": "A String", # The name of the route that the mapping currently points to.

104

"conditions": [ # Array of observed DomainMappingConditions, indicating the current state

105

# of the DomainMapping.

106

{ # Condition defines a generic condition for a Resource

107

"message": "A String", # Optional. Human readable message indicating details about the current status.

108

"lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another.

109

"status": "A String", # Status of the condition, one of True, False, Unknown.

110

"severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info

111

"reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition.

112

"type": "A String", # type is used to communicate the status of the reconciliation process.

113

# See also:

114

# https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting

115

# Types common to all resources include:

116

# * "Ready": True when the Resource is ready.

117

},

118

],

119

"observedGeneration": 42, # ObservedGeneration is the 'Generation' of the DomainMapping that

120

# was last processed by the controller.

121

#

122

# Clients polling for completed reconciliation should poll until

123

# observedGeneration = metadata.generation and the Ready condition's status

124

# is True or False.

125

"resourceRecords": [ # The resource records required to configure this domain mapping. These

126

# records must be added to the domain's DNS configuration in order to

127

# serve the application via this domain mapping.

128

{ # A DNS resource record.

129

"type": "A String", # Resource record type. Example: `AAAA`.

130

"rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035

131

# (section 5) and RFC 1034 (section 3.6.1).

132

"name": "A String", # Relative name of the object affected by this record. Only applicable for

133

# `CNAME` records. Example: 'www'.

},

],

},

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1".

138

"spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping.

139

"routeName": "A String", # The name of the Knative Route that this DomainMapping applies to.

140

# The route must exist.

141

"certificateMode": "A String", # The mode of the certificate.

142

"forceOverride": True or False, # If set, the mapping will override any mapping set before this spec was set.

143

# It is recommended that the user leaves this empty to receive an error

144

# warning about a potential conflict and only set it once the respective UI

145

# has given such a warning.

146

},

147

"kind": "A String", # The kind of resource, in this case "DomainMapping".

148

"metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this BuildTemplate.

149

# persisted resources must have, which includes all objects users must create.

150

"creationTimestamp": "A String", # (Optional)

151

#

152

# CreationTimestamp is a timestamp representing the server time when this

153

# object was created. It is not guaranteed to be set in happens-before order

154

# across separate operations. Clients may not set this value. It is

155

# represented in RFC3339 form and is in UTC.

156

#

157

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

# https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

162

"labels": { # (Optional)

163

#

164

# Map of string keys and values that can be used to organize and categorize

165

# (scope and select) objects. May match selectors of replication controllers

166

# and routes.

167

# More info: http://kubernetes.io/docs/user-guide/labels

168

"a_key": "A String",

169

},

170

"generation": 42, # (Optional)

171

#

172

# A sequence number representing a specific generation of the desired state.

173

# Populated by the system. Read-only.

174

"resourceVersion": "A String", # (Optional)

175

#

176

# An opaque value that represents the internal version of this object that

177

# can be used by clients to determine when objects have changed. May be used

178

# for optimistic concurrency, change detection, and the watch operation on a

179

# resource or set of resources. Clients must treat these values as opaque and

180

# passed unmodified back to the server. They may only be valid for a

181

# particular resource or set of resources.

182

#

183

# Populated by the system.

184

# Read-only.

185

# Value must be treated as opaque by clients and .

186

# More info:

187

# https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

188

"selfLink": "A String", # (Optional)

189

#

190

# SelfLink is a URL representing this object.

191

# Populated by the system.

192

# Read-only.

193

# string selfLink = 4;

194

"uid": "A String", # (Optional)

195

#

196

# UID is the unique in time and space value for this object. It is typically

197

# generated by the server on successful creation of a resource and is not

198

# allowed to change on PUT operations.

199

#

200

# Populated by the system.

201

# Read-only.

202

# More info: http://kubernetes.io/docs/user-guide/identifiers#uids

203

"namespace": "A String", # Namespace defines the space within each name must be unique, within a

204

# Cloud Run region. In Cloud Run the namespace must be equal to either the

205

# project ID or project number.

206

"annotations": { # (Optional)

207

#

208

# Annotations is an unstructured key value map stored with a resource that

209

# may be set by external tools to store and retrieve arbitrary metadata. They

210

# are not queryable and should be preserved when modifying objects. More

211

# info: http://kubernetes.io/docs/user-guide/annotations

212

"a_key": "A String",

213

},

214

"generateName": "A String", # (Optional)

215

#

216

# Cloud Run fully managed: not supported

217

#

218

# Cloud Run for Anthos: supported

219

#

220

# GenerateName is an optional prefix, used by the server, to generate a

221

# unique name ONLY IF the Name field has not been provided. If this field is

222

# used, the name returned to the client will be different than the name

223

# passed. This value will also be combined with a unique suffix. The provided

224

# value has the same validation rules as the Name field, and may be truncated

225

# by the length of the suffix required to make the value unique on the

226

# server.

227

#

228

# If this field is specified and the generated name exists, the server will

229

# NOT return a 409 - instead, it will either return 201 Created or 500 with

230

# Reason ServerTimeout indicating a unique name could not be found in the

231

# time allotted, and the client should retry (optionally after the time

232

# indicated in the Retry-After header).

233

#

234

# Applied only if Name is not specified.

235

# More info:

236

# https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency

237

# string generateName = 2;

238

"name": "A String", # Name must be unique within a namespace, within a Cloud Run region.

239

# Is required when creating

240

# resources, although some resources may allow a client to request the

241

# generation of an appropriate name automatically. Name is primarily intended

242

# for creation idempotence and configuration definition. Cannot be updated.

243

# More info: http://kubernetes.io/docs/user-guide/identifiers#names

244

# +optional

245

"deletionGracePeriodSeconds": 42, # (Optional)

246

#

247

# Cloud Run fully managed: not supported

248

#

249

# Cloud Run for Anthos: supported

250

#

251

# Number of seconds allowed for this object to gracefully terminate before

252

# it will be removed from the system. Only set when deletionTimestamp is also

253

# set. May only be shortened. Read-only.

254

"clusterName": "A String", # (Optional)

255

#

256

# Cloud Run fully managed: not supported

257

#

258

# Cloud Run for Anthos: supported

259

#

260

# The name of the cluster which the object belongs to.

261

# This is used to distinguish resources with same name and namespace in

262

# different clusters. This field is not set anywhere right now and apiserver

263

# is going to ignore it if set in create or update request.

264

"finalizers": [ # (Optional)

265

#

266

# Cloud Run fully managed: not supported

267

#

268

# Cloud Run for Anthos: supported

269

#

270

# Must be empty before the object is deleted from the registry. Each entry

271

# is an identifier for the responsible component that will remove the entry

272

# from the list. If the deletionTimestamp of the object is non-nil, entries

273

# in this list can only be removed.

274

# +patchStrategy=merge

275

"A String",

276

],

277

"deletionTimestamp": "A String", # (Optional)

278

#

279

# Cloud Run fully managed: not supported

280

#

281

# Cloud Run for Anthos: supported

282

#

283

# DeletionTimestamp is RFC 3339 date and time at which this resource will be

284

# deleted. This field is set by the server when a graceful deletion is

285

# requested by the user, and is not directly settable by a client. The

286

# resource is expected to be deleted (no longer visible from resource lists,

287

# and not reachable by name) after the time in this field, once the

288

# finalizers list is empty. As long as the finalizers list contains items,

289

# deletion is blocked. Once the deletionTimestamp is set, this value may not

290

# be unset or be set further into the future, although it may be shortened or

291

# the resource may be deleted prior to this time. For example, a user may

292

# request that a pod is deleted in 30 seconds. The Kubelet will react by

293

# sending a graceful termination signal to the containers in the pod. After

294

# that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL)

295

# to the container and after cleanup, remove the pod from the API. In the

296

# presence of network partitions, this object may still exist after this

297

# timestamp, until an administrator or automated process can determine the

298

# resource is fully terminated.

299

# If not set, graceful deletion of the object has not been requested.

300

#

301

# Populated by the system when a graceful deletion is requested.

302

# Read-only.

303

# More info:

304

# https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

305

"ownerReferences": [ # (Optional)

306

#

307

# Cloud Run fully managed: not supported

308

#

309

# Cloud Run for Anthos: supported

310

#

311

# List of objects that own this object. If ALL objects in the list have

312

# been deleted, this object will be garbage collected.

313

{ # OwnerReference contains enough information to let you identify an owning

314

# object. Currently, an owning object must be in the same namespace, so there

315

# is no namespace field.

316

"uid": "A String", # UID of the referent.

317

# More info: http://kubernetes.io/docs/user-guide/identifiers#uids

318

"controller": True or False, # If true, this reference points to the managing controller.

319

# +optional

320

"kind": "A String", # Kind of the referent.

321

# More info:

322

# https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

323

"blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then

324

# the owner cannot be deleted from the key-value store until this

325

# reference is removed.

326

# Defaults to false.

327

# To set this field, a user needs "delete" permission of the owner,

328

# otherwise 422 (Unprocessable Entity) will be returned.

329

# +optional

330

"apiVersion": "A String", # API version of the referent.

331

"name": "A String", # Name of the referent.

332

# More info: http://kubernetes.io/docs/user-guide/identifiers#names

},

],

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

345

346

{ # Resource to hold the state and status of a user's domain mapping.

347

"status": { # The current state of the Domain Mapping. # The current status of the DomainMapping.

348

"mappedRouteName": "A String", # The name of the route that the mapping currently points to.

349

"conditions": [ # Array of observed DomainMappingConditions, indicating the current state

350

# of the DomainMapping.

351

{ # Condition defines a generic condition for a Resource

352

"message": "A String", # Optional. Human readable message indicating details about the current status.

353

"lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another.

354

"status": "A String", # Status of the condition, one of True, False, Unknown.

355

"severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info

356

"reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition.

357

"type": "A String", # type is used to communicate the status of the reconciliation process.

358

# See also:

359

# https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting

360

# Types common to all resources include:

361

# * "Ready": True when the Resource is ready.

362

},

363

],

364

"observedGeneration": 42, # ObservedGeneration is the 'Generation' of the DomainMapping that

365

# was last processed by the controller.

366

#

367

# Clients polling for completed reconciliation should poll until

368

# observedGeneration = metadata.generation and the Ready condition's status

369

# is True or False.

370

"resourceRecords": [ # The resource records required to configure this domain mapping. These

371

# records must be added to the domain's DNS configuration in order to

372

# serve the application via this domain mapping.

373

{ # A DNS resource record.

374

"type": "A String", # Resource record type. Example: `AAAA`.

375

"rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035

376

# (section 5) and RFC 1034 (section 3.6.1).

377

"name": "A String", # Relative name of the object affected by this record. Only applicable for

378

# `CNAME` records. Example: 'www'.

},

],

},

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1".

383

"spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping.

384

"routeName": "A String", # The name of the Knative Route that this DomainMapping applies to.

385

# The route must exist.

386

"certificateMode": "A String", # The mode of the certificate.

387

"forceOverride": True or False, # If set, the mapping will override any mapping set before this spec was set.

388

# It is recommended that the user leaves this empty to receive an error

389

# warning about a potential conflict and only set it once the respective UI

390

# has given such a warning.

391

},

392

"kind": "A String", # The kind of resource, in this case "DomainMapping".

393

"metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this BuildTemplate.

394

# persisted resources must have, which includes all objects users must create.

395

"creationTimestamp": "A String", # (Optional)

396

#

397

# CreationTimestamp is a timestamp representing the server time when this

398

# object was created. It is not guaranteed to be set in happens-before order

399

# across separate operations. Clients may not set this value. It is

400

# represented in RFC3339 form and is in UTC.

401

#

402

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

# https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

407

"labels": { # (Optional)

408

#

409

# Map of string keys and values that can be used to organize and categorize

410

# (scope and select) objects. May match selectors of replication controllers

411

# and routes.

412

# More info: http://kubernetes.io/docs/user-guide/labels

413

"a_key": "A String",

414

},

415

"generation": 42, # (Optional)

416

#

417

# A sequence number representing a specific generation of the desired state.

418

# Populated by the system. Read-only.

419

"resourceVersion": "A String", # (Optional)

420

#

421

# An opaque value that represents the internal version of this object that

422

# can be used by clients to determine when objects have changed. May be used

423

# for optimistic concurrency, change detection, and the watch operation on a

424

# resource or set of resources. Clients must treat these values as opaque and

425

# passed unmodified back to the server. They may only be valid for a

426

# particular resource or set of resources.

427

#

428

# Populated by the system.

429

# Read-only.

430

# Value must be treated as opaque by clients and .

431

# More info:

432

# https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

433

"selfLink": "A String", # (Optional)

434

#

435

# SelfLink is a URL representing this object.

436

# Populated by the system.

437

# Read-only.

438

# string selfLink = 4;

439

"uid": "A String", # (Optional)

440

#

441

# UID is the unique in time and space value for this object. It is typically

442

# generated by the server on successful creation of a resource and is not

443

# allowed to change on PUT operations.

444

#

445

# Populated by the system.

446

# Read-only.

447

# More info: http://kubernetes.io/docs/user-guide/identifiers#uids

448

"namespace": "A String", # Namespace defines the space within each name must be unique, within a

449

# Cloud Run region. In Cloud Run the namespace must be equal to either the

450

# project ID or project number.

451

"annotations": { # (Optional)

452

#

453

# Annotations is an unstructured key value map stored with a resource that

454

# may be set by external tools to store and retrieve arbitrary metadata. They

455

# are not queryable and should be preserved when modifying objects. More

456

# info: http://kubernetes.io/docs/user-guide/annotations

457

"a_key": "A String",

458

},

459

"generateName": "A String", # (Optional)

460

#

461

# Cloud Run fully managed: not supported

462

#

463

# Cloud Run for Anthos: supported

464

#

465

# GenerateName is an optional prefix, used by the server, to generate a

466

# unique name ONLY IF the Name field has not been provided. If this field is

467

# used, the name returned to the client will be different than the name

468

# passed. This value will also be combined with a unique suffix. The provided

469

# value has the same validation rules as the Name field, and may be truncated

470

# by the length of the suffix required to make the value unique on the

471

# server.

472

#

473

# If this field is specified and the generated name exists, the server will

474

# NOT return a 409 - instead, it will either return 201 Created or 500 with

475

# Reason ServerTimeout indicating a unique name could not be found in the

476

# time allotted, and the client should retry (optionally after the time

477

# indicated in the Retry-After header).

478

#

479

# Applied only if Name is not specified.

480

# More info:

481

# https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency

482

# string generateName = 2;

483

"name": "A String", # Name must be unique within a namespace, within a Cloud Run region.

484

# Is required when creating

485

# resources, although some resources may allow a client to request the

486

# generation of an appropriate name automatically. Name is primarily intended

487

# for creation idempotence and configuration definition. Cannot be updated.

488

# More info: http://kubernetes.io/docs/user-guide/identifiers#names

489

# +optional

490

"deletionGracePeriodSeconds": 42, # (Optional)

491

#

492

# Cloud Run fully managed: not supported

493

#

494

# Cloud Run for Anthos: supported

495

#

496

# Number of seconds allowed for this object to gracefully terminate before

497

# it will be removed from the system. Only set when deletionTimestamp is also

498

# set. May only be shortened. Read-only.

499

"clusterName": "A String", # (Optional)

500

#

501

# Cloud Run fully managed: not supported

502

#

503

# Cloud Run for Anthos: supported

504

#

505

# The name of the cluster which the object belongs to.

506

# This is used to distinguish resources with same name and namespace in

507

# different clusters. This field is not set anywhere right now and apiserver

508

# is going to ignore it if set in create or update request.

509

"finalizers": [ # (Optional)

510

#

511

# Cloud Run fully managed: not supported

512

#

513

# Cloud Run for Anthos: supported

514

#

515

# Must be empty before the object is deleted from the registry. Each entry

516

# is an identifier for the responsible component that will remove the entry

517

# from the list. If the deletionTimestamp of the object is non-nil, entries

518

# in this list can only be removed.

519

# +patchStrategy=merge

520

"A String",

521

],

522

"deletionTimestamp": "A String", # (Optional)

523

#

524

# Cloud Run fully managed: not supported

525

#

526

# Cloud Run for Anthos: supported

527

#

528

# DeletionTimestamp is RFC 3339 date and time at which this resource will be

529

# deleted. This field is set by the server when a graceful deletion is

530

# requested by the user, and is not directly settable by a client. The

531

# resource is expected to be deleted (no longer visible from resource lists,

532

# and not reachable by name) after the time in this field, once the

533

# finalizers list is empty. As long as the finalizers list contains items,

534

# deletion is blocked. Once the deletionTimestamp is set, this value may not

535

# be unset or be set further into the future, although it may be shortened or

536

# the resource may be deleted prior to this time. For example, a user may

537

# request that a pod is deleted in 30 seconds. The Kubelet will react by

538

# sending a graceful termination signal to the containers in the pod. After

539

# that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL)

540

# to the container and after cleanup, remove the pod from the API. In the

541

# presence of network partitions, this object may still exist after this

542

# timestamp, until an administrator or automated process can determine the

543

# resource is fully terminated.

544

# If not set, graceful deletion of the object has not been requested.

545

#

546

# Populated by the system when a graceful deletion is requested.

547

# Read-only.

548

# More info:

549

# https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

550

"ownerReferences": [ # (Optional)

551

#

552

# Cloud Run fully managed: not supported

553

#

554

# Cloud Run for Anthos: supported

555

#

556

# List of objects that own this object. If ALL objects in the list have

557

# been deleted, this object will be garbage collected.

558

{ # OwnerReference contains enough information to let you identify an owning

559

# object. Currently, an owning object must be in the same namespace, so there

560

# is no namespace field.

561

"uid": "A String", # UID of the referent.

562

# More info: http://kubernetes.io/docs/user-guide/identifiers#uids

563

"controller": True or False, # If true, this reference points to the managing controller.

564

# +optional

565

"kind": "A String", # Kind of the referent.

566

# More info:

567

# https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

568

"blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then

569

# the owner cannot be deleted from the key-value store until this

570

# reference is removed.

571

# Defaults to false.

572

# To set this field, a user needs "delete" permission of the owner,

573

# otherwise 422 (Unprocessable Entity) will be returned.

574

# +optional

575

"apiVersion": "A String", # API version of the referent.

576

"name": "A String", # Name of the referent.

577

# More info: http://kubernetes.io/docs/user-guide/identifiers#names

},

],

},

}</pre>

</div>

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

586

<pre>Delete a domain mapping.

587

588

Args:

589

name: string, The name of the domain mapping to delete.

590

For Cloud Run (fully managed), replace {namespace_id} with the project ID

591

or number. (required)

592

apiVersion: string, Cloud Run currently ignores this parameter.

593

propagationPolicy: string, Specifies the propagation policy of delete. Cloud Run currently ignores

594

this setting, and deletes in the background. Please see

595

kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for

596

more information.

597

kind: string, Cloud Run currently ignores this parameter.

598

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

605

606

{ # Status is a return value for calls that don't return other objects

607

"metadata": { # ListMeta describes metadata that synthetic resources must have, including # Standard list metadata.

608

# More info:

609

# https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

610

# +optional

611

# lists and various status objects. A resource may have only one of

612

# {ObjectMeta, ListMeta}.

613

"resourceVersion": "A String", # String that identifies the server's internal version of this object that

614

# can be used by clients to determine when objects have changed. Value must

615

# be treated as opaque by clients and passed unmodified back to the server.

616

# Populated by the system.

617

# Read-only.

618

# More info:

619

# https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

620

# +optional

621

"continue": "A String", # continue may be set if the user set a limit on the number of items

622

# returned, and indicates that the server has more data available. The value

623

# is opaque and may be used to issue another request to the endpoint that

624

# served this list to retrieve the next set of available objects. Continuing

625

# a list may not be possible if the server configuration has changed or more

626

# than a few minutes have passed. The resourceVersion field returned when

627

# using this continue value will be identical to the value in the first

628

# response.

629

"selfLink": "A String", # SelfLink is a URL representing this object.

630

# Populated by the system.

# Read-only.

# +optional

},

"code": 42, # Suggested HTTP return code for this status, 0 if not set.

635

# +optional

636

"message": "A String", # A human-readable description of the status of this operation.

637

# +optional

638

"status": "A String", # Status of the operation.

639

# One of: "Success" or "Failure".

640

# More info:

641

# https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

642

# +optional

643

"details": { # StatusDetails is a set of additional properties that MAY be set by the # Extended data associated with the reason. Each reason may define its

644

# own extended details. This field is optional and the data returned

645

# is not guaranteed to conform to any schema except that defined by

646

# the reason type.

647

# +optional

648

# server to provide additional information about a response. The Reason

649

# field of a Status object defines what attributes will be set. Clients

650

# must ignore fields that do not match the defined type of each attribute,

651

# and should assume that any attribute may be empty, invalid, or under

652

# defined.

653

"name": "A String", # The name attribute of the resource associated with the status StatusReason

654

# (when there is a single name which can be described).

655

# +optional

656

"uid": "A String", # UID of the resource.

657

# (when there is a single resource which can be described).

658

# More info: http://kubernetes.io/docs/user-guide/identifiers#uids

659

# +optional

660

"group": "A String", # The group attribute of the resource associated with the status

661

# StatusReason. +optional

662

"causes": [ # The Causes array includes more details associated with the StatusReason

663

# failure. Not all StatusReasons may provide detailed causes.

664

# +optional

665

{ # StatusCause provides more information about an api.Status failure, including

666

# cases when multiple errors are encountered.

667

"message": "A String", # A human-readable description of the cause of the error. This field may be

668

# presented as-is to a reader.

669

# +optional

670

"reason": "A String", # A machine-readable description of the cause of the error. If this value is

671

# empty there is no information available.

672

# +optional

673

"field": "A String", # The field of the resource that has caused this error, as named by its JSON

674

# serialization. May include dot and postfix notation for nested attributes.

675

# Arrays are zero-indexed. Fields may appear more than once in an array of

676

# causes due to fields having multiple errors.

# Optional.

#

# Examples:

# "name" - the field "name" on the current resource

681

# "items[0].name" - the field "name" on the first array entry in "items"

# +optional

},

],

"kind": "A String", # The kind attribute of the resource associated with the status StatusReason.

686

# On some operations may differ from the requested resource Kind.

687

# More info:

688

# https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

689

# +optional

690

"retryAfterSeconds": 42, # If specified, the time in seconds before the operation should be retried.

691

# Some errors may indicate the client must take an alternate action - for

692

# those errors this field may indicate how long to wait before taking the

693

# alternate action. +optional

694

},

695

"reason": "A String", # A machine-readable description of why this operation is in the

696

# "Failure" status. If this value is empty there

697

# is no information available. A Reason clarifies an HTTP status

698

# code but does not override it.

# +optional

}</pre>

</div>

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

705

<pre>Get information about a domain mapping.

706

707

Args:

708

name: string, The name of the domain mapping to retrieve.

709

For Cloud Run (fully managed), replace {namespace_id} with the project ID

710

or number. (required)

711

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

718

719

{ # Resource to hold the state and status of a user's domain mapping.

720

"status": { # The current state of the Domain Mapping. # The current status of the DomainMapping.

721

"mappedRouteName": "A String", # The name of the route that the mapping currently points to.

722

"conditions": [ # Array of observed DomainMappingConditions, indicating the current state

723

# of the DomainMapping.

724

{ # Condition defines a generic condition for a Resource

725

"message": "A String", # Optional. Human readable message indicating details about the current status.

726

"lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another.

727

"status": "A String", # Status of the condition, one of True, False, Unknown.

728

"severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info

729

"reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition.

730

"type": "A String", # type is used to communicate the status of the reconciliation process.

731

# See also:

732

# https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting

733

# Types common to all resources include:

734

# * "Ready": True when the Resource is ready.

735

},

736

],

737

"observedGeneration": 42, # ObservedGeneration is the 'Generation' of the DomainMapping that

738

# was last processed by the controller.

739

#

740

# Clients polling for completed reconciliation should poll until

741

# observedGeneration = metadata.generation and the Ready condition's status

742

# is True or False.

743

"resourceRecords": [ # The resource records required to configure this domain mapping. These

744

# records must be added to the domain's DNS configuration in order to

745

# serve the application via this domain mapping.

746

{ # A DNS resource record.

747

"type": "A String", # Resource record type. Example: `AAAA`.

748

"rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035

749

# (section 5) and RFC 1034 (section 3.6.1).

750

"name": "A String", # Relative name of the object affected by this record. Only applicable for

751

# `CNAME` records. Example: 'www'.

},

],

},

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1".

756

"spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping.

757

"routeName": "A String", # The name of the Knative Route that this DomainMapping applies to.

758

# The route must exist.

759

"certificateMode": "A String", # The mode of the certificate.

760

"forceOverride": True or False, # If set, the mapping will override any mapping set before this spec was set.

761

# It is recommended that the user leaves this empty to receive an error

762

# warning about a potential conflict and only set it once the respective UI

763

# has given such a warning.

764

},

765

"kind": "A String", # The kind of resource, in this case "DomainMapping".

766

"metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this BuildTemplate.

767

# persisted resources must have, which includes all objects users must create.

768

"creationTimestamp": "A String", # (Optional)

769

#

770

# CreationTimestamp is a timestamp representing the server time when this

771

# object was created. It is not guaranteed to be set in happens-before order

772

# across separate operations. Clients may not set this value. It is

773

# represented in RFC3339 form and is in UTC.

774

#

775

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

# https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

780

"labels": { # (Optional)

781

#

782

# Map of string keys and values that can be used to organize and categorize

783

# (scope and select) objects. May match selectors of replication controllers

784

# and routes.

785

# More info: http://kubernetes.io/docs/user-guide/labels

786

"a_key": "A String",

787

},

788

"generation": 42, # (Optional)

789

#

790

# A sequence number representing a specific generation of the desired state.

791

# Populated by the system. Read-only.

792

"resourceVersion": "A String", # (Optional)

793

#

794

# An opaque value that represents the internal version of this object that

795

# can be used by clients to determine when objects have changed. May be used

796

# for optimistic concurrency, change detection, and the watch operation on a

797

# resource or set of resources. Clients must treat these values as opaque and

798

# passed unmodified back to the server. They may only be valid for a

799

# particular resource or set of resources.

800

#

801

# Populated by the system.

802

# Read-only.

803

# Value must be treated as opaque by clients and .

804

# More info:

805

# https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

806

"selfLink": "A String", # (Optional)

807

#

808

# SelfLink is a URL representing this object.

809

# Populated by the system.

810

# Read-only.

811

# string selfLink = 4;

812

"uid": "A String", # (Optional)

813

#

814

# UID is the unique in time and space value for this object. It is typically

815

# generated by the server on successful creation of a resource and is not

816

# allowed to change on PUT operations.

817

#

818

# Populated by the system.

819

# Read-only.

820

# More info: http://kubernetes.io/docs/user-guide/identifiers#uids

821

"namespace": "A String", # Namespace defines the space within each name must be unique, within a

822

# Cloud Run region. In Cloud Run the namespace must be equal to either the

823

# project ID or project number.

824

"annotations": { # (Optional)

825

#

826

# Annotations is an unstructured key value map stored with a resource that

827

# may be set by external tools to store and retrieve arbitrary metadata. They

828

# are not queryable and should be preserved when modifying objects. More

829

# info: http://kubernetes.io/docs/user-guide/annotations

830

"a_key": "A String",

831

},

832

"generateName": "A String", # (Optional)

833

#

834

# Cloud Run fully managed: not supported

835

#

836

# Cloud Run for Anthos: supported

837

#

838

# GenerateName is an optional prefix, used by the server, to generate a

839

# unique name ONLY IF the Name field has not been provided. If this field is

840

# used, the name returned to the client will be different than the name

841

# passed. This value will also be combined with a unique suffix. The provided

842

# value has the same validation rules as the Name field, and may be truncated

843

# by the length of the suffix required to make the value unique on the

844

# server.

845

#

846

# If this field is specified and the generated name exists, the server will

847

# NOT return a 409 - instead, it will either return 201 Created or 500 with

848

# Reason ServerTimeout indicating a unique name could not be found in the

849

# time allotted, and the client should retry (optionally after the time

850

# indicated in the Retry-After header).

851

#

852

# Applied only if Name is not specified.

853

# More info:

854

# https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency

855

# string generateName = 2;

856

"name": "A String", # Name must be unique within a namespace, within a Cloud Run region.

857

# Is required when creating

858

# resources, although some resources may allow a client to request the

859

# generation of an appropriate name automatically. Name is primarily intended

860

# for creation idempotence and configuration definition. Cannot be updated.

861

# More info: http://kubernetes.io/docs/user-guide/identifiers#names

862

# +optional

863

"deletionGracePeriodSeconds": 42, # (Optional)

864

#

865

# Cloud Run fully managed: not supported

866

#

867

# Cloud Run for Anthos: supported

868

#

869

# Number of seconds allowed for this object to gracefully terminate before

870

# it will be removed from the system. Only set when deletionTimestamp is also

871

# set. May only be shortened. Read-only.

872

"clusterName": "A String", # (Optional)

873

#

874

# Cloud Run fully managed: not supported

875

#

876

# Cloud Run for Anthos: supported

877

#

878

# The name of the cluster which the object belongs to.

879

# This is used to distinguish resources with same name and namespace in

880

# different clusters. This field is not set anywhere right now and apiserver

881

# is going to ignore it if set in create or update request.

882

"finalizers": [ # (Optional)

883

#

884

# Cloud Run fully managed: not supported

885

#

886

# Cloud Run for Anthos: supported

887

#

888

# Must be empty before the object is deleted from the registry. Each entry

889

# is an identifier for the responsible component that will remove the entry

890

# from the list. If the deletionTimestamp of the object is non-nil, entries

891

# in this list can only be removed.

892

# +patchStrategy=merge

893

"A String",

894

],

895

"deletionTimestamp": "A String", # (Optional)

896

#

897

# Cloud Run fully managed: not supported

898

#

899

# Cloud Run for Anthos: supported

900

#

901

# DeletionTimestamp is RFC 3339 date and time at which this resource will be

902

# deleted. This field is set by the server when a graceful deletion is

903

# requested by the user, and is not directly settable by a client. The

904

# resource is expected to be deleted (no longer visible from resource lists,

905

# and not reachable by name) after the time in this field, once the

906

# finalizers list is empty. As long as the finalizers list contains items,

907

# deletion is blocked. Once the deletionTimestamp is set, this value may not

908

# be unset or be set further into the future, although it may be shortened or

909

# the resource may be deleted prior to this time. For example, a user may

910

# request that a pod is deleted in 30 seconds. The Kubelet will react by

911

# sending a graceful termination signal to the containers in the pod. After

912

# that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL)

913

# to the container and after cleanup, remove the pod from the API. In the

914

# presence of network partitions, this object may still exist after this

915

# timestamp, until an administrator or automated process can determine the

916

# resource is fully terminated.

917

# If not set, graceful deletion of the object has not been requested.

918

#

919

# Populated by the system when a graceful deletion is requested.

920

# Read-only.

921

# More info:

922

# https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

923

"ownerReferences": [ # (Optional)

924

#

925

# Cloud Run fully managed: not supported

926

#

927

# Cloud Run for Anthos: supported

928

#

929

# List of objects that own this object. If ALL objects in the list have

930

# been deleted, this object will be garbage collected.

931

{ # OwnerReference contains enough information to let you identify an owning

932

# object. Currently, an owning object must be in the same namespace, so there

933

# is no namespace field.

934

"uid": "A String", # UID of the referent.

935

# More info: http://kubernetes.io/docs/user-guide/identifiers#uids

936

"controller": True or False, # If true, this reference points to the managing controller.

937

# +optional

938

"kind": "A String", # Kind of the referent.

939

# More info:

940

# https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

941

"blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then

942

# the owner cannot be deleted from the key-value store until this

943

# reference is removed.

944

# Defaults to false.

945

# To set this field, a user needs "delete" permission of the owner,

946

# otherwise 422 (Unprocessable Entity) will be returned.

947

# +optional

948

"apiVersion": "A String", # API version of the referent.

949

"name": "A String", # Name of the referent.

950

# More info: http://kubernetes.io/docs/user-guide/identifiers#names

},

],

},

}</pre>

</div>

<code class="details" id="list">list(parent, labelSelector=None, fieldSelector=None, includeUninitialized=None, resourceVersion=None, continue=None, limit=None, watch=None, x__xgafv=None)</code>

959

<pre>List domain mappings.

960

961

Args:

962

parent: string, The namespace from which the domain mappings should be listed.

963

For Cloud Run (fully managed), replace {namespace_id} with the project ID

964

or number. (required)

965

labelSelector: string, Allows to filter resources based on a label. Supported operations are

966

=, !=, exists, in, and notIn.

967

fieldSelector: string, Allows to filter resources based on a specific value for a field name.

968

Send this in a query string format. i.e. 'metadata.name%3Dlorem'.

969

Not currently used by Cloud Run.

970

includeUninitialized: boolean, Not currently used by Cloud Run.

971

resourceVersion: string, The baseline resource version from which the list or watch operation should

972

start. Not currently used by Cloud Run.

973

continue: string, Optional encoded string to continue paging.

974

limit: integer, The maximum number of records that should be returned.

975

watch: boolean, Flag that indicates that the client expects to watch this resource as well.

976

Not currently used by Cloud Run.

977

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

984

985

{ # ListDomainMappingsResponse is a list of DomainMapping resources.

986

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1".

987

"kind": "A String", # The kind of this resource, in this case "DomainMappingList".

988

"unreachable": [ # Locations that could not be reached.

989

"A String",

990

],

991

"metadata": { # ListMeta describes metadata that synthetic resources must have, including # Metadata associated with this DomainMapping list.

992

# lists and various status objects. A resource may have only one of

993

# {ObjectMeta, ListMeta}.

994

"resourceVersion": "A String", # String that identifies the server's internal version of this object that

995

# can be used by clients to determine when objects have changed. Value must

996

# be treated as opaque by clients and passed unmodified back to the server.

997

# Populated by the system.

998

# Read-only.

999

# More info:

1000

# https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

1001

# +optional

1002

"continue": "A String", # continue may be set if the user set a limit on the number of items

1003

# returned, and indicates that the server has more data available. The value

1004

# is opaque and may be used to issue another request to the endpoint that

1005

# served this list to retrieve the next set of available objects. Continuing

1006

# a list may not be possible if the server configuration has changed or more

1007

# than a few minutes have passed. The resourceVersion field returned when

1008

# using this continue value will be identical to the value in the first

1009

# response.

1010

"selfLink": "A String", # SelfLink is a URL representing this object.

1011

# Populated by the system.

# Read-only.

# +optional

},

"items": [ # List of DomainMappings.

1016

{ # Resource to hold the state and status of a user's domain mapping.

1017

"status": { # The current state of the Domain Mapping. # The current status of the DomainMapping.

1018

"mappedRouteName": "A String", # The name of the route that the mapping currently points to.

1019

"conditions": [ # Array of observed DomainMappingConditions, indicating the current state

1020

# of the DomainMapping.

1021

{ # Condition defines a generic condition for a Resource

1022

"message": "A String", # Optional. Human readable message indicating details about the current status.

1023

"lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another.

1024

"status": "A String", # Status of the condition, one of True, False, Unknown.

1025

"severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info

1026

"reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition.

1027

"type": "A String", # type is used to communicate the status of the reconciliation process.

1028

# See also:

1029

# https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting

1030

# Types common to all resources include:

1031

# * "Ready": True when the Resource is ready.

1032

},

1033

],

1034

"observedGeneration": 42, # ObservedGeneration is the 'Generation' of the DomainMapping that

1035

# was last processed by the controller.

1036

#

1037

# Clients polling for completed reconciliation should poll until

1038

# observedGeneration = metadata.generation and the Ready condition's status

1039

# is True or False.

1040

"resourceRecords": [ # The resource records required to configure this domain mapping. These

1041

# records must be added to the domain's DNS configuration in order to

1042

# serve the application via this domain mapping.

1043

{ # A DNS resource record.

1044

"type": "A String", # Resource record type. Example: `AAAA`.

1045

"rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035

1046

# (section 5) and RFC 1034 (section 3.6.1).

1047

"name": "A String", # Relative name of the object affected by this record. Only applicable for

1048

# `CNAME` records. Example: 'www'.

},

],

},

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1".

1053

"spec": { # The desired state of the Domain Mapping. # The spec for this DomainMapping.

1054

"routeName": "A String", # The name of the Knative Route that this DomainMapping applies to.

1055

# The route must exist.

1056

"certificateMode": "A String", # The mode of the certificate.

1057

"forceOverride": True or False, # If set, the mapping will override any mapping set before this spec was set.

1058

# It is recommended that the user leaves this empty to receive an error

1059

# warning about a potential conflict and only set it once the respective UI

1060

# has given such a warning.

1061

},

1062

"kind": "A String", # The kind of resource, in this case "DomainMapping".

1063

"metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this BuildTemplate.

1064

# persisted resources must have, which includes all objects users must create.

1065

"creationTimestamp": "A String", # (Optional)

1066

#

1067

# CreationTimestamp is a timestamp representing the server time when this

1068

# object was created. It is not guaranteed to be set in happens-before order

1069

# across separate operations. Clients may not set this value. It is

1070

# represented in RFC3339 form and is in UTC.

1071

#

1072

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

# https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

1077

"labels": { # (Optional)

1078

#

1079

# Map of string keys and values that can be used to organize and categorize

1080

# (scope and select) objects. May match selectors of replication controllers

1081

# and routes.

1082

# More info: http://kubernetes.io/docs/user-guide/labels

1083

"a_key": "A String",

1084

},

1085

"generation": 42, # (Optional)

1086

#

1087

# A sequence number representing a specific generation of the desired state.

1088

# Populated by the system. Read-only.

1089

"resourceVersion": "A String", # (Optional)

1090

#

1091

# An opaque value that represents the internal version of this object that

1092

# can be used by clients to determine when objects have changed. May be used

1093

# for optimistic concurrency, change detection, and the watch operation on a

1094

# resource or set of resources. Clients must treat these values as opaque and

1095

# passed unmodified back to the server. They may only be valid for a

1096

# particular resource or set of resources.

1097

#

1098

# Populated by the system.

1099

# Read-only.

1100

# Value must be treated as opaque by clients and .

1101

# More info:

1102

# https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

1103

"selfLink": "A String", # (Optional)

1104

#

1105

# SelfLink is a URL representing this object.

1106

# Populated by the system.

1107

# Read-only.

1108

# string selfLink = 4;

1109

"uid": "A String", # (Optional)

1110

#

1111

# UID is the unique in time and space value for this object. It is typically

1112

# generated by the server on successful creation of a resource and is not

1113

# allowed to change on PUT operations.

1114

#

1115

# Populated by the system.

1116

# Read-only.

1117

# More info: http://kubernetes.io/docs/user-guide/identifiers#uids

1118

"namespace": "A String", # Namespace defines the space within each name must be unique, within a

1119

# Cloud Run region. In Cloud Run the namespace must be equal to either the

1120

# project ID or project number.

1121

"annotations": { # (Optional)

1122

#

1123

# Annotations is an unstructured key value map stored with a resource that

1124

# may be set by external tools to store and retrieve arbitrary metadata. They

1125

# are not queryable and should be preserved when modifying objects. More

1126

# info: http://kubernetes.io/docs/user-guide/annotations

1127

"a_key": "A String",

1128

},

1129

"generateName": "A String", # (Optional)

1130

#

1131

# Cloud Run fully managed: not supported

1132

#

1133

# Cloud Run for Anthos: supported

1134

#

1135

# GenerateName is an optional prefix, used by the server, to generate a

1136

# unique name ONLY IF the Name field has not been provided. If this field is

1137

# used, the name returned to the client will be different than the name

1138

# passed. This value will also be combined with a unique suffix. The provided

1139

# value has the same validation rules as the Name field, and may be truncated

1140

# by the length of the suffix required to make the value unique on the

1141

# server.

1142

#

1143

# If this field is specified and the generated name exists, the server will

1144

# NOT return a 409 - instead, it will either return 201 Created or 500 with

1145

# Reason ServerTimeout indicating a unique name could not be found in the

1146

# time allotted, and the client should retry (optionally after the time

1147

# indicated in the Retry-After header).

1148

#

1149

# Applied only if Name is not specified.

1150

# More info:

1151

# https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency

1152

# string generateName = 2;

1153

"name": "A String", # Name must be unique within a namespace, within a Cloud Run region.

1154

# Is required when creating

1155

# resources, although some resources may allow a client to request the

1156

# generation of an appropriate name automatically. Name is primarily intended

1157

# for creation idempotence and configuration definition. Cannot be updated.

1158

# More info: http://kubernetes.io/docs/user-guide/identifiers#names

1159

# +optional

1160

"deletionGracePeriodSeconds": 42, # (Optional)

1161

#

1162

# Cloud Run fully managed: not supported

1163

#

1164

# Cloud Run for Anthos: supported

1165

#

1166

# Number of seconds allowed for this object to gracefully terminate before

1167

# it will be removed from the system. Only set when deletionTimestamp is also

1168

# set. May only be shortened. Read-only.

1169

"clusterName": "A String", # (Optional)

1170

#

1171

# Cloud Run fully managed: not supported

1172

#

1173

# Cloud Run for Anthos: supported

1174

#

1175

# The name of the cluster which the object belongs to.

1176

# This is used to distinguish resources with same name and namespace in

1177

# different clusters. This field is not set anywhere right now and apiserver

1178

# is going to ignore it if set in create or update request.

1179

"finalizers": [ # (Optional)

1180

#

1181

# Cloud Run fully managed: not supported

1182

#

1183

# Cloud Run for Anthos: supported

1184

#

1185

# Must be empty before the object is deleted from the registry. Each entry

1186

# is an identifier for the responsible component that will remove the entry

1187

# from the list. If the deletionTimestamp of the object is non-nil, entries

1188

# in this list can only be removed.

1189

# +patchStrategy=merge

1190

"A String",

1191

],

1192

"deletionTimestamp": "A String", # (Optional)

1193

#

1194

# Cloud Run fully managed: not supported

1195

#

1196

# Cloud Run for Anthos: supported

1197

#

1198

# DeletionTimestamp is RFC 3339 date and time at which this resource will be

1199

# deleted. This field is set by the server when a graceful deletion is

1200

# requested by the user, and is not directly settable by a client. The

1201

# resource is expected to be deleted (no longer visible from resource lists,

1202

# and not reachable by name) after the time in this field, once the

1203

# finalizers list is empty. As long as the finalizers list contains items,

1204

# deletion is blocked. Once the deletionTimestamp is set, this value may not

1205

# be unset or be set further into the future, although it may be shortened or

1206

# the resource may be deleted prior to this time. For example, a user may

1207

# request that a pod is deleted in 30 seconds. The Kubelet will react by

1208

# sending a graceful termination signal to the containers in the pod. After

1209

# that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL)

1210

# to the container and after cleanup, remove the pod from the API. In the

1211

# presence of network partitions, this object may still exist after this

1212

# timestamp, until an administrator or automated process can determine the

1213

# resource is fully terminated.

1214

# If not set, graceful deletion of the object has not been requested.

1215

#

1216

# Populated by the system when a graceful deletion is requested.

1217

# Read-only.

1218

# More info:

1219

# https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

1220

"ownerReferences": [ # (Optional)

1221

#

1222

# Cloud Run fully managed: not supported

1223

#

1224

# Cloud Run for Anthos: supported

1225

#

1226

# List of objects that own this object. If ALL objects in the list have

1227

# been deleted, this object will be garbage collected.

1228

{ # OwnerReference contains enough information to let you identify an owning

1229

# object. Currently, an owning object must be in the same namespace, so there

1230

# is no namespace field.

1231

"uid": "A String", # UID of the referent.

1232

# More info: http://kubernetes.io/docs/user-guide/identifiers#uids

1233

"controller": True or False, # If true, this reference points to the managing controller.

1234

# +optional

1235

"kind": "A String", # Kind of the referent.

1236

# More info:

1237

# https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

1238

"blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then

1239

# the owner cannot be deleted from the key-value store until this

1240

# reference is removed.

1241

# Defaults to false.

1242

# To set this field, a user needs "delete" permission of the owner,

1243

# otherwise 422 (Unprocessable Entity) will be returned.

1244

# +optional

1245

"apiVersion": "A String", # API version of the referent.

1246

"name": "A String", # Name of the referent.

1247

# More info: http://kubernetes.io/docs/user-guide/identifiers#names

},

],

},

},

],

}</pre>

</div>

</body></html>