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/).

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

107

"description": "A String",

108

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

109

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

110

# map[string]interface{} and nil.

111

"raw": "A String",

112

},

113

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

114

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

115

# map[string]interface{} and nil.

"raw": "A String",

},

"allOf": [

# Object with schema name: JSONSchemaProps

120

],

121

"maxLength": "A String",

122

"maxProperties": "A String",

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

123

"multipleOf": 3.14,

124

"maximum": 3.14,

125

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

126

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

127

# purposes.

128

"jsonSchemas": [

129

# Object with schema name: JSONSchemaProps

130

],

131

"schema": # Object with schema name: JSONSchemaProps

132

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

133

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

134

# documentation.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

135

"description": "A String",

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

136

"url": "A String",

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

137

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

138

"schema": "A String",

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

"id": "A String",

"minimum": 3.14,

"properties": {

"a_key": # Object with schema name: JSONSchemaProps

143

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

144

"pattern": "A String",

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

145

"ref": "A String",

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

146

"format": "A String",

147

"minLength": "A String",

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

148

"type": "A String",

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

149

"dependencies": {

150

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

151

"schema": # Object with schema name: JSONSchemaProps

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

152

"property": [

153

"A String",

154

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

155

},

156

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

157

"not": # Object with schema name: JSONSchemaProps

158

"minProperties": "A String",

159

"exclusiveMaximum": True or False,

160

"patternProperties": {

161

"a_key": # Object with schema name: JSONSchemaProps

162

},

163

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

164

# Defaults to true for the boolean property.

165

"allows": True or False,

166

"schema": # Object with schema name: JSONSchemaProps

167

},

168

"maxItems": "A String",

169

"exclusiveMinimum": True or False,

170

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

171

# Defaults to true for the boolean property.

172

"allows": True or False,

173

"schema": # Object with schema name: JSONSchemaProps

174

},

175

"oneOf": [

176

# Object with schema name: JSONSchemaProps

],

"required": [

"A String",

],

"minItems": "A String",

182

"title": "A String",

183

"definitions": {

184

"a_key": # Object with schema name: JSONSchemaProps

},

"enum": [

"A String",

],

"uniqueItems": True or False,

190

"anyOf": [

191

# Object with schema name: JSONSchemaProps

192

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

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

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

203

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

204

# singular.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

205

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

206

# <kind>List. +optional

207

"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

212

# Defaults to lowercased <kind> +optional

213

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

214

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

215

# be all lowercase.

216

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

217

# 'all') +optional

218

"A String",

219

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

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.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

281

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

282

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

283

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

284

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

285

# priority. +optional

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

286

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

287

# +optional

288

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

289

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

290

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

291

# identifying column is the resource name. See

292

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

293

# for more. +optional

294

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

295

# See

296

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

297

# for more.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

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

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

304

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

305

#

306

# Cloud Run fully managed: not supported

307

#

308

# Cloud Run for Anthos: supported

309

#

310

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

311

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

312

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

313

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

314

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

315

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

316

# server.

317

#

318

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

319

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

320

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

321

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

322

# indicated in the Retry-After header).

323

#

324

# Applied only if Name is not specified.

325

# More info:

326

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

327

# string generateName = 2;

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

328

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

329

# Is required when creating

330

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

331

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

332

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

333

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

334

# +optional

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

335

"deletionGracePeriodSeconds": 42, # (Optional)

336

#

337

# Cloud Run fully managed: not supported

338

#

339

# Cloud Run for Anthos: supported

340

#

341

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

342

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

343

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

344

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

345

#

346

# Cloud Run fully managed: not supported

347

#

348

# Cloud Run for Anthos: supported

349

#

350

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

351

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

352

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

353

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

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

354

"finalizers": [ # (Optional)

355

#

356

# Cloud Run fully managed: not supported

357

#

358

# Cloud Run for Anthos: supported

359

#

360

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

361

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

362

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

363

# in this list can only be removed.

364

# +patchStrategy=merge

365

"A String",

366

],

367

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

368

#

369

# Cloud Run fully managed: not supported

370

#

371

# Cloud Run for Anthos: supported

372

#

373

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

374

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

375

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

376

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

377

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

378

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

379

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

380

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

381

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

382

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

383

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

384

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

385

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

386

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

387

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

388

# resource is fully terminated.

389

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

390

#

391

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

392

# Read-only.

393

# More info:

394

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

395

"ownerReferences": [ # (Optional)

396

#

397

# Cloud Run fully managed: not supported

398

#

399

# Cloud Run for Anthos: supported

400

#

401

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

402

# been deleted, this object will be garbage collected.

403

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

404

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

405

# is no namespace field.

406

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

407

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

408

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

409

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

410

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

411

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

412

# +optional

413

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

414

# More info:

415

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

416

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

417

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

418

# reference is removed.

419

# Defaults to false.

420

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

421

# otherwise 422 (Unprocessable Entity) will be returned.

422

# +optional

423

},

424

],

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame^]

425

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

426

#

427

# CreationTimestamp is a timestamp representing the server time when this

428

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

429

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

430

# represented in RFC3339 form and is in UTC.

431

#

432

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

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

437

"labels": { # (Optional)

438

#

439

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

440

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

441

# and routes.

442

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

443

"a_key": "A String",

444

},

445

"generation": 42, # (Optional)

446

#

447

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

448

# Populated by the system. Read-only.

449

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

450

#

451

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

452

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

453

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

454

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

455

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

456

# particular resource or set of resources.

457

#

458

# Populated by the system.

459

# Read-only.

460

# Value must be treated as opaque by clients and .

461

# More info:

462

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

463

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

464

#

465

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

466

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

467

# allowed to change on PUT operations.

468

#

469

# Populated by the system.

470

# Read-only.

471

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

472

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

473

#

474

# SelfLink is a URL representing this object.

475

# Populated by the system.

476

# Read-only.

477

# string selfLink = 4;

478

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

479

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

480

# project ID or project number.

481

"annotations": { # (Optional)

482

#

483

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

484

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

485

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

486

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

487

"a_key": "A String",

488

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

},

}</pre>

</div>

</body></html>