Blame - docs/dyn/run_v1beta1.customresourcedefinitions.html - platform/external/python/google-api-python-client

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

79

<p class="firstline">Rpc to list custom resource definitions.</p>

80

<h3>Method Details</h3>

81

82

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

83

<pre>Rpc to list custom resource definitions.

84

85

Args:

86

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

87

start. Not currently used by Cloud Run.

88

includeUninitialized: boolean, Not currently used by Cloud Run.

89

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

90

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

91

Not currently used by Cloud Run.

92

continue: string, Optional encoded string to continue paging.

93

limit: integer, A parameter

94

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

95

Not currently used by Cloud Run.

96

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

97

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

98

parent: string, The project ID or project number from which the storages should

99

be listed.

100

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

107

108

{

109

"apiVersion": "A String", # The API version for this call such as "k8s.apiextensions.io/v1beta1".

110

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

111

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

112

"A String",

113

],

114

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

115

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

116

# {ObjectMeta, ListMeta}.

117

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

118

# Populated by the system.

119

# Read-only.

120

# +optional

121

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

122

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

123

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

124

# Populated by the system.

125

# Read-only.

126

# More info:

127

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

128

# +optional

129

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

130

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

131

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

132

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

133

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

134

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

135

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

136

# response.

137

},

138

"items": [ # List of CustomResourceDefinitions.

139

{ # CustomResourceDefinition represents a resource that should be exposed on the

140

# API server. Its name MUST be in the format

141

# <.spec.name>.<.spec.group>.

142

"apiVersion": "A String", # The API version for this call such as "k8s.apiextensions.io/v1beta1".

143

"spec": { # CustomResourceDefinitionSpec describes how a user wants their resource to # Spec describes how the user wants the resources to appear

144

# appear

145

"validation": { # CustomResourceValidation is a list of validation methods for CustomResources. # Validation describes the validation methods for CustomResources

146

# +optional

147

"openAPIV3Schema": { # JSONSchemaProps is a JSON-Schema following Specification Draft 4 # OpenAPIV3Schema is the OpenAPI v3 schema to be validated against.

148

# +optional

149

# (http://json-schema.org/).

150

"multipleOf": 3.14,

151

"maximum": 3.14,

152

"items": { # JSONSchemaPropsOrArray represents a value that can either be a

153

# JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization

154

# purposes.

155

"jsonSchemas": [

156

# Object with schema name: JSONSchemaProps

157

],

158

"schema": # Object with schema name: JSONSchemaProps

159

},

160

"schema": "A String",

161

"externalDocs": { # ExternalDocumentation allows referencing an external resource for extended

162

# documentation.

163

"url": "A String",

164

"description": "A String",

},

"id": "A String",

"minimum": 3.14,

"properties": {

"a_key": # Object with schema name: JSONSchemaProps

170

},

171

"ref": "A String",

172

"pattern": "A String",

173

"format": "A String",

174

"minLength": "A String",

175

"dependencies": {

176

"a_key": { # JSONSchemaPropsOrStringArray represents a JSONSchemaProps or a string array.

"property": [

"A String",

],

"schema": # Object with schema name: JSONSchemaProps

},

},

"type": "A String",

"not": # Object with schema name: JSONSchemaProps

185

"minProperties": "A String",

186

"exclusiveMaximum": True or False,

187

"patternProperties": {

188

"a_key": # Object with schema name: JSONSchemaProps

189

},

190

"additionalProperties": { # JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value.

191

# Defaults to true for the boolean property.

192

"allows": True or False,

193

"schema": # Object with schema name: JSONSchemaProps

194

},

195

"maxItems": "A String",

196

"exclusiveMinimum": True or False,

197

"additionalItems": { # JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value.

198

# Defaults to true for the boolean property.

199

"allows": True or False,

200

"schema": # Object with schema name: JSONSchemaProps

201

},

202

"oneOf": [

203

# Object with schema name: JSONSchemaProps

],

"required": [

"A String",

],

"minItems": "A String",

209

"title": "A String",

210

"definitions": {

211

"a_key": # Object with schema name: JSONSchemaProps

},

"enum": [

"A String",

],

"uniqueItems": True or False,

217

"anyOf": [

218

# Object with schema name: JSONSchemaProps

219

],

220

"description": "A String",

221

"default": { # JSON represents any valid JSON value.

222

# These types are supported: bool, int64, float64, string, []interface{},

223

# map[string]interface{} and nil.

224

"raw": "A String",

225

},

226

"example": { # JSON represents any valid JSON value.

227

# These types are supported: bool, int64, float64, string, []interface{},

228

# map[string]interface{} and nil.

"raw": "A String",

},

"allOf": [

# Object with schema name: JSONSchemaProps

233

],

234

"maxProperties": "A String",

235

"maxLength": "A String",

236

},

237

},

238

"group": "A String", # Group is the group this resource belongs in

239

"version": "A String", # Version is the version this resource belongs in

240

# Should be always first item in Versions field if provided.

241

# Optional, but at least one of Version or Versions must be set.

242

# Deprecated: Please use `Versions`.

243

# +optional

244

"names": { # CustomResourceDefinitionNames indicates the names to serve this # Names are the names used to describe this custom resource

245

# CustomResourceDefinition

246

"listKind": "A String", # ListKind is the serialized kind of the list for this resource. Defaults to

247

# <kind>List. +optional

248

"shortNames": [ # ShortNames are short names for the resource. It must be all lowercase.

# +optional

"A String",

],

"singular": "A String", # Singular is the singular name of the resource. It must be all lowercase

253

# Defaults to lowercased <kind> +optional

254

"plural": "A String", # Plural is the plural name of the resource to serve. It must match the name

255

# of the CustomResourceDefinition-registration too: plural.group and it must

256

# be all lowercase.

257

"categories": [ # Categories is a list of grouped resources custom resources belong to (e.g.

# 'all') +optional

"A String",

],

"kind": "A String", # Kind is the serialized kind of the resource. It is normally CamelCase and

262

# singular.

263

},

264

"subresources": { # CustomResourceSubresources defines the status and scale subresources for # Subresources describes the subresources for CustomResources

265

# +optional

266

# CustomResources.

267

"status": { # CustomResourceSubresourceStatus defines how to serve the status subresource # Status denotes the status subresource for CustomResources

268

# +optional

269

# for CustomResources. Status is represented by the `.status` JSON path inside

270

# of a CustomResource. When set,

271

# * exposes a /status subresource for the custom resource

272

# * PUT requests to the /status subresource take a custom resource object, and

273

# ignore changes to anything except the status stanza

274

# * PUT/POST/PATCH requests to the custom resource ignore changes to the status

275

# stanza

276

},

277

"scale": { # CustomResourceSubresourceScale defines how to serve the scale subresource for # Scale denotes the scale subresource for CustomResources

278

# +optional

279

# CustomResources.

280

"statusReplicasPath": "A String", # StatusReplicasPath defines the JSON path inside of a CustomResource that

281

# corresponds to Scale.Status.Replicas. Only JSON paths without the array

282

# notation are allowed. Must be a JSON Path under .status. If there is no

283

# value under the given path in the CustomResource, the status replica value

284

# in the /scale subresource will default to 0.

285

"labelSelectorPath": "A String", # LabelSelectorPath defines the JSON path inside of a CustomResource that

286

# corresponds to Scale.Status.Selector. Only JSON paths without the array

287

# notation are allowed. Must be a JSON Path under .status. Must be set to

288

# work with HPA. If there is no value under the given path in the

289

# CustomResource, the status label selector value in the /scale subresource

290

# will default to the empty string. +optional

291

"specReplicasPath": "A String", # SpecReplicasPath defines the JSON path inside of a CustomResource that

292

# corresponds to Scale.Spec.Replicas. Only JSON paths without the array

293

# notation are allowed. Must be a JSON Path under .spec. If there is no value

294

# under the given path in the CustomResource, the /scale subresource will

295

# return an error on GET.

296

},

297

},

298

"scope": "A String", # Scope indicates whether this resource is cluster or namespace scoped.

299

# Default is namespaced

300

"versions": [ # Versions is the list of all supported versions for this resource.

301

# If Version field is provided, this field is optional.

302

# Validation: All versions must use the same validation schema for now. i.e.,

303

# top level Validation field is applied to all of these versions. Order: The

304

# version name will be used to compute the order. If the version string is

305

# "kube-like", it will sort above non "kube-like" version strings, which are

306

# ordered lexicographically. "Kube-like" versions start with a "v", then are

307

# followed by a number (the major version), then optionally the string

308

# "alpha" or "beta" and another number (the minor version). These are sorted

309

# first by GA > beta > alpha (where GA is a version with no suffix such as

310

# beta or alpha), and then by comparing major version, then minor version. An

311

# example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1,

312

# v12alpha1, v11alpha2, foo1, foo10. +optional

313

{

314

"name": "A String", # Name is the version name, e.g. “v1”, “v2beta1”, etc.

315

"served": True or False, # Served is a flag enabling/disabling this version from being served via REST

316

# APIs

317

"storage": True or False, # Storage flags the version as storage version. There must be exactly one

318

# flagged as storage version.

319

},

320

],

321

"additionalPrinterColumns": [ # AdditionalPrinterColumns are additional columns shown e.g. in kubectl next

322

# to the name. Defaults to a created-at column. +optional

323

{ # CustomResourceColumnDefinition specifies a column for server side printing.

324

"description": "A String", # description is a human readable description of this column.

325

# +optional

326

"name": "A String", # name is a human readable name for the column.

327

"format": "A String", # format is an optional OpenAPI type definition for this column. The 'name'

328

# format is applied to the primary identifier column to assist in clients

329

# identifying column is the resource name. See

330

# https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types

331

# for more. +optional

332

"type": "A String", # type is an OpenAPI type definition for this column.

333

# See

334

# https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types

335

# for more.

336

"jsonPath": "A String", # JSONPath is a simple JSON path, i.e. with array notation.

337

"priority": 42, # priority is an integer defining the relative importance of this column

338

# compared to others. Lower numbers are considered higher priority. Columns

339

# that may be omitted in limited space scenarios should be given a higher

340

# priority. +optional

},

],

},

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

345

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

346

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

347

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

348

#

349

# CreationTimestamp is a timestamp representing the server time when this

350

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

351

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

352

# represented in RFC3339 form and is in UTC.

353

#

354

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

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

359

"labels": { # (Optional)

360

#

361

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

362

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

363

# and routes.

364

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

365

"a_key": "A String",

366

},

367

"generation": 42, # (Optional)

368

#

369

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

370

# Populated by the system. Read-only.

371

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

372

#

373

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

374

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

375

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

376

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

377

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

378

# particular resource or set of resources.

379

#

380

# Populated by the system.

381

# Read-only.

382

# Value must be treated as opaque by clients and .

383

# More info:

384

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

385

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

386

#

387

# SelfLink is a URL representing this object.

388

# Populated by the system.

389

# Read-only.

390

# string selfLink = 4;

391

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

392

#

393

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

394

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

395

# allowed to change on PUT operations.

396

#

397

# Populated by the system.

398

# Read-only.

399

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

400

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

401

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

402

# project ID or project number.

403

"annotations": { # (Optional)

404

#

405

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

406

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

407

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

408

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

409

"a_key": "A String",

410

},

411

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

412

#

413

# Cloud Run fully managed: not supported

414

#

415

# Cloud Run for Anthos: supported

416

#

417

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

418

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

419

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

420

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

421

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

422

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

423

# server.

424

#

425

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

426

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

427

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

428

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

429

# indicated in the Retry-After header).

430

#

431

# Applied only if Name is not specified.

432

# More info:

433

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

434

# string generateName = 2;

435

"deletionGracePeriodSeconds": 42, # (Optional)

436

#

437

# Cloud Run fully managed: not supported

438

#

439

# Cloud Run for Anthos: supported

440

#

441

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

442

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

443

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

444

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

445

#

446

# Cloud Run fully managed: not supported

447

#

448

# Cloud Run for Anthos: supported

449

#

450

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

451

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

452

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

453

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

454

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

455

# Is required when creating

456

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

457

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

458

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

459

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

460

# +optional

461

"finalizers": [ # (Optional)

462

#

463

# Cloud Run fully managed: not supported

464

#

465

# Cloud Run for Anthos: supported

466

#

467

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

468

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

469

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

470

# in this list can only be removed.

471

# +patchStrategy=merge

472

"A String",

473

],

474

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

475

#

476

# Cloud Run fully managed: not supported

477

#

478

# Cloud Run for Anthos: supported

479

#

480

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

481

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

482

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

483

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

484

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

485

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

486

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

487

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

488

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

489

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

490

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

491

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

492

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

493

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

494

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

495

# resource is fully terminated.

496

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

497

#

498

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

499

# Read-only.

500

# More info:

501

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

502

"ownerReferences": [ # (Optional)

503

#

504

# Cloud Run fully managed: not supported

505

#

506

# Cloud Run for Anthos: supported

507

#

508

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

509

# been deleted, this object will be garbage collected.

510

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

511

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

512

# is no namespace field.

513

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

514

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

515

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

516

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

517

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

518

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

519

# +optional

520

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

521

# More info:

522

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

523

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

524

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

525

# reference is removed.

526

# Defaults to false.

527

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

528

# otherwise 422 (Unprocessable Entity) will be returned.

# +optional

},

],

},

},

],

}</pre>

</div>

</body></html>