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

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

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

Bu Sun Kim

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

[diff] [blame]

81

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

82

<p class="firstline">Rpc to get information about a CustomResourceDefinition.</p>

83

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

84

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

Bu Sun Kim

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

[diff] [blame]

85

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

86

<h3>Method Details</h3>

87

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

88

<code class="details" id="close">close()</code>

89

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

93

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

94

<pre>Rpc to get information about a CustomResourceDefinition.

95

96

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

97

name: string, The name of the CustomResourceDefinition being retrieved. If needed, replace {namespace_id} with the project ID. (required)

Bu Sun Kim

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

[diff] [blame]

98

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

105

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

106

{ # CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

107

"metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this CustomResourceDefinition.

108

"finalizers": [ # (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. +patchStrategy=merge

109

"A String",

110

],

111

"clusterName": "A String", # (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

112

"generateName": "A String", # (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency string generateName = 2;

113

"annotations": { # (Optional) Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

114

"a_key": "A String",

115

},

116

"deletionGracePeriodSeconds": 42, # (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

117

"generation": 42, # (Optional) A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

118

"selfLink": "A String", # (Optional) SelfLink is a URL representing this object. Populated by the system. Read-only. string selfLink = 4;

119

"ownerReferences": [ # (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected.

120

{ # OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

121

"name": "A String", # Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

122

"uid": "A String", # UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

123

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

124

"blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional

125

"kind": "A String", # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

126

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

127

},

128

],

129

"resourceVersion": "A String", # (Optional) An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

130

"deletionTimestamp": "A String", # (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

131

"namespace": "A String", # Namespace defines the space within each name must be unique, within a Cloud Run region. In Cloud Run the namespace must be equal to either the project ID or project number.

132

"labels": { # (Optional) Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: http://kubernetes.io/docs/user-guide/labels

133

"a_key": "A String",

134

},

135

"name": "A String", # Name must be unique within a namespace, within a Cloud Run region. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional

136

"creationTimestamp": "A String", # (Optional) CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

137

"uid": "A String", # (Optional) UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

138

},

139

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

140

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

141

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

142

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

143

"singular": "A String", # Singular is the singular name of the resource. It must be all lowercase Defaults to lowercased +optional

144

"categories": [ # Categories is a list of grouped resources custom resources belong to (e.g. 'all') +optional

145

"A String",

146

],

147

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

148

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

149

"A String",

150

],

151

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

152

"plural": "A String", # Plural is the plural name of the resource to serve. It must match the name of the CustomResourceDefinition-registration too: plural.group and it must be all lowercase.

153

},

154

"version": "A String", # Version is the version this resource belongs in Should be always first item in Versions field if provided. Optional, but at least one of Version or Versions must be set. Deprecated: Please use `Versions`. +optional

155

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

156

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

157

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

158

"status": { # CustomResourceSubresourceStatus defines how to serve the status subresource for CustomResources. Status is represented by the `.status` JSON path inside of a CustomResource. When set, * exposes a /status subresource for the custom resource * PUT requests to the /status subresource take a custom resource object, and ignore changes to anything except the status stanza * PUT/POST/PATCH requests to the custom resource ignore changes to the status stanza # Status denotes the status subresource for CustomResources +optional

159

},

160

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

161

"statusReplicasPath": "A String", # StatusReplicasPath defines the JSON path inside of a CustomResource that corresponds to Scale.Status.Replicas. Only JSON paths without the array notation are allowed. Must be a JSON Path under .status. If there is no value under the given path in the CustomResource, the status replica value in the /scale subresource will default to 0.

162

"labelSelectorPath": "A String", # LabelSelectorPath defines the JSON path inside of a CustomResource that corresponds to Scale.Status.Selector. Only JSON paths without the array notation are allowed. Must be a JSON Path under .status. Must be set to work with HPA. If there is no value under the given path in the CustomResource, the status label selector value in the /scale subresource will default to the empty string. +optional

163

"specReplicasPath": "A String", # SpecReplicasPath defines the JSON path inside of a CustomResource that corresponds to Scale.Spec.Replicas. Only JSON paths without the array notation are allowed. Must be a JSON Path under .spec. If there is no value under the given path in the CustomResource, the /scale subresource will return an error on GET.

164

},

165

},

166

"versions": [ # Versions is the list of all supported versions for this resource. If Version field is provided, this field is optional. Validation: All versions must use the same validation schema for now. i.e., top level Validation field is applied to all of these versions. Order: The version name will be used to compute the order. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. +optional

167

{

168

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

169

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

170

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

171

},

172

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

173

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

174

"openAPIV3Schema": { # JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/). # OpenAPIV3Schema is the OpenAPI v3 schema to be validated against. +optional

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

175

"multipleOf": 3.14,

176

"definitions": {

177

"a_key": # Object with schema name: JSONSchemaProps

178

},

179

"properties": {

180

"a_key": # Object with schema name: JSONSchemaProps

181

},

182

"uniqueItems": True or False,

183

"allOf": [

184

# Object with schema name: JSONSchemaProps

185

],

186

"patternProperties": {

187

"a_key": # Object with schema name: JSONSchemaProps

188

},

189

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

190

"description": "A String",

"url": "A String",

},

"enum": [

"A String",

],

"maxItems": "A String",

"required": [

"A String",

],

"minLength": "A String",

201

"id": "A String",

202

"minimum": 3.14,

203

"exclusiveMaximum": True or False,

204

"maxLength": "A String",

205

"format": "A String",

206

"default": { # JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.

"raw": "A String",

},

"oneOf": [

# Object with schema name: JSONSchemaProps

211

],

212

"maximum": 3.14,

213

"minItems": "A String",

214

"maxProperties": "A String",

215

"not": # Object with schema name: JSONSchemaProps

216

"ref": "A String",

217

"description": "A String",

218

"exclusiveMinimum": True or False,

219

"pattern": "A String",

220

"type": "A String",

221

"additionalItems": { # JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.

222

"schema": # Object with schema name: JSONSchemaProps

223

"allows": True or False,

224

},

225

"additionalProperties": { # JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.

226

"schema": # Object with schema name: JSONSchemaProps

227

"allows": True or False,

228

},

229

"schema": "A String",

230

"minProperties": "A String",

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

231

"dependencies": {

232

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

233

"schema": # Object with schema name: JSONSchemaProps

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

234

"property": [

235

"A String",

236

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

237

},

238

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

239

"example": { # JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.

"raw": "A String",

},

"anyOf": [

# Object with schema name: JSONSchemaProps

244

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

245

"items": { # JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes.

246

"jsonSchemas": [

247

# Object with schema name: JSONSchemaProps

248

],

249

"schema": # Object with schema name: JSONSchemaProps

250

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

251

"title": "A String",

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

252

},

253

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

254

"additionalPrinterColumns": [ # AdditionalPrinterColumns are additional columns shown e.g. in kubectl next to the name. Defaults to a created-at column. +optional

255

{ # CustomResourceColumnDefinition specifies a column for server side printing.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

256

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

257

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

258

"type": "A String", # type is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for more.

259

"priority": 42, # priority is an integer defining the relative importance of this column compared to others. Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a higher priority. +optional

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

260

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

261

"format": "A String", # format is an optional OpenAPI type definition for this column. The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for more. +optional

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

262

},

263

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

264

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

269

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

Bu Sun Kim

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

[diff] [blame]

270

<pre>Rpc to list custom resource definitions.

271

272

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

273

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

274

fieldSelector: string, Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

275

labelSelector: string, Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

276

includeUninitialized: boolean, Not currently used by Cloud Run.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

277

limit: integer, A parameter

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

278

continue: string, Optional encoded string to continue paging.

279

resourceVersion: string, The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

280

watch: boolean, Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.

Bu Sun Kim

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

[diff] [blame]

281

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

288

289

{

Bu Sun Kim

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

[diff] [blame]

290

"items": [ # List of CustomResourceDefinitions.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

291

{ # CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

292

"metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this CustomResourceDefinition.

293

"finalizers": [ # (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. +patchStrategy=merge

294

"A String",

295

],

296

"clusterName": "A String", # (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

297

"generateName": "A String", # (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency string generateName = 2;

298

"annotations": { # (Optional) Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

299

"a_key": "A String",

300

},

301

"deletionGracePeriodSeconds": 42, # (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

302

"generation": 42, # (Optional) A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

303

"selfLink": "A String", # (Optional) SelfLink is a URL representing this object. Populated by the system. Read-only. string selfLink = 4;

304

"ownerReferences": [ # (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported List of objects that own this object. If ALL objects in the list have been deleted, this object will be garbage collected.

305

{ # OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

306

"name": "A String", # Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

307

"uid": "A String", # UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

308

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

309

"blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional

310

"kind": "A String", # Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

311

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

312

},

313

],

314

"resourceVersion": "A String", # (Optional) An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

315

"deletionTimestamp": "A String", # (Optional) Cloud Run fully managed: not supported Cloud Run for Anthos: supported DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

316

"namespace": "A String", # Namespace defines the space within each name must be unique, within a Cloud Run region. In Cloud Run the namespace must be equal to either the project ID or project number.

317

"labels": { # (Optional) Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: http://kubernetes.io/docs/user-guide/labels

318

"a_key": "A String",

319

},

320

"name": "A String", # Name must be unique within a namespace, within a Cloud Run region. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional

321

"creationTimestamp": "A String", # (Optional) CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

322

"uid": "A String", # (Optional) UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

323

},

324

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

325

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

326

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

327

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

328

"singular": "A String", # Singular is the singular name of the resource. It must be all lowercase Defaults to lowercased +optional

329

"categories": [ # Categories is a list of grouped resources custom resources belong to (e.g. 'all') +optional

330

"A String",

331

],

332

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

333

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

334

"A String",

335

],

336

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

337

"plural": "A String", # Plural is the plural name of the resource to serve. It must match the name of the CustomResourceDefinition-registration too: plural.group and it must be all lowercase.

338

},

339

"version": "A String", # Version is the version this resource belongs in Should be always first item in Versions field if provided. Optional, but at least one of Version or Versions must be set. Deprecated: Please use `Versions`. +optional

340

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

341

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

342

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

343

"status": { # CustomResourceSubresourceStatus defines how to serve the status subresource for CustomResources. Status is represented by the `.status` JSON path inside of a CustomResource. When set, * exposes a /status subresource for the custom resource * PUT requests to the /status subresource take a custom resource object, and ignore changes to anything except the status stanza * PUT/POST/PATCH requests to the custom resource ignore changes to the status stanza # Status denotes the status subresource for CustomResources +optional

344

},

345

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

346

"statusReplicasPath": "A String", # StatusReplicasPath defines the JSON path inside of a CustomResource that corresponds to Scale.Status.Replicas. Only JSON paths without the array notation are allowed. Must be a JSON Path under .status. If there is no value under the given path in the CustomResource, the status replica value in the /scale subresource will default to 0.

347

"labelSelectorPath": "A String", # LabelSelectorPath defines the JSON path inside of a CustomResource that corresponds to Scale.Status.Selector. Only JSON paths without the array notation are allowed. Must be a JSON Path under .status. Must be set to work with HPA. If there is no value under the given path in the CustomResource, the status label selector value in the /scale subresource will default to the empty string. +optional

348

"specReplicasPath": "A String", # SpecReplicasPath defines the JSON path inside of a CustomResource that corresponds to Scale.Spec.Replicas. Only JSON paths without the array notation are allowed. Must be a JSON Path under .spec. If there is no value under the given path in the CustomResource, the /scale subresource will return an error on GET.

349

},

350

},

351

"versions": [ # Versions is the list of all supported versions for this resource. If Version field is provided, this field is optional. Validation: All versions must use the same validation schema for now. i.e., top level Validation field is applied to all of these versions. Order: The version name will be used to compute the order. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. +optional

352

{

353

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

354

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

355

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

356

},

357

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

358

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

359

"openAPIV3Schema": { # JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/). # OpenAPIV3Schema is the OpenAPI v3 schema to be validated against. +optional

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

360

"multipleOf": 3.14,

361

"definitions": {

362

"a_key": # Object with schema name: JSONSchemaProps

363

},

364

"properties": {

365

"a_key": # Object with schema name: JSONSchemaProps

366

},

367

"uniqueItems": True or False,

368

"allOf": [

369

# Object with schema name: JSONSchemaProps

370

],

371

"patternProperties": {

372

"a_key": # Object with schema name: JSONSchemaProps

373

},

374

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

375

"description": "A String",

"url": "A String",

},

"enum": [

"A String",

],

"maxItems": "A String",

"required": [

"A String",

],

"minLength": "A String",

386

"id": "A String",

387

"minimum": 3.14,

388

"exclusiveMaximum": True or False,

389

"maxLength": "A String",

390

"format": "A String",

391

"default": { # JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.

"raw": "A String",

},

"oneOf": [

# Object with schema name: JSONSchemaProps

396

],

397

"maximum": 3.14,

398

"minItems": "A String",

399

"maxProperties": "A String",

400

"not": # Object with schema name: JSONSchemaProps

401

"ref": "A String",

402

"description": "A String",

403

"exclusiveMinimum": True or False,

404

"pattern": "A String",

405

"type": "A String",

406

"additionalItems": { # JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.

407

"schema": # Object with schema name: JSONSchemaProps

408

"allows": True or False,

409

},

410

"additionalProperties": { # JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.

411

"schema": # Object with schema name: JSONSchemaProps

412

"allows": True or False,

413

},

414

"schema": "A String",

415

"minProperties": "A String",

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

416

"dependencies": {

417

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

418

"schema": # Object with schema name: JSONSchemaProps

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

419

"property": [

420

"A String",

421

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

422

},

423

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

424

"example": { # JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.

"raw": "A String",

},

"anyOf": [

# Object with schema name: JSONSchemaProps

429

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

430

"items": { # JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes.

431

"jsonSchemas": [

432

# Object with schema name: JSONSchemaProps

433

],

434

"schema": # Object with schema name: JSONSchemaProps

435

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

436

"title": "A String",

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

437

},

438

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

439

"additionalPrinterColumns": [ # AdditionalPrinterColumns are additional columns shown e.g. in kubectl next to the name. Defaults to a created-at column. +optional

440

{ # CustomResourceColumnDefinition specifies a column for server side printing.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

441

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

442

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

443

"type": "A String", # type is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for more.

444

"priority": 42, # priority is an integer defining the relative importance of this column compared to others. Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a higher priority. +optional

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

445

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

446

"format": "A String", # format is an optional OpenAPI type definition for this column. The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for more. +optional

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

447

},

448

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

449

},

Bu Sun Kim

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

[diff] [blame]

450

},

451

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

452

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

453

"A String",

454

],

455

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

456

"metadata": { # ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. # Metadata associated with this CustomResourceDefinition list.

457

"continue": "A String", # continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response.

458

"selfLink": "A String", # SelfLink is a URL representing this object. Populated by the system. Read-only. +optional

459

"resourceVersion": "A String", # String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional

460

},

461

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

Bu Sun Kim