| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="run_v1beta1.html">Cloud Run API</a> . <a href="run_v1beta1.projects.html">projects</a> . <a href="run_v1beta1.projects.locations.html">locations</a> . <a href="run_v1beta1.projects.locations.customresourcedefinitions.html">customresourcedefinitions</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 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 | <p class="toc_element"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 81 | <code><a href="#list">list(parent, continue=None, limit=None, watch=None, labelSelector=None, fieldSelector=None, resourceVersion=None, includeUninitialized=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 82 | <p class="firstline">Rpc to list custom resource definitions.</p> |
| 83 | <h3>Method Details</h3> |
| 84 | <div class="method"> |
| 85 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 86 | <pre>Rpc to get information about a CustomResourceDefinition. |
| 87 | |
| 88 | Args: |
| 89 | name: string, The name of the CustomResourceDefinition being retrieved. If needed, |
| 90 | replace {namespace_id} with the project ID. (required) |
| 91 | x__xgafv: string, V1 error format. |
| 92 | Allowed values |
| 93 | 1 - v1 error format |
| 94 | 2 - v2 error format |
| 95 | |
| 96 | Returns: |
| 97 | An object of the form: |
| 98 | |
| 99 | { # CustomResourceDefinition represents a resource that should be exposed on the |
| 100 | # API server. Its name MUST be in the format |
| 101 | # <.spec.name>.<.spec.group>. |
| 102 | "apiVersion": "A String", # The API version for this call such as "k8s.apiextensions.io/v1beta1". |
| 103 | "spec": { # CustomResourceDefinitionSpec describes how a user wants their resource to # Spec describes how the user wants the resources to appear |
| 104 | # appear |
| 105 | "validation": { # CustomResourceValidation is a list of validation methods for CustomResources. # Validation describes the validation methods for CustomResources |
| 106 | # +optional |
| 107 | "openAPIV3Schema": { # JSONSchemaProps is a JSON-Schema following Specification Draft 4 # OpenAPIV3Schema is the OpenAPI v3 schema to be validated against. |
| 108 | # +optional |
| 109 | # (http://json-schema.org/). |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 110 | "description": "A String", |
| 111 | "example": { # JSON represents any valid JSON value. |
| 112 | # These types are supported: bool, int64, float64, string, []interface{}, |
| 113 | # map[string]interface{} and nil. |
| 114 | "raw": "A String", |
| 115 | }, |
| 116 | "default": { # JSON represents any valid JSON value. |
| 117 | # These types are supported: bool, int64, float64, string, []interface{}, |
| 118 | # map[string]interface{} and nil. |
| 119 | "raw": "A String", |
| 120 | }, |
| 121 | "allOf": [ |
| 122 | # Object with schema name: JSONSchemaProps |
| 123 | ], |
| 124 | "maxLength": "A String", |
| 125 | "maxProperties": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 126 | "multipleOf": 3.14, |
| 127 | "maximum": 3.14, |
| 128 | "items": { # JSONSchemaPropsOrArray represents a value that can either be a |
| 129 | # JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization |
| 130 | # purposes. |
| 131 | "jsonSchemas": [ |
| 132 | # Object with schema name: JSONSchemaProps |
| 133 | ], |
| 134 | "schema": # Object with schema name: JSONSchemaProps |
| 135 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 136 | "externalDocs": { # ExternalDocumentation allows referencing an external resource for extended |
| 137 | # documentation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 138 | "description": "A String", |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 139 | "url": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 140 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 141 | "schema": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 142 | "id": "A String", |
| 143 | "minimum": 3.14, |
| 144 | "properties": { |
| 145 | "a_key": # Object with schema name: JSONSchemaProps |
| 146 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 147 | "pattern": "A String", |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 148 | "ref": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 149 | "format": "A String", |
| 150 | "minLength": "A String", |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 151 | "type": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 152 | "dependencies": { |
| 153 | "a_key": { # JSONSchemaPropsOrStringArray represents a JSONSchemaProps or a string array. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 154 | "schema": # Object with schema name: JSONSchemaProps |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 155 | "property": [ |
| 156 | "A String", |
| 157 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 158 | }, |
| 159 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 160 | "not": # Object with schema name: JSONSchemaProps |
| 161 | "minProperties": "A String", |
| 162 | "exclusiveMaximum": True or False, |
| 163 | "patternProperties": { |
| 164 | "a_key": # Object with schema name: JSONSchemaProps |
| 165 | }, |
| 166 | "additionalProperties": { # JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. |
| 167 | # Defaults to true for the boolean property. |
| 168 | "allows": True or False, |
| 169 | "schema": # Object with schema name: JSONSchemaProps |
| 170 | }, |
| 171 | "maxItems": "A String", |
| 172 | "exclusiveMinimum": True or False, |
| 173 | "additionalItems": { # JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. |
| 174 | # Defaults to true for the boolean property. |
| 175 | "allows": True or False, |
| 176 | "schema": # Object with schema name: JSONSchemaProps |
| 177 | }, |
| 178 | "oneOf": [ |
| 179 | # Object with schema name: JSONSchemaProps |
| 180 | ], |
| 181 | "required": [ |
| 182 | "A String", |
| 183 | ], |
| 184 | "minItems": "A String", |
| 185 | "title": "A String", |
| 186 | "definitions": { |
| 187 | "a_key": # Object with schema name: JSONSchemaProps |
| 188 | }, |
| 189 | "enum": [ |
| 190 | "A String", |
| 191 | ], |
| 192 | "uniqueItems": True or False, |
| 193 | "anyOf": [ |
| 194 | # Object with schema name: JSONSchemaProps |
| 195 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 196 | }, |
| 197 | }, |
| 198 | "group": "A String", # Group is the group this resource belongs in |
| 199 | "version": "A String", # Version is the version this resource belongs in |
| 200 | # Should be always first item in Versions field if provided. |
| 201 | # Optional, but at least one of Version or Versions must be set. |
| 202 | # Deprecated: Please use `Versions`. |
| 203 | # +optional |
| 204 | "names": { # CustomResourceDefinitionNames indicates the names to serve this # Names are the names used to describe this custom resource |
| 205 | # CustomResourceDefinition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 206 | "kind": "A String", # Kind is the serialized kind of the resource. It is normally CamelCase and |
| 207 | # singular. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 208 | "listKind": "A String", # ListKind is the serialized kind of the list for this resource. Defaults to |
| 209 | # <kind>List. +optional |
| 210 | "shortNames": [ # ShortNames are short names for the resource. It must be all lowercase. |
| 211 | # +optional |
| 212 | "A String", |
| 213 | ], |
| 214 | "singular": "A String", # Singular is the singular name of the resource. It must be all lowercase |
| 215 | # Defaults to lowercased <kind> +optional |
| 216 | "plural": "A String", # Plural is the plural name of the resource to serve. It must match the name |
| 217 | # of the CustomResourceDefinition-registration too: plural.group and it must |
| 218 | # be all lowercase. |
| 219 | "categories": [ # Categories is a list of grouped resources custom resources belong to (e.g. |
| 220 | # 'all') +optional |
| 221 | "A String", |
| 222 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 223 | }, |
| 224 | "subresources": { # CustomResourceSubresources defines the status and scale subresources for # Subresources describes the subresources for CustomResources |
| 225 | # +optional |
| 226 | # CustomResources. |
| 227 | "status": { # CustomResourceSubresourceStatus defines how to serve the status subresource # Status denotes the status subresource for CustomResources |
| 228 | # +optional |
| 229 | # for CustomResources. Status is represented by the `.status` JSON path inside |
| 230 | # of a CustomResource. When set, |
| 231 | # * exposes a /status subresource for the custom resource |
| 232 | # * PUT requests to the /status subresource take a custom resource object, and |
| 233 | # ignore changes to anything except the status stanza |
| 234 | # * PUT/POST/PATCH requests to the custom resource ignore changes to the status |
| 235 | # stanza |
| 236 | }, |
| 237 | "scale": { # CustomResourceSubresourceScale defines how to serve the scale subresource for # Scale denotes the scale subresource for CustomResources |
| 238 | # +optional |
| 239 | # CustomResources. |
| 240 | "statusReplicasPath": "A String", # StatusReplicasPath defines the JSON path inside of a CustomResource that |
| 241 | # corresponds to Scale.Status.Replicas. Only JSON paths without the array |
| 242 | # notation are allowed. Must be a JSON Path under .status. If there is no |
| 243 | # value under the given path in the CustomResource, the status replica value |
| 244 | # in the /scale subresource will default to 0. |
| 245 | "labelSelectorPath": "A String", # LabelSelectorPath defines the JSON path inside of a CustomResource that |
| 246 | # corresponds to Scale.Status.Selector. Only JSON paths without the array |
| 247 | # notation are allowed. Must be a JSON Path under .status. Must be set to |
| 248 | # work with HPA. If there is no value under the given path in the |
| 249 | # CustomResource, the status label selector value in the /scale subresource |
| 250 | # will default to the empty string. +optional |
| 251 | "specReplicasPath": "A String", # SpecReplicasPath defines the JSON path inside of a CustomResource that |
| 252 | # corresponds to Scale.Spec.Replicas. Only JSON paths without the array |
| 253 | # notation are allowed. Must be a JSON Path under .spec. If there is no value |
| 254 | # under the given path in the CustomResource, the /scale subresource will |
| 255 | # return an error on GET. |
| 256 | }, |
| 257 | }, |
| 258 | "scope": "A String", # Scope indicates whether this resource is cluster or namespace scoped. |
| 259 | # Default is namespaced |
| 260 | "versions": [ # Versions is the list of all supported versions for this resource. |
| 261 | # If Version field is provided, this field is optional. |
| 262 | # Validation: All versions must use the same validation schema for now. i.e., |
| 263 | # top level Validation field is applied to all of these versions. Order: The |
| 264 | # version name will be used to compute the order. If the version string is |
| 265 | # "kube-like", it will sort above non "kube-like" version strings, which are |
| 266 | # ordered lexicographically. "Kube-like" versions start with a "v", then are |
| 267 | # followed by a number (the major version), then optionally the string |
| 268 | # "alpha" or "beta" and another number (the minor version). These are sorted |
| 269 | # first by GA > beta > alpha (where GA is a version with no suffix such as |
| 270 | # beta or alpha), and then by comparing major version, then minor version. An |
| 271 | # example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, |
| 272 | # v12alpha1, v11alpha2, foo1, foo10. +optional |
| 273 | { |
| 274 | "name": "A String", # Name is the version name, e.g. “v1”, “v2beta1”, etc. |
| 275 | "served": True or False, # Served is a flag enabling/disabling this version from being served via REST |
| 276 | # APIs |
| 277 | "storage": True or False, # Storage flags the version as storage version. There must be exactly one |
| 278 | # flagged as storage version. |
| 279 | }, |
| 280 | ], |
| 281 | "additionalPrinterColumns": [ # AdditionalPrinterColumns are additional columns shown e.g. in kubectl next |
| 282 | # to the name. Defaults to a created-at column. +optional |
| 283 | { # CustomResourceColumnDefinition specifies a column for server side printing. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 284 | "jsonPath": "A String", # JSONPath is a simple JSON path, i.e. with array notation. |
| 285 | "priority": 42, # priority is an integer defining the relative importance of this column |
| 286 | # compared to others. Lower numbers are considered higher priority. Columns |
| 287 | # that may be omitted in limited space scenarios should be given a higher |
| 288 | # priority. +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 289 | "description": "A String", # description is a human readable description of this column. |
| 290 | # +optional |
| 291 | "name": "A String", # name is a human readable name for the column. |
| 292 | "format": "A String", # format is an optional OpenAPI type definition for this column. The 'name' |
| 293 | # format is applied to the primary identifier column to assist in clients |
| 294 | # identifying column is the resource name. See |
| 295 | # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types |
| 296 | # for more. +optional |
| 297 | "type": "A String", # type is an OpenAPI type definition for this column. |
| 298 | # See |
| 299 | # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types |
| 300 | # for more. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 301 | }, |
| 302 | ], |
| 303 | }, |
| 304 | "kind": "A String", # The kind of resource, in this case always "CustomResourceDefinition". |
| 305 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this CustomResourceDefinition. |
| 306 | # persisted resources must have, which includes all objects users must create. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 307 | "generateName": "A String", # (Optional) |
| 308 | # |
| 309 | # Cloud Run fully managed: not supported |
| 310 | # |
| 311 | # Cloud Run for Anthos: supported |
| 312 | # |
| 313 | # GenerateName is an optional prefix, used by the server, to generate a |
| 314 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 315 | # used, the name returned to the client will be different than the name |
| 316 | # passed. This value will also be combined with a unique suffix. The provided |
| 317 | # value has the same validation rules as the Name field, and may be truncated |
| 318 | # by the length of the suffix required to make the value unique on the |
| 319 | # server. |
| 320 | # |
| 321 | # If this field is specified and the generated name exists, the server will |
| 322 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 323 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 324 | # time allotted, and the client should retry (optionally after the time |
| 325 | # indicated in the Retry-After header). |
| 326 | # |
| 327 | # Applied only if Name is not specified. |
| 328 | # More info: |
| 329 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 330 | # string generateName = 2; |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 331 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 332 | # Is required when creating |
| 333 | # resources, although some resources may allow a client to request the |
| 334 | # generation of an appropriate name automatically. Name is primarily intended |
| 335 | # for creation idempotence and configuration definition. Cannot be updated. |
| 336 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 337 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 338 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 339 | # |
| 340 | # Cloud Run fully managed: not supported |
| 341 | # |
| 342 | # Cloud Run for Anthos: supported |
| 343 | # |
| 344 | # Number of seconds allowed for this object to gracefully terminate before |
| 345 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 346 | # set. May only be shortened. Read-only. |
| 347 | "clusterName": "A String", # (Optional) |
| 348 | # |
| 349 | # Cloud Run fully managed: not supported |
| 350 | # |
| 351 | # Cloud Run for Anthos: supported |
| 352 | # |
| 353 | # The name of the cluster which the object belongs to. |
| 354 | # This is used to distinguish resources with same name and namespace in |
| 355 | # different clusters. This field is not set anywhere right now and apiserver |
| 356 | # 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] | 357 | "finalizers": [ # (Optional) |
| 358 | # |
| 359 | # Cloud Run fully managed: not supported |
| 360 | # |
| 361 | # Cloud Run for Anthos: supported |
| 362 | # |
| 363 | # Must be empty before the object is deleted from the registry. Each entry |
| 364 | # is an identifier for the responsible component that will remove the entry |
| 365 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 366 | # in this list can only be removed. |
| 367 | # +patchStrategy=merge |
| 368 | "A String", |
| 369 | ], |
| 370 | "deletionTimestamp": "A String", # (Optional) |
| 371 | # |
| 372 | # Cloud Run fully managed: not supported |
| 373 | # |
| 374 | # Cloud Run for Anthos: supported |
| 375 | # |
| 376 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 377 | # deleted. This field is set by the server when a graceful deletion is |
| 378 | # requested by the user, and is not directly settable by a client. The |
| 379 | # resource is expected to be deleted (no longer visible from resource lists, |
| 380 | # and not reachable by name) after the time in this field, once the |
| 381 | # finalizers list is empty. As long as the finalizers list contains items, |
| 382 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 383 | # be unset or be set further into the future, although it may be shortened or |
| 384 | # the resource may be deleted prior to this time. For example, a user may |
| 385 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 386 | # sending a graceful termination signal to the containers in the pod. After |
| 387 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 388 | # to the container and after cleanup, remove the pod from the API. In the |
| 389 | # presence of network partitions, this object may still exist after this |
| 390 | # timestamp, until an administrator or automated process can determine the |
| 391 | # resource is fully terminated. |
| 392 | # If not set, graceful deletion of the object has not been requested. |
| 393 | # |
| 394 | # Populated by the system when a graceful deletion is requested. |
| 395 | # Read-only. |
| 396 | # More info: |
| 397 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 398 | "ownerReferences": [ # (Optional) |
| 399 | # |
| 400 | # Cloud Run fully managed: not supported |
| 401 | # |
| 402 | # Cloud Run for Anthos: supported |
| 403 | # |
| 404 | # List of objects that own this object. If ALL objects in the list have |
| 405 | # been deleted, this object will be garbage collected. |
| 406 | { # OwnerReference contains enough information to let you identify an owning |
| 407 | # object. Currently, an owning object must be in the same namespace, so there |
| 408 | # is no namespace field. |
| 409 | "apiVersion": "A String", # API version of the referent. |
| 410 | "name": "A String", # Name of the referent. |
| 411 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 412 | "uid": "A String", # UID of the referent. |
| 413 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 414 | "controller": True or False, # If true, this reference points to the managing controller. |
| 415 | # +optional |
| 416 | "kind": "A String", # Kind of the referent. |
| 417 | # More info: |
| 418 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 419 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 420 | # the owner cannot be deleted from the key-value store until this |
| 421 | # reference is removed. |
| 422 | # Defaults to false. |
| 423 | # To set this field, a user needs "delete" permission of the owner, |
| 424 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 425 | # +optional |
| 426 | }, |
| 427 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 428 | "creationTimestamp": "A String", # (Optional) |
| 429 | # |
| 430 | # CreationTimestamp is a timestamp representing the server time when this |
| 431 | # object was created. It is not guaranteed to be set in happens-before order |
| 432 | # across separate operations. Clients may not set this value. It is |
| 433 | # represented in RFC3339 form and is in UTC. |
| 434 | # |
| 435 | # Populated by the system. |
| 436 | # Read-only. |
| 437 | # Null for lists. |
| 438 | # More info: |
| 439 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 440 | "labels": { # (Optional) |
| 441 | # |
| 442 | # Map of string keys and values that can be used to organize and categorize |
| 443 | # (scope and select) objects. May match selectors of replication controllers |
| 444 | # and routes. |
| 445 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 446 | "a_key": "A String", |
| 447 | }, |
| 448 | "generation": 42, # (Optional) |
| 449 | # |
| 450 | # A sequence number representing a specific generation of the desired state. |
| 451 | # Populated by the system. Read-only. |
| 452 | "resourceVersion": "A String", # (Optional) |
| 453 | # |
| 454 | # An opaque value that represents the internal version of this object that |
| 455 | # can be used by clients to determine when objects have changed. May be used |
| 456 | # for optimistic concurrency, change detection, and the watch operation on a |
| 457 | # resource or set of resources. Clients must treat these values as opaque and |
| 458 | # passed unmodified back to the server. They may only be valid for a |
| 459 | # particular resource or set of resources. |
| 460 | # |
| 461 | # Populated by the system. |
| 462 | # Read-only. |
| 463 | # Value must be treated as opaque by clients and . |
| 464 | # More info: |
| 465 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 466 | "uid": "A String", # (Optional) |
| 467 | # |
| 468 | # UID is the unique in time and space value for this object. It is typically |
| 469 | # generated by the server on successful creation of a resource and is not |
| 470 | # allowed to change on PUT operations. |
| 471 | # |
| 472 | # Populated by the system. |
| 473 | # Read-only. |
| 474 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 475 | "selfLink": "A String", # (Optional) |
| 476 | # |
| 477 | # SelfLink is a URL representing this object. |
| 478 | # Populated by the system. |
| 479 | # Read-only. |
| 480 | # string selfLink = 4; |
| 481 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 482 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 483 | # project ID or project number. |
| 484 | "annotations": { # (Optional) |
| 485 | # |
| 486 | # Annotations is an unstructured key value map stored with a resource that |
| 487 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 488 | # are not queryable and should be preserved when modifying objects. More |
| 489 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 490 | "a_key": "A String", |
| 491 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 492 | }, |
| 493 | }</pre> |
| 494 | </div> |
| 495 | |
| 496 | <div class="method"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 497 | <code class="details" id="list">list(parent, continue=None, limit=None, watch=None, labelSelector=None, fieldSelector=None, resourceVersion=None, includeUninitialized=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 498 | <pre>Rpc to list custom resource definitions. |
| 499 | |
| 500 | Args: |
| 501 | parent: string, The project ID or project number from which the storages should |
| 502 | be listed. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 503 | continue: string, Optional encoded string to continue paging. |
| 504 | limit: integer, A parameter |
| 505 | watch: boolean, Flag that indicates that the client expects to watch this resource as well. |
| 506 | Not currently used by Cloud Run. |
| 507 | labelSelector: string, Allows to filter resources based on a label. Supported operations are |
| 508 | =, !=, exists, in, and notIn. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 509 | fieldSelector: string, Allows to filter resources based on a specific value for a field name. |
| 510 | Send this in a query string format. i.e. 'metadata.name%3Dlorem'. |
| 511 | Not currently used by Cloud Run. |
| 512 | resourceVersion: string, The baseline resource version from which the list or watch operation should |
| 513 | start. Not currently used by Cloud Run. |
| 514 | includeUninitialized: boolean, Not currently used by Cloud Run. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 515 | x__xgafv: string, V1 error format. |
| 516 | Allowed values |
| 517 | 1 - v1 error format |
| 518 | 2 - v2 error format |
| 519 | |
| 520 | Returns: |
| 521 | An object of the form: |
| 522 | |
| 523 | { |
| 524 | "apiVersion": "A String", # The API version for this call such as "k8s.apiextensions.io/v1beta1". |
| 525 | "kind": "A String", # The kind of this resource, in this case "CustomResourceDefinitionList". |
| 526 | "unreachable": [ # Locations that could not be reached. |
| 527 | "A String", |
| 528 | ], |
| 529 | "metadata": { # ListMeta describes metadata that synthetic resources must have, including # Metadata associated with this CustomResourceDefinition list. |
| 530 | # lists and various status objects. A resource may have only one of |
| 531 | # {ObjectMeta, ListMeta}. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 532 | "resourceVersion": "A String", # String that identifies the server's internal version of this object that |
| 533 | # can be used by clients to determine when objects have changed. Value must |
| 534 | # be treated as opaque by clients and passed unmodified back to the server. |
| 535 | # Populated by the system. |
| 536 | # Read-only. |
| 537 | # More info: |
| 538 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 539 | # +optional |
| 540 | "continue": "A String", # continue may be set if the user set a limit on the number of items |
| 541 | # returned, and indicates that the server has more data available. The value |
| 542 | # is opaque and may be used to issue another request to the endpoint that |
| 543 | # served this list to retrieve the next set of available objects. Continuing |
| 544 | # a list may not be possible if the server configuration has changed or more |
| 545 | # than a few minutes have passed. The resourceVersion field returned when |
| 546 | # using this continue value will be identical to the value in the first |
| 547 | # response. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 548 | "selfLink": "A String", # SelfLink is a URL representing this object. |
| 549 | # Populated by the system. |
| 550 | # Read-only. |
| 551 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 552 | }, |
| 553 | "items": [ # List of CustomResourceDefinitions. |
| 554 | { # CustomResourceDefinition represents a resource that should be exposed on the |
| 555 | # API server. Its name MUST be in the format |
| 556 | # <.spec.name>.<.spec.group>. |
| 557 | "apiVersion": "A String", # The API version for this call such as "k8s.apiextensions.io/v1beta1". |
| 558 | "spec": { # CustomResourceDefinitionSpec describes how a user wants their resource to # Spec describes how the user wants the resources to appear |
| 559 | # appear |
| 560 | "validation": { # CustomResourceValidation is a list of validation methods for CustomResources. # Validation describes the validation methods for CustomResources |
| 561 | # +optional |
| 562 | "openAPIV3Schema": { # JSONSchemaProps is a JSON-Schema following Specification Draft 4 # OpenAPIV3Schema is the OpenAPI v3 schema to be validated against. |
| 563 | # +optional |
| 564 | # (http://json-schema.org/). |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 565 | "description": "A String", |
| 566 | "example": { # JSON represents any valid JSON value. |
| 567 | # These types are supported: bool, int64, float64, string, []interface{}, |
| 568 | # map[string]interface{} and nil. |
| 569 | "raw": "A String", |
| 570 | }, |
| 571 | "default": { # JSON represents any valid JSON value. |
| 572 | # These types are supported: bool, int64, float64, string, []interface{}, |
| 573 | # map[string]interface{} and nil. |
| 574 | "raw": "A String", |
| 575 | }, |
| 576 | "allOf": [ |
| 577 | # Object with schema name: JSONSchemaProps |
| 578 | ], |
| 579 | "maxLength": "A String", |
| 580 | "maxProperties": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 581 | "multipleOf": 3.14, |
| 582 | "maximum": 3.14, |
| 583 | "items": { # JSONSchemaPropsOrArray represents a value that can either be a |
| 584 | # JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization |
| 585 | # purposes. |
| 586 | "jsonSchemas": [ |
| 587 | # Object with schema name: JSONSchemaProps |
| 588 | ], |
| 589 | "schema": # Object with schema name: JSONSchemaProps |
| 590 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 591 | "externalDocs": { # ExternalDocumentation allows referencing an external resource for extended |
| 592 | # documentation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 593 | "description": "A String", |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 594 | "url": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 595 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 596 | "schema": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 597 | "id": "A String", |
| 598 | "minimum": 3.14, |
| 599 | "properties": { |
| 600 | "a_key": # Object with schema name: JSONSchemaProps |
| 601 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 602 | "pattern": "A String", |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 603 | "ref": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 604 | "format": "A String", |
| 605 | "minLength": "A String", |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 606 | "type": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 607 | "dependencies": { |
| 608 | "a_key": { # JSONSchemaPropsOrStringArray represents a JSONSchemaProps or a string array. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 609 | "schema": # Object with schema name: JSONSchemaProps |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 610 | "property": [ |
| 611 | "A String", |
| 612 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 613 | }, |
| 614 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 615 | "not": # Object with schema name: JSONSchemaProps |
| 616 | "minProperties": "A String", |
| 617 | "exclusiveMaximum": True or False, |
| 618 | "patternProperties": { |
| 619 | "a_key": # Object with schema name: JSONSchemaProps |
| 620 | }, |
| 621 | "additionalProperties": { # JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. |
| 622 | # Defaults to true for the boolean property. |
| 623 | "allows": True or False, |
| 624 | "schema": # Object with schema name: JSONSchemaProps |
| 625 | }, |
| 626 | "maxItems": "A String", |
| 627 | "exclusiveMinimum": True or False, |
| 628 | "additionalItems": { # JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. |
| 629 | # Defaults to true for the boolean property. |
| 630 | "allows": True or False, |
| 631 | "schema": # Object with schema name: JSONSchemaProps |
| 632 | }, |
| 633 | "oneOf": [ |
| 634 | # Object with schema name: JSONSchemaProps |
| 635 | ], |
| 636 | "required": [ |
| 637 | "A String", |
| 638 | ], |
| 639 | "minItems": "A String", |
| 640 | "title": "A String", |
| 641 | "definitions": { |
| 642 | "a_key": # Object with schema name: JSONSchemaProps |
| 643 | }, |
| 644 | "enum": [ |
| 645 | "A String", |
| 646 | ], |
| 647 | "uniqueItems": True or False, |
| 648 | "anyOf": [ |
| 649 | # Object with schema name: JSONSchemaProps |
| 650 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 651 | }, |
| 652 | }, |
| 653 | "group": "A String", # Group is the group this resource belongs in |
| 654 | "version": "A String", # Version is the version this resource belongs in |
| 655 | # Should be always first item in Versions field if provided. |
| 656 | # Optional, but at least one of Version or Versions must be set. |
| 657 | # Deprecated: Please use `Versions`. |
| 658 | # +optional |
| 659 | "names": { # CustomResourceDefinitionNames indicates the names to serve this # Names are the names used to describe this custom resource |
| 660 | # CustomResourceDefinition |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 661 | "kind": "A String", # Kind is the serialized kind of the resource. It is normally CamelCase and |
| 662 | # singular. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 663 | "listKind": "A String", # ListKind is the serialized kind of the list for this resource. Defaults to |
| 664 | # <kind>List. +optional |
| 665 | "shortNames": [ # ShortNames are short names for the resource. It must be all lowercase. |
| 666 | # +optional |
| 667 | "A String", |
| 668 | ], |
| 669 | "singular": "A String", # Singular is the singular name of the resource. It must be all lowercase |
| 670 | # Defaults to lowercased <kind> +optional |
| 671 | "plural": "A String", # Plural is the plural name of the resource to serve. It must match the name |
| 672 | # of the CustomResourceDefinition-registration too: plural.group and it must |
| 673 | # be all lowercase. |
| 674 | "categories": [ # Categories is a list of grouped resources custom resources belong to (e.g. |
| 675 | # 'all') +optional |
| 676 | "A String", |
| 677 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 678 | }, |
| 679 | "subresources": { # CustomResourceSubresources defines the status and scale subresources for # Subresources describes the subresources for CustomResources |
| 680 | # +optional |
| 681 | # CustomResources. |
| 682 | "status": { # CustomResourceSubresourceStatus defines how to serve the status subresource # Status denotes the status subresource for CustomResources |
| 683 | # +optional |
| 684 | # for CustomResources. Status is represented by the `.status` JSON path inside |
| 685 | # of a CustomResource. When set, |
| 686 | # * exposes a /status subresource for the custom resource |
| 687 | # * PUT requests to the /status subresource take a custom resource object, and |
| 688 | # ignore changes to anything except the status stanza |
| 689 | # * PUT/POST/PATCH requests to the custom resource ignore changes to the status |
| 690 | # stanza |
| 691 | }, |
| 692 | "scale": { # CustomResourceSubresourceScale defines how to serve the scale subresource for # Scale denotes the scale subresource for CustomResources |
| 693 | # +optional |
| 694 | # CustomResources. |
| 695 | "statusReplicasPath": "A String", # StatusReplicasPath defines the JSON path inside of a CustomResource that |
| 696 | # corresponds to Scale.Status.Replicas. Only JSON paths without the array |
| 697 | # notation are allowed. Must be a JSON Path under .status. If there is no |
| 698 | # value under the given path in the CustomResource, the status replica value |
| 699 | # in the /scale subresource will default to 0. |
| 700 | "labelSelectorPath": "A String", # LabelSelectorPath defines the JSON path inside of a CustomResource that |
| 701 | # corresponds to Scale.Status.Selector. Only JSON paths without the array |
| 702 | # notation are allowed. Must be a JSON Path under .status. Must be set to |
| 703 | # work with HPA. If there is no value under the given path in the |
| 704 | # CustomResource, the status label selector value in the /scale subresource |
| 705 | # will default to the empty string. +optional |
| 706 | "specReplicasPath": "A String", # SpecReplicasPath defines the JSON path inside of a CustomResource that |
| 707 | # corresponds to Scale.Spec.Replicas. Only JSON paths without the array |
| 708 | # notation are allowed. Must be a JSON Path under .spec. If there is no value |
| 709 | # under the given path in the CustomResource, the /scale subresource will |
| 710 | # return an error on GET. |
| 711 | }, |
| 712 | }, |
| 713 | "scope": "A String", # Scope indicates whether this resource is cluster or namespace scoped. |
| 714 | # Default is namespaced |
| 715 | "versions": [ # Versions is the list of all supported versions for this resource. |
| 716 | # If Version field is provided, this field is optional. |
| 717 | # Validation: All versions must use the same validation schema for now. i.e., |
| 718 | # top level Validation field is applied to all of these versions. Order: The |
| 719 | # version name will be used to compute the order. If the version string is |
| 720 | # "kube-like", it will sort above non "kube-like" version strings, which are |
| 721 | # ordered lexicographically. "Kube-like" versions start with a "v", then are |
| 722 | # followed by a number (the major version), then optionally the string |
| 723 | # "alpha" or "beta" and another number (the minor version). These are sorted |
| 724 | # first by GA > beta > alpha (where GA is a version with no suffix such as |
| 725 | # beta or alpha), and then by comparing major version, then minor version. An |
| 726 | # example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, |
| 727 | # v12alpha1, v11alpha2, foo1, foo10. +optional |
| 728 | { |
| 729 | "name": "A String", # Name is the version name, e.g. “v1”, “v2beta1”, etc. |
| 730 | "served": True or False, # Served is a flag enabling/disabling this version from being served via REST |
| 731 | # APIs |
| 732 | "storage": True or False, # Storage flags the version as storage version. There must be exactly one |
| 733 | # flagged as storage version. |
| 734 | }, |
| 735 | ], |
| 736 | "additionalPrinterColumns": [ # AdditionalPrinterColumns are additional columns shown e.g. in kubectl next |
| 737 | # to the name. Defaults to a created-at column. +optional |
| 738 | { # CustomResourceColumnDefinition specifies a column for server side printing. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 739 | "jsonPath": "A String", # JSONPath is a simple JSON path, i.e. with array notation. |
| 740 | "priority": 42, # priority is an integer defining the relative importance of this column |
| 741 | # compared to others. Lower numbers are considered higher priority. Columns |
| 742 | # that may be omitted in limited space scenarios should be given a higher |
| 743 | # priority. +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 744 | "description": "A String", # description is a human readable description of this column. |
| 745 | # +optional |
| 746 | "name": "A String", # name is a human readable name for the column. |
| 747 | "format": "A String", # format is an optional OpenAPI type definition for this column. The 'name' |
| 748 | # format is applied to the primary identifier column to assist in clients |
| 749 | # identifying column is the resource name. See |
| 750 | # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types |
| 751 | # for more. +optional |
| 752 | "type": "A String", # type is an OpenAPI type definition for this column. |
| 753 | # See |
| 754 | # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types |
| 755 | # for more. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 756 | }, |
| 757 | ], |
| 758 | }, |
| 759 | "kind": "A String", # The kind of resource, in this case always "CustomResourceDefinition". |
| 760 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Metadata associated with this CustomResourceDefinition. |
| 761 | # persisted resources must have, which includes all objects users must create. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 762 | "generateName": "A String", # (Optional) |
| 763 | # |
| 764 | # Cloud Run fully managed: not supported |
| 765 | # |
| 766 | # Cloud Run for Anthos: supported |
| 767 | # |
| 768 | # GenerateName is an optional prefix, used by the server, to generate a |
| 769 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 770 | # used, the name returned to the client will be different than the name |
| 771 | # passed. This value will also be combined with a unique suffix. The provided |
| 772 | # value has the same validation rules as the Name field, and may be truncated |
| 773 | # by the length of the suffix required to make the value unique on the |
| 774 | # server. |
| 775 | # |
| 776 | # If this field is specified and the generated name exists, the server will |
| 777 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 778 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 779 | # time allotted, and the client should retry (optionally after the time |
| 780 | # indicated in the Retry-After header). |
| 781 | # |
| 782 | # Applied only if Name is not specified. |
| 783 | # More info: |
| 784 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 785 | # string generateName = 2; |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 786 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 787 | # Is required when creating |
| 788 | # resources, although some resources may allow a client to request the |
| 789 | # generation of an appropriate name automatically. Name is primarily intended |
| 790 | # for creation idempotence and configuration definition. Cannot be updated. |
| 791 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 792 | # +optional |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 793 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 794 | # |
| 795 | # Cloud Run fully managed: not supported |
| 796 | # |
| 797 | # Cloud Run for Anthos: supported |
| 798 | # |
| 799 | # Number of seconds allowed for this object to gracefully terminate before |
| 800 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 801 | # set. May only be shortened. Read-only. |
| 802 | "clusterName": "A String", # (Optional) |
| 803 | # |
| 804 | # Cloud Run fully managed: not supported |
| 805 | # |
| 806 | # Cloud Run for Anthos: supported |
| 807 | # |
| 808 | # The name of the cluster which the object belongs to. |
| 809 | # This is used to distinguish resources with same name and namespace in |
| 810 | # different clusters. This field is not set anywhere right now and apiserver |
| 811 | # 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] | 812 | "finalizers": [ # (Optional) |
| 813 | # |
| 814 | # Cloud Run fully managed: not supported |
| 815 | # |
| 816 | # Cloud Run for Anthos: supported |
| 817 | # |
| 818 | # Must be empty before the object is deleted from the registry. Each entry |
| 819 | # is an identifier for the responsible component that will remove the entry |
| 820 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 821 | # in this list can only be removed. |
| 822 | # +patchStrategy=merge |
| 823 | "A String", |
| 824 | ], |
| 825 | "deletionTimestamp": "A String", # (Optional) |
| 826 | # |
| 827 | # Cloud Run fully managed: not supported |
| 828 | # |
| 829 | # Cloud Run for Anthos: supported |
| 830 | # |
| 831 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 832 | # deleted. This field is set by the server when a graceful deletion is |
| 833 | # requested by the user, and is not directly settable by a client. The |
| 834 | # resource is expected to be deleted (no longer visible from resource lists, |
| 835 | # and not reachable by name) after the time in this field, once the |
| 836 | # finalizers list is empty. As long as the finalizers list contains items, |
| 837 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 838 | # be unset or be set further into the future, although it may be shortened or |
| 839 | # the resource may be deleted prior to this time. For example, a user may |
| 840 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 841 | # sending a graceful termination signal to the containers in the pod. After |
| 842 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 843 | # to the container and after cleanup, remove the pod from the API. In the |
| 844 | # presence of network partitions, this object may still exist after this |
| 845 | # timestamp, until an administrator or automated process can determine the |
| 846 | # resource is fully terminated. |
| 847 | # If not set, graceful deletion of the object has not been requested. |
| 848 | # |
| 849 | # Populated by the system when a graceful deletion is requested. |
| 850 | # Read-only. |
| 851 | # More info: |
| 852 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 853 | "ownerReferences": [ # (Optional) |
| 854 | # |
| 855 | # Cloud Run fully managed: not supported |
| 856 | # |
| 857 | # Cloud Run for Anthos: supported |
| 858 | # |
| 859 | # List of objects that own this object. If ALL objects in the list have |
| 860 | # been deleted, this object will be garbage collected. |
| 861 | { # OwnerReference contains enough information to let you identify an owning |
| 862 | # object. Currently, an owning object must be in the same namespace, so there |
| 863 | # is no namespace field. |
| 864 | "apiVersion": "A String", # API version of the referent. |
| 865 | "name": "A String", # Name of the referent. |
| 866 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 867 | "uid": "A String", # UID of the referent. |
| 868 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 869 | "controller": True or False, # If true, this reference points to the managing controller. |
| 870 | # +optional |
| 871 | "kind": "A String", # Kind of the referent. |
| 872 | # More info: |
| 873 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 874 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 875 | # the owner cannot be deleted from the key-value store until this |
| 876 | # reference is removed. |
| 877 | # Defaults to false. |
| 878 | # To set this field, a user needs "delete" permission of the owner, |
| 879 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 880 | # +optional |
| 881 | }, |
| 882 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 883 | "creationTimestamp": "A String", # (Optional) |
| 884 | # |
| 885 | # CreationTimestamp is a timestamp representing the server time when this |
| 886 | # object was created. It is not guaranteed to be set in happens-before order |
| 887 | # across separate operations. Clients may not set this value. It is |
| 888 | # represented in RFC3339 form and is in UTC. |
| 889 | # |
| 890 | # Populated by the system. |
| 891 | # Read-only. |
| 892 | # Null for lists. |
| 893 | # More info: |
| 894 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 895 | "labels": { # (Optional) |
| 896 | # |
| 897 | # Map of string keys and values that can be used to organize and categorize |
| 898 | # (scope and select) objects. May match selectors of replication controllers |
| 899 | # and routes. |
| 900 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 901 | "a_key": "A String", |
| 902 | }, |
| 903 | "generation": 42, # (Optional) |
| 904 | # |
| 905 | # A sequence number representing a specific generation of the desired state. |
| 906 | # Populated by the system. Read-only. |
| 907 | "resourceVersion": "A String", # (Optional) |
| 908 | # |
| 909 | # An opaque value that represents the internal version of this object that |
| 910 | # can be used by clients to determine when objects have changed. May be used |
| 911 | # for optimistic concurrency, change detection, and the watch operation on a |
| 912 | # resource or set of resources. Clients must treat these values as opaque and |
| 913 | # passed unmodified back to the server. They may only be valid for a |
| 914 | # particular resource or set of resources. |
| 915 | # |
| 916 | # Populated by the system. |
| 917 | # Read-only. |
| 918 | # Value must be treated as opaque by clients and . |
| 919 | # More info: |
| 920 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 921 | "uid": "A String", # (Optional) |
| 922 | # |
| 923 | # UID is the unique in time and space value for this object. It is typically |
| 924 | # generated by the server on successful creation of a resource and is not |
| 925 | # allowed to change on PUT operations. |
| 926 | # |
| 927 | # Populated by the system. |
| 928 | # Read-only. |
| 929 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 930 | "selfLink": "A String", # (Optional) |
| 931 | # |
| 932 | # SelfLink is a URL representing this object. |
| 933 | # Populated by the system. |
| 934 | # Read-only. |
| 935 | # string selfLink = 4; |
| 936 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 937 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 938 | # project ID or project number. |
| 939 | "annotations": { # (Optional) |
| 940 | # |
| 941 | # Annotations is an unstructured key value map stored with a resource that |
| 942 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 943 | # are not queryable and should be preserved when modifying objects. More |
| 944 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 945 | "a_key": "A String", |
| 946 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 947 | }, |
| 948 | }, |
| 949 | ], |
| 950 | }</pre> |
| 951 | </div> |
| 952 | |
| 953 | </body></html> |