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

Dan O'Meara

dd49464

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

[diff] [blame^]

78

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

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

Dan O'Meara

dd49464

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

[diff] [blame^]

91

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

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)

Dan O'Meara

dd49464

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

[diff] [blame^]

97

body: object, The request body.

Bu Sun Kim

715bd7f

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

[diff] [blame]

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

},

Dan O'Meara

dd49464

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

[diff] [blame^]

146

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

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

Dan O'Meara

dd49464

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

[diff] [blame^]

158

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

159

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

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

Dan O'Meara

dd49464

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

[diff] [blame^]

170

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

171

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

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

],

Bu Sun Kim

715bd7f

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

[diff] [blame]

238

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

239

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

240

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

241

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

242

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

243

# particular resource or set of resources.

244

#

245

# Populated by the system.

246

# Read-only.

247

# Value must be treated as opaque by clients and .

248

# More info:

249

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

250

# +optional

251

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

252

#

253

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

254

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

255

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

256

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

257

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

258

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

259

# server.

260

#

261

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

262

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

263

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

264

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

265

# indicated in the Retry-After header).

266

#

267

# Applied only if Name is not specified.

268

# More info:

269

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

270

# +optional

271

# string generateName = 2;

272

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

273

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

274

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

275

# represented in RFC3339 form and is in UTC.

276

#

277

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

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

282

# +optional

283

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

284

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

285

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

286

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

287

"a_key": "A String",

288

},

289

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

290

# Populated by the system.

291

# Read-only.

292

# +optional

293

# string selfLink = 4;

294

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

295

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

296

# allowed to change on PUT operations.

297

#

298

# Populated by the system.

299

# Read-only.

300

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

312

313

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

314

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

315

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

316

# was last processed by the controller.

317

#

318

# Clients polling for completed reconciliation should poll until

319

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

320

# is True or False.

321

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

322

# of the DomainMapping.

323

{ # DomainMappingCondition contains state information for a DomainMapping.

324

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

325

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

326

# +optional

327

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

328

# +optional

329

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

330

# +optional

331

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

332

# +optional

333

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

334

},

335

],

336

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

337

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

338

# serve the application via this domain mapping.

339

{ # A DNS resource record.

340

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

341

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

342

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

343

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

344

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

345

},

346

],

347

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

348

},

349

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

350

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

351

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

352

# The route must exist.

353

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

354

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

355

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

356

# has given such a warning.

357

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

358

},

Dan O'Meara

dd49464

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

[diff] [blame^]

359

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

360

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

361

# all objects users must create.

362

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

363

# been deleted, this object will be garbage collected.

364

# +optional

365

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

366

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

367

# is no namespace field.

368

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

369

# More info:

370

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

Dan O'Meara

dd49464

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

[diff] [blame^]

371

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

372

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

373

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

374

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

375

# +optional

376

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

377

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

378

# reference is removed.

379

# Defaults to false.

380

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

381

# otherwise 422 (Unprocessable Entity) will be returned.

382

# +optional

Dan O'Meara

dd49464

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

[diff] [blame^]

383

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

384

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

385

},

386

],

387

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

388

# Is required when creating

389

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

390

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

391

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

392

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

393

# +optional

394

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

395

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

396

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

397

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

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

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

406

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

407

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

408

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

409

# resource is fully terminated.

410

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

411

#

412

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

413

# Read-only.

414

# More info:

415

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

416

# +optional

417

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

418

#

419

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

420

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

421

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

422

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

423

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

424

#

425

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

426

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

427

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

428

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

429

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

430

# and routes.

431

# 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

436

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

437

# project ID or project number.

438

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

439

# Populated by the system. Read-only.

440

# +optional

441

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

442

#

443

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

444

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

445

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

446

# in this list can only be removed.

447

# +optional

448

# +patchStrategy=merge

449

"A String",

450

],

Bu Sun Kim

715bd7f

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

[diff] [blame]

451

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

452

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

453

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

454

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

455

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

456

# particular resource or set of resources.

457

#

458

# Populated by the system.

459

# Read-only.

460

# Value must be treated as opaque by clients and .

461

# More info:

462

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

463

# +optional

464

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

465

#

466

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

467

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

468

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

469

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

470

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

471

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

472

# server.

473

#

474

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

475

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

476

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

477

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

478

# indicated in the Retry-After header).

479

#

480

# Applied only if Name is not specified.

481

# More info:

482

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

483

# +optional

484

# string generateName = 2;

485

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

486

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

487

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

488

# represented in RFC3339 form and is in UTC.

489

#

490

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

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

495

# +optional

496

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

497

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

498

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

499

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

500

"a_key": "A String",

501

},

502

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

503

# Populated by the system.

504

# Read-only.

505

# +optional

506

# string selfLink = 4;

507

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

508

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

509

# allowed to change on PUT operations.

510

#

511

# Populated by the system.

512

# Read-only.

513

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

521

<pre>Rpc to delete a domain mapping.

522

523

Args:

524

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

525

{namespace_id} with the project ID. (required)

526

kind: string, Cloud Run currently ignores this parameter.

527

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

528

this setting, and deletes in the background. Please see

529

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

530

more information.

531

orphanDependents: boolean, Deprecated.

532

Specifies the cascade behavior on delete.

533

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

534

This attribute is deprecated, and is now replaced with PropagationPolicy

535

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

536

apiVersion: string, Cloud Run currently ignores this parameter.

537

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

544

545

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

546

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

547

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

548

#

549

# service Foo {

550

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

551

# }

552

#

553

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

}</pre>

</div>

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

559

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

560

561

Args:

562

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

563

{namespace_id} with the project ID. (required)

564

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

571

572

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

573

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

574

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

575

# was last processed by the controller.

576

#

577

# Clients polling for completed reconciliation should poll until

578

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

579

# is True or False.

580

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

581

# of the DomainMapping.

582

{ # DomainMappingCondition contains state information for a DomainMapping.

583

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

584

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

585

# +optional

586

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

587

# +optional

588

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

589

# +optional

590

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

591

# +optional

592

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

593

},

594

],

595

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

596

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

597

# serve the application via this domain mapping.

598

{ # A DNS resource record.

599

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

600

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

601

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

602

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

603

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

604

},

605

],

606

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

607

},

608

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

609

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

610

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

611

# The route must exist.

612

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

613

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

614

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

615

# has given such a warning.

616

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

617

},

Dan O'Meara

dd49464

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

[diff] [blame^]

618

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

619

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

620

# all objects users must create.

621

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

622

# been deleted, this object will be garbage collected.

623

# +optional

624

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

625

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

626

# is no namespace field.

627

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

628

# More info:

629

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

Dan O'Meara

dd49464

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

[diff] [blame^]

630

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

631

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

632

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

633

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

634

# +optional

635

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

636

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

637

# reference is removed.

638

# Defaults to false.

639

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

640

# otherwise 422 (Unprocessable Entity) will be returned.

641

# +optional

Dan O'Meara

dd49464

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

[diff] [blame^]

642

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

643

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

644

},

645

],

646

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

647

# Is required when creating

648

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

649

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

650

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

651

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

652

# +optional

653

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

654

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

655

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

656

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

657

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

658

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

659

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

660

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

661

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

662

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

663

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

664

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

665

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

666

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

667

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

668

# resource is fully terminated.

669

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

670

#

671

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

672

# Read-only.

673

# More info:

674

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

675

# +optional

676

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

677

#

678

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

679

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

680

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

681

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

682

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

683

#

684

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

685

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

686

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

687

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

688

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

689

# and routes.

690

# 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

695

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

696

# project ID or project number.

697

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

698

# Populated by the system. Read-only.

699

# +optional

700

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

701

#

702

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

703

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

704

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

705

# in this list can only be removed.

706

# +optional

707

# +patchStrategy=merge

708

"A String",

709

],

Bu Sun Kim

715bd7f

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

[diff] [blame]

710

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

711

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

712

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

713

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

714

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

715

# particular resource or set of resources.

716

#

717

# Populated by the system.

718

# Read-only.

719

# Value must be treated as opaque by clients and .

720

# More info:

721

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

722

# +optional

723

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

724

#

725

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

726

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

727

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

728

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

729

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

730

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

731

# server.

732

#

733

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

734

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

735

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

736

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

737

# indicated in the Retry-After header).

738

#

739

# Applied only if Name is not specified.

740

# More info:

741

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

742

# +optional

743

# string generateName = 2;

744

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

745

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

746

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

747

# represented in RFC3339 form and is in UTC.

748

#

749

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

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

754

# +optional

755

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

756

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

757

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

758

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

759

"a_key": "A String",

760

},

761

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

762

# Populated by the system.

763

# Read-only.

764

# +optional

765

# string selfLink = 4;

766

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

767

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

768

# allowed to change on PUT operations.

769

#

770

# Populated by the system.

771

# Read-only.

772

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

780

<pre>Rpc to list domain mappings.

781

782

Args:

783

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

784

listed. (required)

785

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

786

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

787

includeUninitialized: boolean, Not currently used by Cloud Run.

788

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

793

start. Not currently used by Cloud Run.

794

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

795

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

796

Not currently used by Cloud Run.

797

continue: string, Optional encoded string to continue paging.

798

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

799

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

800

Not currently used by Cloud Run.

801

802

Returns:

803

An object of the form:

804

805

{ # ListDomainMappingsResponse is a list of DomainMapping resources.

Dan O'Meara

dd49464

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

[diff] [blame^]

806

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

807

"A String",

808

],

809

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

810

"items": [ # List of DomainMappings.

811

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

812

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

813

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

814

# was last processed by the controller.

815

#

816

# Clients polling for completed reconciliation should poll until

817

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

818

# is True or False.

819

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

820

# of the DomainMapping.

821

{ # DomainMappingCondition contains state information for a DomainMapping.

822

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

823

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

824

# +optional

825

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

826

# +optional

827

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

828

# +optional

829

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

830

# +optional

831

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

832

},

833

],

834

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

835

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

836

# serve the application via this domain mapping.

837

{ # A DNS resource record.

838

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

839

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

840

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

841

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

842

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

843

},

844

],

845

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

846

},

847

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

848

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

849

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

850

# The route must exist.

851

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

852

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

853

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

854

# has given such a warning.

855

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

856

},

Dan O'Meara

dd49464

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

[diff] [blame^]

857

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

858

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

859

# all objects users must create.

860

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

861

# been deleted, this object will be garbage collected.

862

# +optional

863

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

864

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

865

# is no namespace field.

866

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

867

# More info:

868

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

Dan O'Meara

dd49464

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

[diff] [blame^]

869

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

870

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

871

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

872

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

873

# +optional

874

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

875

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

876

# reference is removed.

877

# Defaults to false.

878

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

879

# otherwise 422 (Unprocessable Entity) will be returned.

880

# +optional

Dan O'Meara

dd49464

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

[diff] [blame^]

881

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

882

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

883

},

884

],

885

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

886

# Is required when creating

887

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

888

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

889

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

890

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

891

# +optional

892

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

893

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

894

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

895

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

896

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

897

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

898

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

899

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

900

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

901

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

902

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

903

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

904

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

905

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

906

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

907

# resource is fully terminated.

908

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

909

#

910

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

911

# Read-only.

912

# More info:

913

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

914

# +optional

915

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

916

#

917

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

918

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

919

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

920

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

921

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

922

#

923

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

924

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

925

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

926

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

927

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

928

# and routes.

929

# 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

934

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

935

# project ID or project number.

936

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

937

# Populated by the system. Read-only.

938

# +optional

939

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

940

#

941

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

942

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

943

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

944

# in this list can only be removed.

945

# +optional

946

# +patchStrategy=merge

947

"A String",

948

],

Bu Sun Kim

715bd7f

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

[diff] [blame]

949

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

950

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

951

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

952

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

953

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

954

# particular resource or set of resources.

955

#

956

# Populated by the system.

957

# Read-only.

958

# Value must be treated as opaque by clients and .

959

# More info:

960

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

961

# +optional

962

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

963

#

964

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

965

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

966

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

967

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

968

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

969

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

970

# server.

971

#

972

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

973

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

974

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

975

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

976

# indicated in the Retry-After header).

977

#

978

# Applied only if Name is not specified.

979

# More info:

980

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

981

# +optional

982

# string generateName = 2;

983

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

984

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

985

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

986

# represented in RFC3339 form and is in UTC.

987

#

988

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

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

993

# +optional

994

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

995

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

996

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

997

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

998

"a_key": "A String",

999

},

1000

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

1001

# Populated by the system.

1002

# Read-only.

1003

# +optional

1004

# string selfLink = 4;

1005

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

1006

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

1007

# allowed to change on PUT operations.

1008

#

1009

# Populated by the system.

1010

# Read-only.

1011

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

# +optional

},

},

],

Dan O'Meara

dd49464

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

[diff] [blame^]

1016

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

1017

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

1018

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

1019

# {ObjectMeta, ListMeta}.

1020

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

1021

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

1022

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

1023

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

1024

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

1025

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

1026

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

1027

# response.

1028

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

1029

# Populated by the system.

1030

# Read-only.

1031

# +optional

1032

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

1033

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

1034

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

1035

# Populated by the system.

1036

# Read-only.

1037

# More info:

1038

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

# +optional

},

}</pre>

</div>

</body></html>