Blame - docs/dyn/run_v1alpha1.namespaces.routes.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.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">Rpc to get information about a route.</p>

80

81

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

82

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

83

<h3>Method Details</h3>

84

85

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

86

<pre>Rpc to get information about a route.

87

88

Args:

89

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

90

{namespace_id} with the project ID. (required)

91

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

98

99

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

100

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

101

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

102

# the Route is additionally responsible for monitoring the Configuration for

103

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

104

# See also:

105

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

106

#

107

# Cloud Run currently supports referencing a single Configuration to

108

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

109

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

110

# controller).

Dan O'Meara

dd49464

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

[diff] [blame^]

111

"domain": "A String", # Deprecated - use url instead.

112

# Domain holds the top-level domain that will distribute traffic over the

113

# provided targets.

Bu Sun Kim

715bd7f

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

[diff] [blame]

114

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

115

# was last processed by the controller.

116

#

117

# Clients polling for completed reconciliation should poll until

118

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

119

# is True or False.

120

#

121

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

122

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

123

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

124

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

Dan O'Meara

dd49464

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

[diff] [blame^]

125

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

126

# targets. It generally has the form

127

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

128

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

129

# These entries will always contain RevisionName references.

130

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

131

# LatestReadyRevisionName that we last observed.

132

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

133

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

134

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

135

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

136

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

137

# +optional

138

"name": "A String", # Name is optionally used to expose a dedicated hostname for referencing this

139

# target exclusively.

140

#

141

# Not currently supported by Cloud Run.

142

# +optional

143

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

144

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

145

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

146

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

147

#

148

# Not currently supported in Cloud Run.

149

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

150

# This defaults to zero if unspecified.

151

#

152

# Cloud Run currently requires 100 percent for a single ConfigurationName

153

# TrafficTarget entry.

154

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

155

# traffic. This is mutually exclusive with ConfigurationName.

156

#

157

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

158

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

159

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

160

# of the referenced configuration changes, we will automatically migrate

161

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

162

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

163

# with RevisionName.

164

#

165

# Cloud Run currently supports a single ConfigurationName.

166

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

167

# this target exclusively.

168

#

169

# Not currently supported in Cloud Run.

170

# +optional

171

},

172

],

Dan O'Meara

dd49464

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

[diff] [blame^]

173

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

174

"url": "A String",

175

"hostname": "A String", # Deprecated - use url instead.

Bu Sun Kim

715bd7f

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

[diff] [blame]

176

},

Dan O'Meara

dd49464

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

[diff] [blame^]

177

"domainInternal": "A String", # Deprecated - use address instead.

178

# For Cloud Run, identifical to domain.

Bu Sun Kim

715bd7f

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

[diff] [blame]

179

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

180

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

181

# state of the world.

182

{ # RouteCondition defines a readiness condition for a Route.

183

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

184

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

185

# +optional

186

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

187

# +optional

188

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

189

# +optional

190

"message": "A String", # Human-readable message indicating details about last transition.

191

# +optional

192

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

193

# process. See also:

194

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

195

# Types include: "Ready".

},

],

},

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

200

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

201

"generation": 42, # Deprecated and not currently populated by Cloud Run. See

202

# metadata.generation instead, which is the sequence number containing the

203

# latest generation of the desired state.

204

#

205

# Read-only.

206

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

207

# Revisions and Configurations.

208

# Cloud Run currently supports a single configurationName.

209

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

210

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

211

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

212

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

213

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

214

# +optional

215

"name": "A String", # Name is optionally used to expose a dedicated hostname for referencing this

216

# target exclusively.

217

#

218

# Not currently supported by Cloud Run.

219

# +optional

220

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

221

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

222

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

223

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

224

#

225

# Not currently supported in Cloud Run.

226

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

227

# This defaults to zero if unspecified.

228

#

229

# Cloud Run currently requires 100 percent for a single ConfigurationName

230

# TrafficTarget entry.

231

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

232

# traffic. This is mutually exclusive with ConfigurationName.

233

#

234

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

235

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

236

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

237

# of the referenced configuration changes, we will automatically migrate

238

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

239

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

240

# with RevisionName.

241

#

242

# Cloud Run currently supports a single ConfigurationName.

243

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

244

# this target exclusively.

245

#

246

# Not currently supported in Cloud Run.

# +optional

},

],

},

Dan O'Meara

dd49464

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

[diff] [blame^]

251

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

252

"metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this Route, including name, namespace, labels,

253

# and annotations.

254

# all objects users must create.

255

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

256

# been deleted, this object will be garbage collected.

257

# +optional

258

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

259

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

260

# is no namespace field.

261

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

262

# More info:

263

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

264

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

265

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

266

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

267

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

268

# +optional

269

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

270

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

271

# reference is removed.

272

# Defaults to false.

273

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

274

# otherwise 422 (Unprocessable Entity) will be returned.

275

# +optional

Dan O'Meara

dd49464

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

[diff] [blame^]

276

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

277

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

278

},

279

],

280

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

281

# Is required when creating

282

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

283

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

284

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

285

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

286

# +optional

287

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

288

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

289

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

290

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

291

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

292

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

293

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

294

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

295

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

296

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

297

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

298

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

299

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

300

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

301

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

302

# resource is fully terminated.

303

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

304

#

305

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

306

# Read-only.

307

# More info:

308

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

309

# +optional

310

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

311

#

312

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

313

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

314

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

315

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

316

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

317

#

318

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

319

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

320

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

321

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

322

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

323

# and routes.

324

# 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

329

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

330

# project ID or project number.

331

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

332

# Populated by the system. Read-only.

333

# +optional

334

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

335

#

336

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

337

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

338

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

339

# in this list can only be removed.

340

# +optional

341

# +patchStrategy=merge

342

"A String",

343

],

Bu Sun Kim

715bd7f

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

[diff] [blame]

344

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

345

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

346

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

347

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

348

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

349

# particular resource or set of resources.

350

#

351

# Populated by the system.

352

# Read-only.

353

# Value must be treated as opaque by clients and .

354

# More info:

355

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

356

# +optional

357

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

358

#

359

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

360

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

361

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

362

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

363

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

364

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

365

# server.

366

#

367

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

368

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

369

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

370

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

371

# indicated in the Retry-After header).

372

#

373

# Applied only if Name is not specified.

374

# More info:

375

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

376

# +optional

377

# string generateName = 2;

378

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

379

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

380

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

381

# represented in RFC3339 form and is in UTC.

382

#

383

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

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

388

# +optional

389

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

390

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

391

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

392

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

393

"a_key": "A String",

394

},

395

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

396

# Populated by the system.

397

# Read-only.

398

# +optional

399

# string selfLink = 4;

400

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

401

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

402

# allowed to change on PUT operations.

403

#

404

# Populated by the system.

405

# Read-only.

406

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

414

<pre>Rpc to list routes.

415

416

Args:

417

parent: string, The project ID or project number from which the routes should be listed. (required)

418

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

419

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

420

includeUninitialized: boolean, Not currently used by Cloud Run.

421

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

426

start. Not currently used by Cloud Run.

427

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

428

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

429

Not currently used by Cloud Run.

430

continue: string, Optional encoded string to continue paging.

431

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

432

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

433

Not currently used by Cloud Run.

434

435

Returns:

436

An object of the form:

437

438

{ # ListRoutesResponse is a list of Route resources.

439

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

440

"A String",

441

],

442

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

443

"items": [ # List of Routes.

444

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

445

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

446

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

447

# the Route is additionally responsible for monitoring the Configuration for

448

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

449

# See also:

450

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

451

#

452

# Cloud Run currently supports referencing a single Configuration to

453

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

454

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

455

# controller).

Dan O'Meara

dd49464

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

[diff] [blame^]

456

"domain": "A String", # Deprecated - use url instead.

457

# Domain holds the top-level domain that will distribute traffic over the

458

# provided targets.

Bu Sun Kim

715bd7f

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

[diff] [blame]

459

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

460

# was last processed by the controller.

461

#

462

# Clients polling for completed reconciliation should poll until

463

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

464

# is True or False.

465

#

466

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

467

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

468

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

469

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

Dan O'Meara

dd49464

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

[diff] [blame^]

470

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

471

# targets. It generally has the form

472

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

473

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

474

# These entries will always contain RevisionName references.

475

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

476

# LatestReadyRevisionName that we last observed.

477

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

478

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

479

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

480

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

481

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

482

# +optional

483

"name": "A String", # Name is optionally used to expose a dedicated hostname for referencing this

484

# target exclusively.

485

#

486

# Not currently supported by Cloud Run.

487

# +optional

488

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

489

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

490

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

491

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

492

#

493

# Not currently supported in Cloud Run.

494

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

495

# This defaults to zero if unspecified.

496

#

497

# Cloud Run currently requires 100 percent for a single ConfigurationName

498

# TrafficTarget entry.

499

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

500

# traffic. This is mutually exclusive with ConfigurationName.

501

#

502

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

503

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

504

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

505

# of the referenced configuration changes, we will automatically migrate

506

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

507

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

508

# with RevisionName.

509

#

510

# Cloud Run currently supports a single ConfigurationName.

511

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

512

# this target exclusively.

513

#

514

# Not currently supported in Cloud Run.

515

# +optional

516

},

517

],

Dan O'Meara

dd49464

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

[diff] [blame^]

518

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

519

"url": "A String",

520

"hostname": "A String", # Deprecated - use url instead.

Bu Sun Kim

715bd7f

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

[diff] [blame]

521

},

Dan O'Meara

dd49464

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

[diff] [blame^]

522

"domainInternal": "A String", # Deprecated - use address instead.

523

# For Cloud Run, identifical to domain.

Bu Sun Kim

715bd7f

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

[diff] [blame]

524

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

525

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

526

# state of the world.

527

{ # RouteCondition defines a readiness condition for a Route.

528

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

529

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

530

# +optional

531

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

532

# +optional

533

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

534

# +optional

535

"message": "A String", # Human-readable message indicating details about last transition.

536

# +optional

537

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

538

# process. See also:

539

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

540

# Types include: "Ready".

},

],

},

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

545

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

546

"generation": 42, # Deprecated and not currently populated by Cloud Run. See

547

# metadata.generation instead, which is the sequence number containing the

548

# latest generation of the desired state.

549

#

550

# Read-only.

551

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

552

# Revisions and Configurations.

553

# Cloud Run currently supports a single configurationName.

554

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

555

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

556

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

557

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

558

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

559

# +optional

560

"name": "A String", # Name is optionally used to expose a dedicated hostname for referencing this

561

# target exclusively.

562

#

563

# Not currently supported by Cloud Run.

564

# +optional

565

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

566

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

567

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

568

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

569

#

570

# Not currently supported in Cloud Run.

571

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

572

# This defaults to zero if unspecified.

573

#

574

# Cloud Run currently requires 100 percent for a single ConfigurationName

575

# TrafficTarget entry.

576

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

577

# traffic. This is mutually exclusive with ConfigurationName.

578

#

579

# Providing RevisionName in spec is not currently supported by 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

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

589

# this target exclusively.

590

#

591

# Not currently supported in Cloud Run.

# +optional

},

],

},

Dan O'Meara

dd49464

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

[diff] [blame^]

596

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

597

"metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this Route, including name, namespace, labels,

598

# and annotations.

599

# all objects users must create.

600

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

601

# been deleted, this object will be garbage collected.

602

# +optional

603

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

604

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

605

# is no namespace field.

606

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

607

# More info:

608

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

609

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

610

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

611

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

612

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

613

# +optional

614

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

615

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

616

# reference is removed.

617

# Defaults to false.

618

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

619

# otherwise 422 (Unprocessable Entity) will be returned.

620

# +optional

Dan O'Meara

dd49464

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

[diff] [blame^]

621

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

622

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

623

},

624

],

625

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

626

# Is required when creating

627

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

628

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

629

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

630

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

631

# +optional

632

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

633

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

634

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

635

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

636

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

637

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

638

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

639

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

640

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

641

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

642

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

643

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

644

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

645

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

646

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

647

# resource is fully terminated.

648

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

649

#

650

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

651

# Read-only.

652

# More info:

653

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

654

# +optional

655

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

656

#

657

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

658

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

659

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

660

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

661

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

662

#

663

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

664

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

665

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

666

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

667

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

668

# and routes.

669

# 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

674

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

675

# project ID or project number.

676

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

677

# Populated by the system. Read-only.

678

# +optional

679

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

680

#

681

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

682

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

683

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

684

# in this list can only be removed.

685

# +optional

686

# +patchStrategy=merge

687

"A String",

688

],

Bu Sun Kim

715bd7f

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

[diff] [blame]

689

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

690

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

691

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

692

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

693

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

694

# particular resource or set of resources.

695

#

696

# Populated by the system.

697

# Read-only.

698

# Value must be treated as opaque by clients and .

699

# More info:

700

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

701

# +optional

702

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

703

#

704

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

705

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

706

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

707

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

708

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

709

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

710

# server.

711

#

712

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

713

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

714

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

715

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

716

# indicated in the Retry-After header).

717

#

718

# Applied only if Name is not specified.

719

# More info:

720

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

721

# +optional

722

# string generateName = 2;

723

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

724

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

725

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

726

# represented in RFC3339 form and is in UTC.

727

#

728

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

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

733

# +optional

734

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

735

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

736

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

737

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

738

"a_key": "A String",

739

},

740

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

741

# Populated by the system.

742

# Read-only.

743

# +optional

744

# string selfLink = 4;

745

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

746

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

747

# allowed to change on PUT operations.

748

#

749

# Populated by the system.

750

# Read-only.

751

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

# +optional

},

},

],

Dan O'Meara

dd49464

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

[diff] [blame^]

756

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

757

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

758

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

759

# {ObjectMeta, ListMeta}.

760

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

761

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

762

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

763

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

764

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

765

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

766

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

767

# response.

768

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

769

# Populated by the system.

770

# Read-only.

771

# +optional

772

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

773

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

774

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

775

# Populated by the system.

776

# Read-only.

777

# More info:

778

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

# +optional

},

}</pre>

</div>

</body></html>