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

<h1><a href="run_v1beta1.html">Cloud Run API</a> . <a href="run_v1beta1.namespaces.html">namespaces</a> . <a href="run_v1beta1.namespaces.customresourcedefinitions.html">customresourcedefinitions</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 CustomResourceDefinition.</p>

80

<h3>Method Details</h3>

81

82

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

83

<pre>Rpc to get information about a CustomResourceDefinition.

84

85

Args:

86

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

87

replace {namespace_id} with the project ID. (required)

88

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

95

96

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

97

# API server. Its name MUST be in the format

98

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

99

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

100

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

101

# appear

102

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

103

# +optional

104

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

105

# +optional

106

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

107

"multipleOf": 3.14,

108

"maximum": 3.14,

109

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

110

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

111

# purposes.

112

"jsonSchemas": [

113

# Object with schema name: JSONSchemaProps

114

],

115

"schema": # Object with schema name: JSONSchemaProps

116

},

117

"schema": "A String",

118

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

119

# documentation.

120

"url": "A String",

121

"description": "A String",

},

"id": "A String",

"minimum": 3.14,

"properties": {

"a_key": # Object with schema name: JSONSchemaProps

127

},

128

"ref": "A String",

129

"pattern": "A String",

130

"format": "A String",

131

"minLength": "A String",

132

"dependencies": {

133

"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

142

"minProperties": "A String",

143

"exclusiveMaximum": True or False,

144

"patternProperties": {

145

"a_key": # Object with schema name: JSONSchemaProps

146

},

147

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

148

# Defaults to true for the boolean property.

149

"allows": True or False,

150

"schema": # Object with schema name: JSONSchemaProps

151

},

152

"maxItems": "A String",

153

"exclusiveMinimum": True or False,

154

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

155

# Defaults to true for the boolean property.

156

"allows": True or False,

157

"schema": # Object with schema name: JSONSchemaProps

158

},

159

"oneOf": [

160

# Object with schema name: JSONSchemaProps

],

"required": [

"A String",

],

"minItems": "A String",

166

"title": "A String",

167

"definitions": {

168

"a_key": # Object with schema name: JSONSchemaProps

},

"enum": [

"A String",

],

"uniqueItems": True or False,

174

"anyOf": [

175

# Object with schema name: JSONSchemaProps

176

],

177

"description": "A String",

178

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

179

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

180

# map[string]interface{} and nil.

181

"raw": "A String",

182

},

183

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

184

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

185

# map[string]interface{} and nil.

"raw": "A String",

},

"allOf": [

# Object with schema name: JSONSchemaProps

190

],

191

"maxProperties": "A String",

192

"maxLength": "A String",

193

},

194

},

195

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

196

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

197

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

198

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

199

# Deprecated: Please use `Versions`.

200

# +optional

201

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

202

# CustomResourceDefinition

203

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

204

# <kind>List. +optional

205

"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

210

# Defaults to lowercased <kind> +optional

211

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

212

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

213

# be all lowercase.

214

"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

219

# singular.

220

},

221

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

222

# +optional

223

# CustomResources.

224

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

225

# +optional

226

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

227

# of a CustomResource. When set,

228

# * exposes a /status subresource for the custom resource

229

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

230

# ignore changes to anything except the status stanza

231

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

232

# stanza

233

},

234

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

235

# +optional

236

# CustomResources.

237

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

238

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

239

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

240

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

241

# in the /scale subresource will default to 0.

242

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

243

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

244

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

245

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

246

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

247

# will default to the empty string. +optional

248

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

249

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

250

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

251

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

252

# return an error on GET.

253

},

254

},

255

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

256

# Default is namespaced

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

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

268

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

269

# v12alpha1, v11alpha2, foo1, foo10. +optional

270

{

271

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

272

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

273

# APIs

274

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

275

# flagged as storage version.

276

},

277

],

278

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

279

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

280

{ # CustomResourceColumnDefinition specifies a column for server side printing.

281

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

282

# +optional

283

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

284

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

285

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

286

# identifying column is the resource name. See

287

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

288

# for more. +optional

289

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

290

# See

291

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

292

# for more.

293

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

294

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

295

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

296

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

297

# priority. +optional

},

],

},

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

302

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

303

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

304

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

305

#

306

# CreationTimestamp is a timestamp representing the server time when this

307

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

308

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

309

# represented in RFC3339 form and is in UTC.

310

#

311

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

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

316

"labels": { # (Optional)

317

#

318

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

319

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

320

# and routes.

321

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

322

"a_key": "A String",

323

},

324

"generation": 42, # (Optional)

325

#

326

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

327

# Populated by the system. Read-only.

328

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

329

#

330

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

331

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

332

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

333

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

334

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

335

# particular resource or set of resources.

336

#

337

# Populated by the system.

338

# Read-only.

339

# Value must be treated as opaque by clients and .

340

# More info:

341

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

342

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

343

#

344

# SelfLink is a URL representing this object.

345

# Populated by the system.

346

# Read-only.

347

# string selfLink = 4;

348

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

349

#

350

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

351

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

352

# allowed to change on PUT operations.

353

#

354

# Populated by the system.

355

# Read-only.

356

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

357

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

358

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

359

# project ID or project number.

360

"annotations": { # (Optional)

361

#

362

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

363

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

364

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

365

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

366

"a_key": "A String",

367

},

368

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

369

#

370

# Cloud Run fully managed: not supported

371

#

372

# Cloud Run for Anthos: supported

373

#

374

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

375

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

376

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

377

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

378

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

379

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

380

# server.

381

#

382

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

383

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

384

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

385

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

386

# indicated in the Retry-After header).

387

#

388

# Applied only if Name is not specified.

389

# More info:

390

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

391

# string generateName = 2;

392

"deletionGracePeriodSeconds": 42, # (Optional)

393

#

394

# Cloud Run fully managed: not supported

395

#

396

# Cloud Run for Anthos: supported

397

#

398

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

399

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

400

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

401

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

402

#

403

# Cloud Run fully managed: not supported

404

#

405

# Cloud Run for Anthos: supported

406

#

407

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

408

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

409

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

410

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

411

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

412

# Is required when creating

413

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

414

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

415

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

416

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

417

# +optional

418

"finalizers": [ # (Optional)

419

#

420

# Cloud Run fully managed: not supported

421

#

422

# Cloud Run for Anthos: supported

423

#

424

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

425

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

426

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

427

# in this list can only be removed.

428

# +patchStrategy=merge

429

"A String",

430

],

431

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

432

#

433

# Cloud Run fully managed: not supported

434

#

435

# Cloud Run for Anthos: supported

436

#

437

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

438

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

439

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

440

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

441

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

442

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

443

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

444

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

445

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

446

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

447

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

448

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

449

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

450

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

451

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

452

# resource is fully terminated.

453

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

454

#

455

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

456

# Read-only.

457

# More info:

458

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

459

"ownerReferences": [ # (Optional)

460

#

461

# Cloud Run fully managed: not supported

462

#

463

# Cloud Run for Anthos: supported

464

#

465

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

466

# been deleted, this object will be garbage collected.

467

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

468

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

469

# is no namespace field.

470

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

471

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

472

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

473

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

474

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

475

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

476

# +optional

477

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

478

# More info:

479

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

480

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

481

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

482

# reference is removed.

483

# Defaults to false.

484

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

485

# otherwise 422 (Unprocessable Entity) will be returned.

# +optional

},

],

},

}</pre>

</div>

</body></html>