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

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

76

<h2>Instance Methods</h2>

77

78

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

79

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

80

81

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

82

<p class="firstline">Rpc to delete a domain mapping.</p>

83

84

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

85

<p class="firstline">Rpc to get information about a domain mapping.</p>

86

87

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

88

<p class="firstline">Rpc to list domain mappings.</p>

89

<h3>Method Details</h3>

90

91

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

92

<pre>Creates a new domain mapping.

93

94

Args:

95

parent: string, The project ID or project number in which this domain mapping should be

96

created. (required)

97

body: object, The request body. (required)

98

The object takes the form of:

99

100

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

101

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

102

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

103

# was last processed by the controller.

104

#

105

# Clients polling for completed reconciliation should poll until

106

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

107

# is True or False.

108

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

109

# of the DomainMapping.

110

{ # DomainMappingCondition contains state information for a DomainMapping.

111

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

112

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

113

# +optional

114

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

115

# +optional

116

"reason": "A String", # One-word CamelCase reason for the condition's current status.

117

# +optional

118

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

119

# +optional

120

"type": "A String", # Type of domain mapping condition.

121

},

122

],

123

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

124

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

125

# serve the application via this domain mapping.

126

{ # A DNS resource record.

127

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

128

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

129

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

130

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

131

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

132

},

133

],

134

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

135

},

136

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

137

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

138

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

139

# The route must exist.

140

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

141

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

142

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

143

# has given such a warning.

144

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

145

},

146

"apiVersion": "A String", # The API version for this call such as "v1alpha1".

147

"metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this BuildTemplate.

148

# all objects users must create.

149

"ownerReferences": [ # List of objects that own this object. If ALL objects in the list have

150

# been deleted, this object will be garbage collected.

151

# +optional

152

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

153

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

154

# is no namespace field.

155

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

156

# More info:

157

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

158

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

159

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

160

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

161

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

162

# +optional

163

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

164

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

165

# reference is removed.

166

# Defaults to false.

167

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

168

# otherwise 422 (Unprocessable Entity) will be returned.

169

# +optional

170

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

171

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

172

},

173

],

174

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

175

# Is required when creating

176

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

177

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

178

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

179

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

180

# +optional

181

"deletionTimestamp": "A String", # DeletionTimestamp is RFC 3339 date and time at which this resource will be

182

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

183

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

184

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

185

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

186

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

187

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

188

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

189

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

190

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

191

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

192

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

193

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

194

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

195

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

196

# resource is fully terminated.

197

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

198

#

199

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

200

# Read-only.

201

# More info:

202

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

203

# +optional

204

"clusterName": "A String", # Not currently supported by Cloud Run.

205

#

206

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

207

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

208

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

209

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

210

"deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run.

211

#

212

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

213

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

214

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

215

"labels": { # Map of string keys and values that can be used to organize and categorize

216

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

217

# and routes.

218

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

# +optional

"a_key": "A String",

},

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

223

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

224

# project ID or project number.

225

"generation": 42, # A sequence number representing a specific generation of the desired state.

226

# Populated by the system. Read-only.

227

# +optional

228

"finalizers": [ # Not currently supported by Cloud Run.

229

#

230

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

231

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

232

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

233

# in this list can only be removed.

234

# +optional

235

# +patchStrategy=merge

236

"A String",

237

],

238

"initializers": { # Initializers tracks the progress of initialization. # Not currently supported by Cloud Run.

239

#

240

# An initializer is a controller which enforces some system invariant at

241

# object creation time. This field is a list of initializers that have not

242

# yet acted on this object. If nil or empty, this object has been completely

243

# initialized. Otherwise, the object is considered uninitialized and is

244

# hidden (in list/watch and get calls) from clients that haven't explicitly

245

# asked to observe uninitialized objects.

246

#

247

# When an object is created, the system will populate this list with the

248

# current set of initializers. Only privileged users may set or modify this

249

# list. Once it is empty, it may not be modified further by any user.

250

"pending": [ # Pending is a list of initializers that must execute in order before this

251

# object is visible. When the last pending initializer is removed, and no

252

# failing result is set, the initializers struct will be set to nil and the

253

# object is considered as initialized and visible to all clients.

254

# +patchMergeKey=name

255

# +patchStrategy=merge

256

{ # Initializer is information about an initializer that has not yet completed.

257

"name": "A String", # name of the process that is responsible for initializing this object.

},

],

},

"resourceVersion": "A String", # An opaque value that represents the internal version of this object that

262

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

263

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

264

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

265

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

266

# particular resource or set of resources.

267

#

268

# Populated by the system.

269

# Read-only.

270

# Value must be treated as opaque by clients and .

271

# More info:

272

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

273

# +optional

274

"generateName": "A String", # Not currently supported by Cloud Run.

275

#

276

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

277

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

278

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

279

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

280

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

281

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

282

# server.

283

#

284

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

285

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

286

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

287

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

288

# indicated in the Retry-After header).

289

#

290

# Applied only if Name is not specified.

291

# More info:

292

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

293

# +optional

294

# string generateName = 2;

295

"creationTimestamp": "A String", # CreationTimestamp is a timestamp representing the server time when this

296

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

297

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

298

# represented in RFC3339 form and is in UTC.

299

#

300

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

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

305

# +optional

306

"annotations": { # Annotations is an unstructured key value map stored with a resource that

307

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

308

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

309

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

310

"a_key": "A String",

311

},

312

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

313

# Populated by the system.

314

# Read-only.

315

# +optional

316

# string selfLink = 4;

317

"uid": "A String", # UID is the unique in time and space value for this object. It is typically

318

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

319

# allowed to change on PUT operations.

320

#

321

# Populated by the system.

322

# Read-only.

323

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

# +optional

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

335

336

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

337

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

338

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

339

# was last processed by the controller.

340

#

341

# Clients polling for completed reconciliation should poll until

342

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

343

# is True or False.

344

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

345

# of the DomainMapping.

346

{ # DomainMappingCondition contains state information for a DomainMapping.

347

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

348

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

349

# +optional

350

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

351

# +optional

352

"reason": "A String", # One-word CamelCase reason for the condition's current status.

353

# +optional

354

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

355

# +optional

356

"type": "A String", # Type of domain mapping condition.

357

},

358

],

359

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

360

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

361

# serve the application via this domain mapping.

362

{ # A DNS resource record.

363

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

364

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

365

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

366

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

367

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

368

},

369

],

370

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

371

},

372

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

373

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

374

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

375

# The route must exist.

376

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

377

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

378

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

379

# has given such a warning.

380

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

381

},

382

"apiVersion": "A String", # The API version for this call such as "v1alpha1".

383

"metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this BuildTemplate.

384

# all objects users must create.

385

"ownerReferences": [ # List of objects that own this object. If ALL objects in the list have

386

# been deleted, this object will be garbage collected.

387

# +optional

388

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

389

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

390

# is no namespace field.

391

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

392

# More info:

393

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

394

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

395

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

396

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

397

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

398

# +optional

399

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

400

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

401

# reference is removed.

402

# Defaults to false.

403

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

404

# otherwise 422 (Unprocessable Entity) will be returned.

405

# +optional

406

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

407

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

408

},

409

],

410

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

411

# Is required when creating

412

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

413

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

414

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

415

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

416

# +optional

417

"deletionTimestamp": "A String", # DeletionTimestamp is RFC 3339 date and time at which this resource will be

418

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

419

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

420

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

421

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

422

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

423

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

424

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

425

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

426

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

427

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

428

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

429

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

430

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

431

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

432

# resource is fully terminated.

433

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

434

#

435

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

436

# Read-only.

437

# More info:

438

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

439

# +optional

440

"clusterName": "A String", # Not currently supported by Cloud Run.

441

#

442

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

443

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

444

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

445

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

446

"deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run.

447

#

448

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

449

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

450

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

451

"labels": { # Map of string keys and values that can be used to organize and categorize

452

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

453

# and routes.

454

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

# +optional

"a_key": "A String",

},

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

459

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

460

# project ID or project number.

461

"generation": 42, # A sequence number representing a specific generation of the desired state.

462

# Populated by the system. Read-only.

463

# +optional

464

"finalizers": [ # Not currently supported by Cloud Run.

465

#

466

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

467

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

468

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

469

# in this list can only be removed.

470

# +optional

471

# +patchStrategy=merge

472

"A String",

473

],

474

"initializers": { # Initializers tracks the progress of initialization. # Not currently supported by Cloud Run.

475

#

476

# An initializer is a controller which enforces some system invariant at

477

# object creation time. This field is a list of initializers that have not

478

# yet acted on this object. If nil or empty, this object has been completely

479

# initialized. Otherwise, the object is considered uninitialized and is

480

# hidden (in list/watch and get calls) from clients that haven't explicitly

481

# asked to observe uninitialized objects.

482

#

483

# When an object is created, the system will populate this list with the

484

# current set of initializers. Only privileged users may set or modify this

485

# list. Once it is empty, it may not be modified further by any user.

486

"pending": [ # Pending is a list of initializers that must execute in order before this

487

# object is visible. When the last pending initializer is removed, and no

488

# failing result is set, the initializers struct will be set to nil and the

489

# object is considered as initialized and visible to all clients.

490

# +patchMergeKey=name

491

# +patchStrategy=merge

492

{ # Initializer is information about an initializer that has not yet completed.

493

"name": "A String", # name of the process that is responsible for initializing this object.

},

],

},

"resourceVersion": "A String", # An opaque value that represents the internal version of this object that

498

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

499

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

500

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

501

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

502

# particular resource or set of resources.

503

#

504

# Populated by the system.

505

# Read-only.

506

# Value must be treated as opaque by clients and .

507

# More info:

508

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

509

# +optional

510

"generateName": "A String", # Not currently supported by Cloud Run.

511

#

512

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

513

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

514

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

515

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

516

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

517

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

518

# server.

519

#

520

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

521

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

522

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

523

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

524

# indicated in the Retry-After header).

525

#

526

# Applied only if Name is not specified.

527

# More info:

528

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

529

# +optional

530

# string generateName = 2;

531

"creationTimestamp": "A String", # CreationTimestamp is a timestamp representing the server time when this

532

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

533

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

534

# represented in RFC3339 form and is in UTC.

535

#

536

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

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

541

# +optional

542

"annotations": { # Annotations is an unstructured key value map stored with a resource that

543

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

544

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

545

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

546

"a_key": "A String",

547

},

548

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

549

# Populated by the system.

550

# Read-only.

551

# +optional

552

# string selfLink = 4;

553

"uid": "A String", # UID is the unique in time and space value for this object. It is typically

554

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

555

# allowed to change on PUT operations.

556

#

557

# Populated by the system.

558

# Read-only.

559

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

# +optional

},

}</pre>

</div>

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

567

<pre>Rpc to delete a domain mapping.

568

569

Args:

570

name: string, The name of the domain mapping being deleted. If needed, replace

571

{namespace_id} with the project ID. (required)

572

kind: string, Cloud Run currently ignores this parameter.

573

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

574

this setting, and deletes in the background. Please see

575

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

576

more information.

577

orphanDependents: boolean, Deprecated.

578

Specifies the cascade behavior on delete.

579

Cloud Run only supports cascading behavior, so this must be false.

580

This attribute is deprecated, and is now replaced with PropagationPolicy

581

See https://github.com/kubernetes/kubernetes/issues/46659 for more info.

582

apiVersion: string, Cloud Run currently ignores this parameter.

583

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

590

591

{ # A generic empty message that you can re-use to avoid defining duplicated

592

# empty messages in your APIs. A typical example is to use it as the request

593

# or the response type of an API method. For instance:

594

#

595

# service Foo {

596

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

597

# }

598

#

599

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

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

605

<pre>Rpc to get information about a domain mapping.

606

607

Args:

608

name: string, The name of the domain mapping being retrieved. If needed, replace

609

{namespace_id} with the project ID. (required)

610

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

617

618

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

619

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

620

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

621

# was last processed by the controller.

622

#

623

# Clients polling for completed reconciliation should poll until

624

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

625

# is True or False.

626

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

627

# of the DomainMapping.

628

{ # DomainMappingCondition contains state information for a DomainMapping.

629

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

630

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

631

# +optional

632

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

633

# +optional

634

"reason": "A String", # One-word CamelCase reason for the condition's current status.

635

# +optional

636

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

637

# +optional

638

"type": "A String", # Type of domain mapping condition.

639

},

640

],

641

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

642

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

643

# serve the application via this domain mapping.

644

{ # A DNS resource record.

645

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

646

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

647

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

648

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

649

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

650

},

651

],

652

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

653

},

654

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

655

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

656

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

657

# The route must exist.

658

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

659

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

660

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

661

# has given such a warning.

662

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

663

},

664

"apiVersion": "A String", # The API version for this call such as "v1alpha1".

665

"metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this BuildTemplate.

666

# all objects users must create.

667

"ownerReferences": [ # List of objects that own this object. If ALL objects in the list have

668

# been deleted, this object will be garbage collected.

669

# +optional

670

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

671

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

672

# is no namespace field.

673

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

674

# More info:

675

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

676

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

677

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

678

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

679

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

680

# +optional

681

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

682

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

683

# reference is removed.

684

# Defaults to false.

685

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

686

# otherwise 422 (Unprocessable Entity) will be returned.

687

# +optional

688

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

689

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

690

},

691

],

692

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

693

# Is required when creating

694

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

695

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

696

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

697

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

698

# +optional

699

"deletionTimestamp": "A String", # DeletionTimestamp is RFC 3339 date and time at which this resource will be

700

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

701

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

702

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

703

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

704

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

705

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

706

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

707

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

708

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

709

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

710

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

711

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

712

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

713

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

714

# resource is fully terminated.

715

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

716

#

717

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

718

# Read-only.

719

# More info:

720

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

721

# +optional

722

"clusterName": "A String", # Not currently supported by Cloud Run.

723

#

724

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

725

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

726

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

727

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

728

"deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run.

729

#

730

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

731

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

732

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

733

"labels": { # Map of string keys and values that can be used to organize and categorize

734

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

735

# and routes.

736

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

# +optional

"a_key": "A String",

},

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

741

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

742

# project ID or project number.

743

"generation": 42, # A sequence number representing a specific generation of the desired state.

744

# Populated by the system. Read-only.

745

# +optional

746

"finalizers": [ # Not currently supported by Cloud Run.

747

#

748

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

749

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

750

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

751

# in this list can only be removed.

752

# +optional

753

# +patchStrategy=merge

754

"A String",

755

],

756

"initializers": { # Initializers tracks the progress of initialization. # Not currently supported by Cloud Run.

757

#

758

# An initializer is a controller which enforces some system invariant at

759

# object creation time. This field is a list of initializers that have not

760

# yet acted on this object. If nil or empty, this object has been completely

761

# initialized. Otherwise, the object is considered uninitialized and is

762

# hidden (in list/watch and get calls) from clients that haven't explicitly

763

# asked to observe uninitialized objects.

764

#

765

# When an object is created, the system will populate this list with the

766

# current set of initializers. Only privileged users may set or modify this

767

# list. Once it is empty, it may not be modified further by any user.

768

"pending": [ # Pending is a list of initializers that must execute in order before this

769

# object is visible. When the last pending initializer is removed, and no

770

# failing result is set, the initializers struct will be set to nil and the

771

# object is considered as initialized and visible to all clients.

772

# +patchMergeKey=name

773

# +patchStrategy=merge

774

{ # Initializer is information about an initializer that has not yet completed.

775

"name": "A String", # name of the process that is responsible for initializing this object.

},

],

},

"resourceVersion": "A String", # An opaque value that represents the internal version of this object that

780

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

781

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

782

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

783

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

784

# particular resource or set of resources.

785

#

786

# Populated by the system.

787

# Read-only.

788

# Value must be treated as opaque by clients and .

789

# More info:

790

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

791

# +optional

792

"generateName": "A String", # Not currently supported by Cloud Run.

793

#

794

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

795

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

796

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

797

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

798

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

799

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

800

# server.

801

#

802

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

803

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

804

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

805

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

806

# indicated in the Retry-After header).

807

#

808

# Applied only if Name is not specified.

809

# More info:

810

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

811

# +optional

812

# string generateName = 2;

813

"creationTimestamp": "A String", # CreationTimestamp is a timestamp representing the server time when this

814

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

815

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

816

# represented in RFC3339 form and is in UTC.

817

#

818

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

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

823

# +optional

824

"annotations": { # Annotations is an unstructured key value map stored with a resource that

825

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

826

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

827

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

828

"a_key": "A String",

829

},

830

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

831

# Populated by the system.

832

# Read-only.

833

# +optional

834

# string selfLink = 4;

835

"uid": "A String", # UID is the unique in time and space value for this object. It is typically

836

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

837

# allowed to change on PUT operations.

838

#

839

# Populated by the system.

840

# Read-only.

841

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

# +optional

},

}</pre>

</div>

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

849

<pre>Rpc to list domain mappings.

850

851

Args:

852

parent: string, The project ID or project number from which the domain mappings should be

853

listed. (required)

854

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

855

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

856

includeUninitialized: boolean, Not currently used by Cloud Run.

857

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

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

862

start. Not currently used by Cloud Run.

863

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

864

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

865

Not currently used by Cloud Run.

866

continue: string, Optional encoded string to continue paging.

867

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

868

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

869

Not currently used by Cloud Run.

870

871

Returns:

872

An object of the form:

873

874

{ # ListDomainMappingsResponse is a list of DomainMapping resources.

875

"items": [ # List of DomainMappings.

876

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

877

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

878

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

879

# was last processed by the controller.

880

#

881

# Clients polling for completed reconciliation should poll until

882

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

883

# is True or False.

884

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

885

# of the DomainMapping.

886

{ # DomainMappingCondition contains state information for a DomainMapping.

887

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

888

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

889

# +optional

890

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

891

# +optional

892

"reason": "A String", # One-word CamelCase reason for the condition's current status.

893

# +optional

894

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

895

# +optional

896

"type": "A String", # Type of domain mapping condition.

897

},

898

],

899

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

900

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

901

# serve the application via this domain mapping.

902

{ # A DNS resource record.

903

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

904

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

905

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

906

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

907

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

908

},

909

],

910

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

911

},

912

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

913

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

914

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

915

# The route must exist.

916

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

917

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

918

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

919

# has given such a warning.

920

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

921

},

922

"apiVersion": "A String", # The API version for this call such as "v1alpha1".

923

"metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this BuildTemplate.

924

# all objects users must create.

925

"ownerReferences": [ # List of objects that own this object. If ALL objects in the list have

926

# been deleted, this object will be garbage collected.

927

# +optional

928

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

929

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

930

# is no namespace field.

931

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

932

# More info:

933

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

934

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

935

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

936

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

937

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

938

# +optional

939

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

940

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

941

# reference is removed.

942

# Defaults to false.

943

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

944

# otherwise 422 (Unprocessable Entity) will be returned.

945

# +optional

946

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

947

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

948

},

949

],

950

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

951

# Is required when creating

952

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

953

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

954

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

955

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

956

# +optional

957

"deletionTimestamp": "A String", # DeletionTimestamp is RFC 3339 date and time at which this resource will be

958

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

959

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

960

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

961

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

962

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

963

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

964

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

965

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

966

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

967

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

968

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

969

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

970

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

971

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

972

# resource is fully terminated.

973

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

974

#

975

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

976

# Read-only.

977

# More info:

978

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

979

# +optional

980

"clusterName": "A String", # Not currently supported by Cloud Run.

981

#

982

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

983

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

984

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

985

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

986

"deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run.

987

#

988

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

989

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

990

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

991

"labels": { # Map of string keys and values that can be used to organize and categorize

992

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

993

# and routes.

994

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

# +optional

"a_key": "A String",

},

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

999

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

1000

# project ID or project number.

1001

"generation": 42, # A sequence number representing a specific generation of the desired state.

1002

# Populated by the system. Read-only.

1003

# +optional

1004

"finalizers": [ # Not currently supported by Cloud Run.

1005

#

1006

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

1007

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

1008

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

1009

# in this list can only be removed.

1010

# +optional

1011

# +patchStrategy=merge

1012

"A String",

1013

],

1014

"initializers": { # Initializers tracks the progress of initialization. # Not currently supported by Cloud Run.

1015

#

1016

# An initializer is a controller which enforces some system invariant at

1017

# object creation time. This field is a list of initializers that have not

1018

# yet acted on this object. If nil or empty, this object has been completely

1019

# initialized. Otherwise, the object is considered uninitialized and is

1020

# hidden (in list/watch and get calls) from clients that haven't explicitly

1021

# asked to observe uninitialized objects.

1022

#

1023

# When an object is created, the system will populate this list with the

1024

# current set of initializers. Only privileged users may set or modify this

1025

# list. Once it is empty, it may not be modified further by any user.

1026

"pending": [ # Pending is a list of initializers that must execute in order before this

1027

# object is visible. When the last pending initializer is removed, and no

1028

# failing result is set, the initializers struct will be set to nil and the

1029

# object is considered as initialized and visible to all clients.

1030

# +patchMergeKey=name

1031

# +patchStrategy=merge

1032

{ # Initializer is information about an initializer that has not yet completed.

1033

"name": "A String", # name of the process that is responsible for initializing this object.

},

],

},

"resourceVersion": "A String", # An opaque value that represents the internal version of this object that

1038

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

1039

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

1040

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

1041

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

1042

# particular resource or set of resources.

1043

#

1044

# Populated by the system.

1045

# Read-only.

1046

# Value must be treated as opaque by clients and .

1047

# More info:

1048

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

1049

# +optional

1050

"generateName": "A String", # Not currently supported by Cloud Run.

1051

#

1052

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

1053

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

1054

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

1055

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

1056

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

1057

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

1058

# server.

1059

#

1060

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

1061

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

1062

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

1063

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

1064

# indicated in the Retry-After header).

1065

#

1066

# Applied only if Name is not specified.

1067

# More info:

1068

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

1069

# +optional

1070

# string generateName = 2;

1071

"creationTimestamp": "A String", # CreationTimestamp is a timestamp representing the server time when this

1072

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

1073

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

1074

# represented in RFC3339 form and is in UTC.

1075

#

1076

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

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

1081

# +optional

1082

"annotations": { # Annotations is an unstructured key value map stored with a resource that

1083

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

1084

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

1085

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

1086

"a_key": "A String",

1087

},

1088

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

1089

# Populated by the system.

1090

# Read-only.

1091

# +optional

1092

# string selfLink = 4;

1093

"uid": "A String", # UID is the unique in time and space value for this object. It is typically

1094

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

1095

# allowed to change on PUT operations.

1096

#

1097

# Populated by the system.

1098

# Read-only.

1099

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

# +optional

},

},

],

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

1105

"apiVersion": "A String", # The API version for this call such as "v1alpha1".

1106

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

1107

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

1108

# {ObjectMeta, ListMeta}.

1109

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

1110

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

1111

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

1112

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

1113

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

1114

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

1115

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

1116

# response.

1117

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

1118

# Populated by the system.

1119

# Read-only.

1120

# +optional

1121

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

1122

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

1123

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

1124

# Populated by the system.

1125

# Read-only.

1126

# More info:

1127

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

# +optional

},

}</pre>

</div>

</body></html>