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

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

76

<h2>Instance Methods</h2>

77

78

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

79

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

80

81

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

82

<p class="firstline">List routes.</p>

83

<h3>Method Details</h3>

84

85

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

86

<pre>Get information about a route.

87

88

Args:

89

name: string, The name of the route to retrieve.

90

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

91

or number. (required)

92

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

99

100

{ # Route is responsible for configuring ingress over a collection of Revisions.

101

# Some of the Revisions a Route distributes traffic over may be specified by

102

# referencing the Configuration responsible for creating them; in these cases

103

# the Route is additionally responsible for monitoring the Configuration for

104

# "latest ready" revision changes, and smoothly rolling out latest revisions.

105

# See also:

106

# https://github.com/knative/serving/blob/master/docs/spec/overview.md#route

107

#

108

# Cloud Run currently supports referencing a single Configuration to

109

# automatically deploy the "latest ready" Revision from that Configuration.

110

"status": { # RouteStatus communicates the observed state of the Route (from the # Status communicates the observed state of the Route (from the controller).

111

# controller).

112

"conditions": [ # Conditions communicates information about ongoing/complete

113

# reconciliation processes that bring the "spec" inline with the observed

114

# state of the world.

115

{ # Condition defines a generic condition for a Resource

116

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

117

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

118

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

119

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

120

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

121

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

122

# See also:

123

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

124

# Types common to all resources include:

125

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

126

},

127

],

128

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

129

# was last processed by the controller.

130

#

131

# Clients polling for completed reconciliation should poll until

132

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

133

# is True or False.

134

#

135

# Note that providing a trafficTarget that only has a configurationName will

136

# result in a Route that does not increment either its metadata.generation or

137

# its observedGeneration, as new "latest ready" revisions from the

138

# Configuration are processed without an update to the Route's spec.

139

"address": { # Information for connecting over HTTP(s). # Similar to url, information on where the service is available on HTTP.

140

"url": "A String",

141

},

142

"url": "A String", # URL holds the url that will distribute traffic over the provided traffic

143

# targets. It generally has the form:

144

# https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app

145

"traffic": [ # Traffic holds the configured traffic distribution.

146

# These entries will always contain RevisionName references.

147

# When ConfigurationName appears in the spec, this will hold the

148

# LatestReadyRevisionName that we last observed.

149

{ # TrafficTarget holds a single entry of the routing table for a Route.

150

"url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL

151

# is displayed in status, and is disallowed on spec. URL must contain a

152

# scheme (e.g. http://) and a hostname, but may not contain anything else

153

# (e.g. basic auth, url path, etc.

154

#

155

# Not currently supported in Cloud Run.

156

"configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will

157

# send this portion of traffic. When the "status.latestReadyRevisionName"

158

# of the referenced configuration changes, we will automatically migrate

159

# traffic from the prior "latest ready" revision to the new one. This field

160

# is never set in Route's status, only its spec. This is mutually exclusive

161

# with RevisionName.

162

#

163

# Cloud Run currently supports a single ConfigurationName.

164

"percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration.

165

# This defaults to zero if unspecified.

166

#

167

# Cloud Run currently requires 100 percent for a single ConfigurationName

168

# TrafficTarget entry.

169

"revisionName": "A String", # RevisionName of a specific revision to which to send this portion of

170

# traffic. This is mutually exclusive with ConfigurationName.

171

#

172

# Providing RevisionName in spec is not currently supported by Cloud Run.

173

"latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest

174

# ready Revision of the Configuration should be used for this traffic

175

# target. When provided LatestRevision must be true if RevisionName is

176

# empty; it must be false when RevisionName is non-empty.

177

#

178

# +optional

179

"tag": "A String", # Tag is optionally used to expose a dedicated url for referencing

180

# this target exclusively.

181

#

182

# Not currently supported in Cloud Run.

# +optional

},

],

},

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1".

188

"spec": { # RouteSpec holds the desired state of the Route (from the client). # Spec holds the desired state of the Route (from the client).

189

"traffic": [ # Traffic specifies how to distribute traffic over a collection of Knative

190

# Revisions and Configurations.

191

# Cloud Run currently supports a single configurationName.

192

{ # TrafficTarget holds a single entry of the routing table for a Route.

193

"url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL

194

# is displayed in status, and is disallowed on spec. URL must contain a

195

# scheme (e.g. http://) and a hostname, but may not contain anything else

196

# (e.g. basic auth, url path, etc.

197

#

198

# Not currently supported in Cloud Run.

199

"configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will

200

# send this portion of traffic. When the "status.latestReadyRevisionName"

201

# of the referenced configuration changes, we will automatically migrate

202

# traffic from the prior "latest ready" revision to the new one. This field

203

# is never set in Route's status, only its spec. This is mutually exclusive

204

# with RevisionName.

205

#

206

# Cloud Run currently supports a single ConfigurationName.

207

"percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration.

208

# This defaults to zero if unspecified.

209

#

210

# Cloud Run currently requires 100 percent for a single ConfigurationName

211

# TrafficTarget entry.

212

"revisionName": "A String", # RevisionName of a specific revision to which to send this portion of

213

# traffic. This is mutually exclusive with ConfigurationName.

214

#

215

# Providing RevisionName in spec is not currently supported by Cloud Run.

216

"latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest

217

# ready Revision of the Configuration should be used for this traffic

218

# target. When provided LatestRevision must be true if RevisionName is

219

# empty; it must be false when RevisionName is non-empty.

220

#

221

# +optional

222

"tag": "A String", # Tag is optionally used to expose a dedicated url for referencing

223

# this target exclusively.

224

#

225

# Not currently supported in Cloud Run.

# +optional

},

],

},

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

231

"metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this Route, including name, namespace, labels,

232

# and annotations.

233

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

234

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

235

#

236

# CreationTimestamp is a timestamp representing the server time when this

237

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

238

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

239

# represented in RFC3339 form and is in UTC.

240

#

241

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

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

246

"labels": { # (Optional)

247

#

248

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

249

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

250

# and routes.

251

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

252

"a_key": "A String",

253

},

254

"generation": 42, # (Optional)

255

#

256

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

257

# Populated by the system. Read-only.

258

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

259

#

260

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

261

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

262

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

263

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

264

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

265

# particular resource or set of resources.

266

#

267

# Populated by the system.

268

# Read-only.

269

# Value must be treated as opaque by clients and .

270

# More info:

271

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

272

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

273

#

274

# SelfLink is a URL representing this object.

275

# Populated by the system.

276

# Read-only.

277

# string selfLink = 4;

278

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

279

#

280

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

281

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

282

# allowed to change on PUT operations.

283

#

284

# Populated by the system.

285

# Read-only.

286

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

287

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

288

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

289

# project ID or project number.

290

"annotations": { # (Optional)

291

#

292

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

293

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

294

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

295

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

296

"a_key": "A String",

297

},

298

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

299

#

300

# Cloud Run fully managed: not supported

301

#

302

# Cloud Run for Anthos: supported

303

#

304

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

305

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

306

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

307

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

308

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

309

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

310

# server.

311

#

312

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

313

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

314

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

315

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

316

# indicated in the Retry-After header).

317

#

318

# Applied only if Name is not specified.

319

# More info:

320

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

321

# string generateName = 2;

322

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

323

# Is required when creating

324

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

325

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

326

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

327

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

328

# +optional

329

"deletionGracePeriodSeconds": 42, # (Optional)

330

#

331

# Cloud Run fully managed: not supported

332

#

333

# Cloud Run for Anthos: supported

334

#

335

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

336

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

337

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

338

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

339

#

340

# Cloud Run fully managed: not supported

341

#

342

# Cloud Run for Anthos: supported

343

#

344

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

345

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

346

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

347

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

348

"finalizers": [ # (Optional)

349

#

350

# Cloud Run fully managed: not supported

351

#

352

# Cloud Run for Anthos: supported

353

#

354

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

355

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

356

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

357

# in this list can only be removed.

358

# +patchStrategy=merge

359

"A String",

360

],

361

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

362

#

363

# Cloud Run fully managed: not supported

364

#

365

# Cloud Run for Anthos: supported

366

#

367

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

368

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

369

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

370

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

371

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

372

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

373

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

374

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

375

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

376

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

377

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

378

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

379

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

380

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

381

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

382

# resource is fully terminated.

383

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

384

#

385

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

386

# Read-only.

387

# More info:

388

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

389

"ownerReferences": [ # (Optional)

390

#

391

# Cloud Run fully managed: not supported

392

#

393

# Cloud Run for Anthos: supported

394

#

395

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

396

# been deleted, this object will be garbage collected.

397

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

398

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

399

# is no namespace field.

400

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

401

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

402

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

403

# +optional

404

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

405

# More info:

406

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

407

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

408

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

409

# reference is removed.

410

# Defaults to false.

411

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

412

# otherwise 422 (Unprocessable Entity) will be returned.

413

# +optional

414

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

415

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

416

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

},

],

},

}</pre>

</div>

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

<pre>List routes.

Args:

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

429

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

430

or number. (required)

431

continue: string, Optional encoded string to continue paging.

432

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

433

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

434

Not currently used by Cloud Run.

435

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

436

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

437

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

438

start. Not currently used by Cloud Run.

439

includeUninitialized: boolean, Not currently used by Cloud Run.

440

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

441

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

442

Not currently used by Cloud Run.

443

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

450

451

{ # ListRoutesResponse is a list of Route resources.

452

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

453

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

454

"A String",

455

],

456

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

457

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

458

# {ObjectMeta, ListMeta}.

459

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

460

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

461

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

462

# Populated by the system.

463

# Read-only.

464

# More info:

465

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

466

# +optional

467

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

468

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

469

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

470

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

471

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

472

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

473

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

474

# response.

475

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

476

# Populated by the system.

# Read-only.

# +optional

},

"items": [ # List of Routes.

481

{ # Route is responsible for configuring ingress over a collection of Revisions.

482

# Some of the Revisions a Route distributes traffic over may be specified by

483

# referencing the Configuration responsible for creating them; in these cases

484

# the Route is additionally responsible for monitoring the Configuration for

485

# "latest ready" revision changes, and smoothly rolling out latest revisions.

486

# See also:

487

# https://github.com/knative/serving/blob/master/docs/spec/overview.md#route

488

#

489

# Cloud Run currently supports referencing a single Configuration to

490

# automatically deploy the "latest ready" Revision from that Configuration.

491

"status": { # RouteStatus communicates the observed state of the Route (from the # Status communicates the observed state of the Route (from the controller).

492

# controller).

493

"conditions": [ # Conditions communicates information about ongoing/complete

494

# reconciliation processes that bring the "spec" inline with the observed

495

# state of the world.

496

{ # Condition defines a generic condition for a Resource

497

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

498

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

499

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

500

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

501

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

502

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

503

# See also:

504

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

505

# Types common to all resources include:

506

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

507

},

508

],

509

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

510

# was last processed by the controller.

511

#

512

# Clients polling for completed reconciliation should poll until

513

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

514

# is True or False.

515

#

516

# Note that providing a trafficTarget that only has a configurationName will

517

# result in a Route that does not increment either its metadata.generation or

518

# its observedGeneration, as new "latest ready" revisions from the

519

# Configuration are processed without an update to the Route's spec.

520

"address": { # Information for connecting over HTTP(s). # Similar to url, information on where the service is available on HTTP.

521

"url": "A String",

522

},

523

"url": "A String", # URL holds the url that will distribute traffic over the provided traffic

524

# targets. It generally has the form:

525

# https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app

526

"traffic": [ # Traffic holds the configured traffic distribution.

527

# These entries will always contain RevisionName references.

528

# When ConfigurationName appears in the spec, this will hold the

529

# LatestReadyRevisionName that we last observed.

530

{ # TrafficTarget holds a single entry of the routing table for a Route.

531

"url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL

532

# is displayed in status, and is disallowed on spec. URL must contain a

533

# scheme (e.g. http://) and a hostname, but may not contain anything else

534

# (e.g. basic auth, url path, etc.

535

#

536

# Not currently supported in Cloud Run.

537

"configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will

538

# send this portion of traffic. When the "status.latestReadyRevisionName"

539

# of the referenced configuration changes, we will automatically migrate

540

# traffic from the prior "latest ready" revision to the new one. This field

541

# is never set in Route's status, only its spec. This is mutually exclusive

542

# with RevisionName.

543

#

544

# Cloud Run currently supports a single ConfigurationName.

545

"percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration.

546

# This defaults to zero if unspecified.

547

#

548

# Cloud Run currently requires 100 percent for a single ConfigurationName

549

# TrafficTarget entry.

550

"revisionName": "A String", # RevisionName of a specific revision to which to send this portion of

551

# traffic. This is mutually exclusive with ConfigurationName.

552

#

553

# Providing RevisionName in spec is not currently supported by Cloud Run.

554

"latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest

555

# ready Revision of the Configuration should be used for this traffic

556

# target. When provided LatestRevision must be true if RevisionName is

557

# empty; it must be false when RevisionName is non-empty.

558

#

559

# +optional

560

"tag": "A String", # Tag is optionally used to expose a dedicated url for referencing

561

# this target exclusively.

562

#

563

# Not currently supported in Cloud Run.

# +optional

},

],

},

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1".

569

"spec": { # RouteSpec holds the desired state of the Route (from the client). # Spec holds the desired state of the Route (from the client).

570

"traffic": [ # Traffic specifies how to distribute traffic over a collection of Knative

571

# Revisions and Configurations.

572

# Cloud Run currently supports a single configurationName.

573

{ # TrafficTarget holds a single entry of the routing table for a Route.

574

"url": "A String", # Output only. URL displays the URL for accessing tagged traffic targets. URL

575

# is displayed in status, and is disallowed on spec. URL must contain a

576

# scheme (e.g. http://) and a hostname, but may not contain anything else

577

# (e.g. basic auth, url path, etc.

578

#

579

# Not currently supported in Cloud Run.

580

"configurationName": "A String", # ConfigurationName of a configuration to whose latest revision we will

581

# send this portion of traffic. When the "status.latestReadyRevisionName"

582

# of the referenced configuration changes, we will automatically migrate

583

# traffic from the prior "latest ready" revision to the new one. This field

584

# is never set in Route's status, only its spec. This is mutually exclusive

585

# with RevisionName.

586

#

587

# Cloud Run currently supports a single ConfigurationName.

588

"percent": 42, # Percent specifies percent of the traffic to this Revision or Configuration.

589

# This defaults to zero if unspecified.

590

#

591

# Cloud Run currently requires 100 percent for a single ConfigurationName

592

# TrafficTarget entry.

593

"revisionName": "A String", # RevisionName of a specific revision to which to send this portion of

594

# traffic. This is mutually exclusive with ConfigurationName.

595

#

596

# Providing RevisionName in spec is not currently supported by Cloud Run.

597

"latestRevision": True or False, # LatestRevision may be optionally provided to indicate that the latest

598

# ready Revision of the Configuration should be used for this traffic

599

# target. When provided LatestRevision must be true if RevisionName is

600

# empty; it must be false when RevisionName is non-empty.

601

#

602

# +optional

603

"tag": "A String", # Tag is optionally used to expose a dedicated url for referencing

604

# this target exclusively.

605

#

606

# Not currently supported in Cloud Run.

# +optional

},

],

},

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

612

"metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this Route, including name, namespace, labels,

613

# and annotations.

614

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

615

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

616

#

617

# CreationTimestamp is a timestamp representing the server time when this

618

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

619

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

620

# represented in RFC3339 form and is in UTC.

621

#

622

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

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

627

"labels": { # (Optional)

628

#

629

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

630

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

631

# and routes.

632

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

633

"a_key": "A String",

634

},

635

"generation": 42, # (Optional)

636

#

637

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

638

# Populated by the system. Read-only.

639

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

640

#

641

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

642

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

643

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

644

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

645

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

646

# particular resource or set of resources.

647

#

648

# Populated by the system.

649

# Read-only.

650

# Value must be treated as opaque by clients and .

651

# More info:

652

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

653

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

654

#

655

# SelfLink is a URL representing this object.

656

# Populated by the system.

657

# Read-only.

658

# string selfLink = 4;

659

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

660

#

661

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

662

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

663

# allowed to change on PUT operations.

664

#

665

# Populated by the system.

666

# Read-only.

667

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

668

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

669

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

670

# project ID or project number.

671

"annotations": { # (Optional)

672

#

673

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

674

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

675

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

676

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

677

"a_key": "A String",

678

},

679

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

680

#

681

# Cloud Run fully managed: not supported

682

#

683

# Cloud Run for Anthos: supported

684

#

685

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

686

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

687

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

688

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

689

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

690

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

691

# server.

692

#

693

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

694

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

695

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

696

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

697

# indicated in the Retry-After header).

698

#

699

# Applied only if Name is not specified.

700

# More info:

701

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

702

# string generateName = 2;

703

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

704

# Is required when creating

705

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

706

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

707

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

708

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

709

# +optional

710

"deletionGracePeriodSeconds": 42, # (Optional)

711

#

712

# Cloud Run fully managed: not supported

713

#

714

# Cloud Run for Anthos: supported

715

#

716

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

717

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

718

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

719

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

720

#

721

# Cloud Run fully managed: not supported

722

#

723

# Cloud Run for Anthos: supported

724

#

725

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

726

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

727

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

728

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

729

"finalizers": [ # (Optional)

730

#

731

# Cloud Run fully managed: not supported

732

#

733

# Cloud Run for Anthos: supported

734

#

735

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

736

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

737

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

738

# in this list can only be removed.

739

# +patchStrategy=merge

740

"A String",

741

],

742

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

743

#

744

# Cloud Run fully managed: not supported

745

#

746

# Cloud Run for Anthos: supported

747

#

748

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

749

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

750

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

751

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

752

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

753

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

754

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

755

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

756

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

757

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

758

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

759

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

760

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

761

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

762

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

763

# resource is fully terminated.

764

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

765

#

766

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

767

# Read-only.

768

# More info:

769

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

770

"ownerReferences": [ # (Optional)

771

#

772

# Cloud Run fully managed: not supported

773

#

774

# Cloud Run for Anthos: supported

775

#

776

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

777

# been deleted, this object will be garbage collected.

778

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

779

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

780

# is no namespace field.

781

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

782

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

783

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

784

# +optional

785

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

786

# More info:

787

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

788

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

789

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

790

# reference is removed.

791

# Defaults to false.

792

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

793

# otherwise 422 (Unprocessable Entity) will be returned.

794

# +optional

795

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

796

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

797

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

},

],

},

},

],

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1".

}</pre>

</div>

</body></html>