| 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_v1.html">Cloud Run API</a> . <a href="run_v1.api.html">api</a> . <a href="run_v1.api.v1.html">v1</a> . <a href="run_v1.api.v1.namespaces.html">namespaces</a> . <a href="run_v1.api.v1.namespaces.secrets.html">secrets</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Creates a new secret.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Rpc to get information about a secret.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#replaceSecret">replaceSecret(name, body=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Rpc to replace a secret.</p> |
| 86 | <h3>Method Details</h3> |
| 87 | <div class="method"> |
| 88 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| 89 | <pre>Creates a new secret. |
| 90 | |
| 91 | Args: |
| 92 | parent: string, Required. The project ID or project number in which this secret should |
| 93 | be created. (required) |
| 94 | body: object, The request body. |
| 95 | The object takes the form of: |
| 96 | |
| 97 | { # Cloud Run fully managed: not supported |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 98 | # |
| 99 | # Cloud Run on GKE: supported |
| 100 | # |
| 101 | # Secret holds secret data of a certain type. The total bytes of the values in |
| 102 | # the Data field must be less than MaxSecretSize bytes. |
| 103 | "data": { # Data contains the secret data. Each key must consist of alphanumeric |
| 104 | # characters, '-', '_' or '.'. The serialized form of the secret data is a |
| 105 | # base64 encoded string, representing the arbitrary (possibly non-string) |
| 106 | # data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 |
| 107 | "a_key": "A String", |
| 108 | }, |
| 109 | "stringData": { # stringData allows specifying non-binary secret data in string form. |
| 110 | # It is provided as a write-only convenience method. |
| 111 | # All keys and values are merged into the data field on write, overwriting |
| 112 | # any existing values. It is never output when reading from the API. |
| 113 | # +k8s:conversion-gen=false |
| 114 | "a_key": "A String", |
| 115 | }, |
| 116 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Standard object's metadata. |
| 117 | # More info: |
| 118 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 119 | # persisted resources must have, which includes all objects users must create. |
| 120 | "annotations": { # (Optional) |
| 121 | # |
| 122 | # Annotations is an unstructured key value map stored with a resource that |
| 123 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 124 | # are not queryable and should be preserved when modifying objects. More |
| 125 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 126 | "a_key": "A String", |
| 127 | }, |
| 128 | "generateName": "A String", # (Optional) |
| 129 | # |
| 130 | # Cloud Run fully managed: not supported |
| 131 | # |
| 132 | # Cloud Run for Anthos: supported |
| 133 | # |
| 134 | # GenerateName is an optional prefix, used by the server, to generate a |
| 135 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 136 | # used, the name returned to the client will be different than the name |
| 137 | # passed. This value will also be combined with a unique suffix. The provided |
| 138 | # value has the same validation rules as the Name field, and may be truncated |
| 139 | # by the length of the suffix required to make the value unique on the |
| 140 | # server. |
| 141 | # |
| 142 | # If this field is specified and the generated name exists, the server will |
| 143 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 144 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 145 | # time allotted, and the client should retry (optionally after the time |
| 146 | # indicated in the Retry-After header). |
| 147 | # |
| 148 | # Applied only if Name is not specified. |
| 149 | # More info: |
| 150 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 151 | # string generateName = 2; |
| 152 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 153 | # Is required when creating |
| 154 | # resources, although some resources may allow a client to request the |
| 155 | # generation of an appropriate name automatically. Name is primarily intended |
| 156 | # for creation idempotence and configuration definition. Cannot be updated. |
| 157 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 158 | # +optional |
| 159 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 160 | # |
| 161 | # Cloud Run fully managed: not supported |
| 162 | # |
| 163 | # Cloud Run for Anthos: supported |
| 164 | # |
| 165 | # Number of seconds allowed for this object to gracefully terminate before |
| 166 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 167 | # set. May only be shortened. Read-only. |
| 168 | "clusterName": "A String", # (Optional) |
| 169 | # |
| 170 | # Cloud Run fully managed: not supported |
| 171 | # |
| 172 | # Cloud Run for Anthos: supported |
| 173 | # |
| 174 | # The name of the cluster which the object belongs to. |
| 175 | # This is used to distinguish resources with same name and namespace in |
| 176 | # different clusters. This field is not set anywhere right now and apiserver |
| 177 | # is going to ignore it if set in create or update request. |
| 178 | "finalizers": [ # (Optional) |
| 179 | # |
| 180 | # Cloud Run fully managed: not supported |
| 181 | # |
| 182 | # Cloud Run for Anthos: supported |
| 183 | # |
| 184 | # Must be empty before the object is deleted from the registry. Each entry |
| 185 | # is an identifier for the responsible component that will remove the entry |
| 186 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 187 | # in this list can only be removed. |
| 188 | # +patchStrategy=merge |
| 189 | "A String", |
| 190 | ], |
| 191 | "deletionTimestamp": "A String", # (Optional) |
| 192 | # |
| 193 | # Cloud Run fully managed: not supported |
| 194 | # |
| 195 | # Cloud Run for Anthos: supported |
| 196 | # |
| 197 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 198 | # deleted. This field is set by the server when a graceful deletion is |
| 199 | # requested by the user, and is not directly settable by a client. The |
| 200 | # resource is expected to be deleted (no longer visible from resource lists, |
| 201 | # and not reachable by name) after the time in this field, once the |
| 202 | # finalizers list is empty. As long as the finalizers list contains items, |
| 203 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 204 | # be unset or be set further into the future, although it may be shortened or |
| 205 | # the resource may be deleted prior to this time. For example, a user may |
| 206 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 207 | # sending a graceful termination signal to the containers in the pod. After |
| 208 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 209 | # to the container and after cleanup, remove the pod from the API. In the |
| 210 | # presence of network partitions, this object may still exist after this |
| 211 | # timestamp, until an administrator or automated process can determine the |
| 212 | # resource is fully terminated. |
| 213 | # If not set, graceful deletion of the object has not been requested. |
| 214 | # |
| 215 | # Populated by the system when a graceful deletion is requested. |
| 216 | # Read-only. |
| 217 | # More info: |
| 218 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 219 | "ownerReferences": [ # (Optional) |
| 220 | # |
| 221 | # Cloud Run fully managed: not supported |
| 222 | # |
| 223 | # Cloud Run for Anthos: supported |
| 224 | # |
| 225 | # List of objects that own this object. If ALL objects in the list have |
| 226 | # been deleted, this object will be garbage collected. |
| 227 | { # OwnerReference contains enough information to let you identify an owning |
| 228 | # object. Currently, an owning object must be in the same namespace, so there |
| 229 | # is no namespace field. |
| 230 | "controller": True or False, # If true, this reference points to the managing controller. |
| 231 | # +optional |
| 232 | "kind": "A String", # Kind of the referent. |
| 233 | # More info: |
| 234 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 235 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 236 | # the owner cannot be deleted from the key-value store until this |
| 237 | # reference is removed. |
| 238 | # Defaults to false. |
| 239 | # To set this field, a user needs "delete" permission of the owner, |
| 240 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 241 | # +optional |
| 242 | "apiVersion": "A String", # API version of the referent. |
| 243 | "name": "A String", # Name of the referent. |
| 244 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 245 | "uid": "A String", # UID of the referent. |
| 246 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 247 | }, |
| 248 | ], |
| 249 | "creationTimestamp": "A String", # (Optional) |
| 250 | # |
| 251 | # CreationTimestamp is a timestamp representing the server time when this |
| 252 | # object was created. It is not guaranteed to be set in happens-before order |
| 253 | # across separate operations. Clients may not set this value. It is |
| 254 | # represented in RFC3339 form and is in UTC. |
| 255 | # |
| 256 | # Populated by the system. |
| 257 | # Read-only. |
| 258 | # Null for lists. |
| 259 | # More info: |
| 260 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 261 | "labels": { # (Optional) |
| 262 | # |
| 263 | # Map of string keys and values that can be used to organize and categorize |
| 264 | # (scope and select) objects. May match selectors of replication controllers |
| 265 | # and routes. |
| 266 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 267 | "a_key": "A String", |
| 268 | }, |
| 269 | "generation": 42, # (Optional) |
| 270 | # |
| 271 | # A sequence number representing a specific generation of the desired state. |
| 272 | # Populated by the system. Read-only. |
| 273 | "resourceVersion": "A String", # (Optional) |
| 274 | # |
| 275 | # An opaque value that represents the internal version of this object that |
| 276 | # can be used by clients to determine when objects have changed. May be used |
| 277 | # for optimistic concurrency, change detection, and the watch operation on a |
| 278 | # resource or set of resources. Clients must treat these values as opaque and |
| 279 | # passed unmodified back to the server. They may only be valid for a |
| 280 | # particular resource or set of resources. |
| 281 | # |
| 282 | # Populated by the system. |
| 283 | # Read-only. |
| 284 | # Value must be treated as opaque by clients and . |
| 285 | # More info: |
| 286 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 287 | "selfLink": "A String", # (Optional) |
| 288 | # |
| 289 | # SelfLink is a URL representing this object. |
| 290 | # Populated by the system. |
| 291 | # Read-only. |
| 292 | # string selfLink = 4; |
| 293 | "uid": "A String", # (Optional) |
| 294 | # |
| 295 | # UID is the unique in time and space value for this object. It is typically |
| 296 | # generated by the server on successful creation of a resource and is not |
| 297 | # allowed to change on PUT operations. |
| 298 | # |
| 299 | # Populated by the system. |
| 300 | # Read-only. |
| 301 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 302 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 303 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 304 | # project ID or project number. |
| 305 | }, |
| 306 | "type": "A String", # Used to facilitate programmatic handling of secret data. |
| 307 | } |
| 308 | |
| 309 | x__xgafv: string, V1 error format. |
| 310 | Allowed values |
| 311 | 1 - v1 error format |
| 312 | 2 - v2 error format |
| 313 | |
| 314 | Returns: |
| 315 | An object of the form: |
| 316 | |
| 317 | { # Cloud Run fully managed: not supported |
| 318 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 319 | # Cloud Run on GKE: supported |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 320 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 321 | # Secret holds secret data of a certain type. The total bytes of the values in |
| 322 | # the Data field must be less than MaxSecretSize bytes. |
| 323 | "data": { # Data contains the secret data. Each key must consist of alphanumeric |
| 324 | # characters, '-', '_' or '.'. The serialized form of the secret data is a |
| 325 | # base64 encoded string, representing the arbitrary (possibly non-string) |
| 326 | # data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 |
| 327 | "a_key": "A String", |
| 328 | }, |
| 329 | "stringData": { # stringData allows specifying non-binary secret data in string form. |
| 330 | # It is provided as a write-only convenience method. |
| 331 | # All keys and values are merged into the data field on write, overwriting |
| 332 | # any existing values. It is never output when reading from the API. |
| 333 | # +k8s:conversion-gen=false |
| 334 | "a_key": "A String", |
| 335 | }, |
| 336 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Standard object's metadata. |
| 337 | # More info: |
| 338 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 339 | # persisted resources must have, which includes all objects users must create. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 340 | "annotations": { # (Optional) |
| 341 | # |
| 342 | # Annotations is an unstructured key value map stored with a resource that |
| 343 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 344 | # are not queryable and should be preserved when modifying objects. More |
| 345 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 346 | "a_key": "A String", |
| 347 | }, |
| 348 | "generateName": "A String", # (Optional) |
| 349 | # |
| 350 | # Cloud Run fully managed: not supported |
| 351 | # |
| 352 | # Cloud Run for Anthos: supported |
| 353 | # |
| 354 | # GenerateName is an optional prefix, used by the server, to generate a |
| 355 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 356 | # used, the name returned to the client will be different than the name |
| 357 | # passed. This value will also be combined with a unique suffix. The provided |
| 358 | # value has the same validation rules as the Name field, and may be truncated |
| 359 | # by the length of the suffix required to make the value unique on the |
| 360 | # server. |
| 361 | # |
| 362 | # If this field is specified and the generated name exists, the server will |
| 363 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 364 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 365 | # time allotted, and the client should retry (optionally after the time |
| 366 | # indicated in the Retry-After header). |
| 367 | # |
| 368 | # Applied only if Name is not specified. |
| 369 | # More info: |
| 370 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 371 | # string generateName = 2; |
| 372 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 373 | # Is required when creating |
| 374 | # resources, although some resources may allow a client to request the |
| 375 | # generation of an appropriate name automatically. Name is primarily intended |
| 376 | # for creation idempotence and configuration definition. Cannot be updated. |
| 377 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 378 | # +optional |
| 379 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 380 | # |
| 381 | # Cloud Run fully managed: not supported |
| 382 | # |
| 383 | # Cloud Run for Anthos: supported |
| 384 | # |
| 385 | # Number of seconds allowed for this object to gracefully terminate before |
| 386 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 387 | # set. May only be shortened. Read-only. |
| 388 | "clusterName": "A String", # (Optional) |
| 389 | # |
| 390 | # Cloud Run fully managed: not supported |
| 391 | # |
| 392 | # Cloud Run for Anthos: supported |
| 393 | # |
| 394 | # The name of the cluster which the object belongs to. |
| 395 | # This is used to distinguish resources with same name and namespace in |
| 396 | # different clusters. This field is not set anywhere right now and apiserver |
| 397 | # is going to ignore it if set in create or update request. |
| 398 | "finalizers": [ # (Optional) |
| 399 | # |
| 400 | # Cloud Run fully managed: not supported |
| 401 | # |
| 402 | # Cloud Run for Anthos: supported |
| 403 | # |
| 404 | # Must be empty before the object is deleted from the registry. Each entry |
| 405 | # is an identifier for the responsible component that will remove the entry |
| 406 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 407 | # in this list can only be removed. |
| 408 | # +patchStrategy=merge |
| 409 | "A String", |
| 410 | ], |
| 411 | "deletionTimestamp": "A String", # (Optional) |
| 412 | # |
| 413 | # Cloud Run fully managed: not supported |
| 414 | # |
| 415 | # Cloud Run for Anthos: supported |
| 416 | # |
| 417 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 418 | # deleted. This field is set by the server when a graceful deletion is |
| 419 | # requested by the user, and is not directly settable by a client. The |
| 420 | # resource is expected to be deleted (no longer visible from resource lists, |
| 421 | # and not reachable by name) after the time in this field, once the |
| 422 | # finalizers list is empty. As long as the finalizers list contains items, |
| 423 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 424 | # be unset or be set further into the future, although it may be shortened or |
| 425 | # the resource may be deleted prior to this time. For example, a user may |
| 426 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 427 | # sending a graceful termination signal to the containers in the pod. After |
| 428 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 429 | # to the container and after cleanup, remove the pod from the API. In the |
| 430 | # presence of network partitions, this object may still exist after this |
| 431 | # timestamp, until an administrator or automated process can determine the |
| 432 | # resource is fully terminated. |
| 433 | # If not set, graceful deletion of the object has not been requested. |
| 434 | # |
| 435 | # Populated by the system when a graceful deletion is requested. |
| 436 | # Read-only. |
| 437 | # More info: |
| 438 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 439 | "ownerReferences": [ # (Optional) |
| 440 | # |
| 441 | # Cloud Run fully managed: not supported |
| 442 | # |
| 443 | # Cloud Run for Anthos: supported |
| 444 | # |
| 445 | # List of objects that own this object. If ALL objects in the list have |
| 446 | # been deleted, this object will be garbage collected. |
| 447 | { # OwnerReference contains enough information to let you identify an owning |
| 448 | # object. Currently, an owning object must be in the same namespace, so there |
| 449 | # is no namespace field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 450 | "controller": True or False, # If true, this reference points to the managing controller. |
| 451 | # +optional |
| 452 | "kind": "A String", # Kind of the referent. |
| 453 | # More info: |
| 454 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 455 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 456 | # the owner cannot be deleted from the key-value store until this |
| 457 | # reference is removed. |
| 458 | # Defaults to false. |
| 459 | # To set this field, a user needs "delete" permission of the owner, |
| 460 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 461 | # +optional |
| 462 | "apiVersion": "A String", # API version of the referent. |
| 463 | "name": "A String", # Name of the referent. |
| 464 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 465 | "uid": "A String", # UID of the referent. |
| 466 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 467 | }, |
| 468 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 469 | "creationTimestamp": "A String", # (Optional) |
| 470 | # |
| 471 | # CreationTimestamp is a timestamp representing the server time when this |
| 472 | # object was created. It is not guaranteed to be set in happens-before order |
| 473 | # across separate operations. Clients may not set this value. It is |
| 474 | # represented in RFC3339 form and is in UTC. |
| 475 | # |
| 476 | # Populated by the system. |
| 477 | # Read-only. |
| 478 | # Null for lists. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 479 | # More info: |
| 480 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 481 | "labels": { # (Optional) |
| 482 | # |
| 483 | # Map of string keys and values that can be used to organize and categorize |
| 484 | # (scope and select) objects. May match selectors of replication controllers |
| 485 | # and routes. |
| 486 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 487 | "a_key": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 488 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 489 | "generation": 42, # (Optional) |
| 490 | # |
| 491 | # A sequence number representing a specific generation of the desired state. |
| 492 | # Populated by the system. Read-only. |
| 493 | "resourceVersion": "A String", # (Optional) |
| 494 | # |
| 495 | # An opaque value that represents the internal version of this object that |
| 496 | # can be used by clients to determine when objects have changed. May be used |
| 497 | # for optimistic concurrency, change detection, and the watch operation on a |
| 498 | # resource or set of resources. Clients must treat these values as opaque and |
| 499 | # passed unmodified back to the server. They may only be valid for a |
| 500 | # particular resource or set of resources. |
| 501 | # |
| 502 | # Populated by the system. |
| 503 | # Read-only. |
| 504 | # Value must be treated as opaque by clients and . |
| 505 | # More info: |
| 506 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 507 | "selfLink": "A String", # (Optional) |
| 508 | # |
| 509 | # SelfLink is a URL representing this object. |
| 510 | # Populated by the system. |
| 511 | # Read-only. |
| 512 | # string selfLink = 4; |
| 513 | "uid": "A String", # (Optional) |
| 514 | # |
| 515 | # UID is the unique in time and space value for this object. It is typically |
| 516 | # generated by the server on successful creation of a resource and is not |
| 517 | # allowed to change on PUT operations. |
| 518 | # |
| 519 | # Populated by the system. |
| 520 | # Read-only. |
| 521 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 522 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 523 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 524 | # project ID or project number. |
| 525 | }, |
| 526 | "type": "A String", # Used to facilitate programmatic handling of secret data. |
| 527 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 528 | </div> |
| 529 | |
| 530 | <div class="method"> |
| 531 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 532 | <pre>Rpc to get information about a secret. |
| 533 | |
| 534 | Args: |
| 535 | name: string, Required. The name of the secret being retrieved. If needed, replace |
| 536 | {namespace_id} with the project ID. (required) |
| 537 | x__xgafv: string, V1 error format. |
| 538 | Allowed values |
| 539 | 1 - v1 error format |
| 540 | 2 - v2 error format |
| 541 | |
| 542 | Returns: |
| 543 | An object of the form: |
| 544 | |
| 545 | { # Cloud Run fully managed: not supported |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 546 | # |
| 547 | # Cloud Run on GKE: supported |
| 548 | # |
| 549 | # Secret holds secret data of a certain type. The total bytes of the values in |
| 550 | # the Data field must be less than MaxSecretSize bytes. |
| 551 | "data": { # Data contains the secret data. Each key must consist of alphanumeric |
| 552 | # characters, '-', '_' or '.'. The serialized form of the secret data is a |
| 553 | # base64 encoded string, representing the arbitrary (possibly non-string) |
| 554 | # data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 |
| 555 | "a_key": "A String", |
| 556 | }, |
| 557 | "stringData": { # stringData allows specifying non-binary secret data in string form. |
| 558 | # It is provided as a write-only convenience method. |
| 559 | # All keys and values are merged into the data field on write, overwriting |
| 560 | # any existing values. It is never output when reading from the API. |
| 561 | # +k8s:conversion-gen=false |
| 562 | "a_key": "A String", |
| 563 | }, |
| 564 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Standard object's metadata. |
| 565 | # More info: |
| 566 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 567 | # persisted resources must have, which includes all objects users must create. |
| 568 | "annotations": { # (Optional) |
| 569 | # |
| 570 | # Annotations is an unstructured key value map stored with a resource that |
| 571 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 572 | # are not queryable and should be preserved when modifying objects. More |
| 573 | # info: http://kubernetes.io/docs/user-guide/annotations |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 574 | "a_key": "A String", |
| 575 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 576 | "generateName": "A String", # (Optional) |
| 577 | # |
| 578 | # Cloud Run fully managed: not supported |
| 579 | # |
| 580 | # Cloud Run for Anthos: supported |
| 581 | # |
| 582 | # GenerateName is an optional prefix, used by the server, to generate a |
| 583 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 584 | # used, the name returned to the client will be different than the name |
| 585 | # passed. This value will also be combined with a unique suffix. The provided |
| 586 | # value has the same validation rules as the Name field, and may be truncated |
| 587 | # by the length of the suffix required to make the value unique on the |
| 588 | # server. |
| 589 | # |
| 590 | # If this field is specified and the generated name exists, the server will |
| 591 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 592 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 593 | # time allotted, and the client should retry (optionally after the time |
| 594 | # indicated in the Retry-After header). |
| 595 | # |
| 596 | # Applied only if Name is not specified. |
| 597 | # More info: |
| 598 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 599 | # string generateName = 2; |
| 600 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 601 | # Is required when creating |
| 602 | # resources, although some resources may allow a client to request the |
| 603 | # generation of an appropriate name automatically. Name is primarily intended |
| 604 | # for creation idempotence and configuration definition. Cannot be updated. |
| 605 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 606 | # +optional |
| 607 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 608 | # |
| 609 | # Cloud Run fully managed: not supported |
| 610 | # |
| 611 | # Cloud Run for Anthos: supported |
| 612 | # |
| 613 | # Number of seconds allowed for this object to gracefully terminate before |
| 614 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 615 | # set. May only be shortened. Read-only. |
| 616 | "clusterName": "A String", # (Optional) |
| 617 | # |
| 618 | # Cloud Run fully managed: not supported |
| 619 | # |
| 620 | # Cloud Run for Anthos: supported |
| 621 | # |
| 622 | # The name of the cluster which the object belongs to. |
| 623 | # This is used to distinguish resources with same name and namespace in |
| 624 | # different clusters. This field is not set anywhere right now and apiserver |
| 625 | # is going to ignore it if set in create or update request. |
| 626 | "finalizers": [ # (Optional) |
| 627 | # |
| 628 | # Cloud Run fully managed: not supported |
| 629 | # |
| 630 | # Cloud Run for Anthos: supported |
| 631 | # |
| 632 | # Must be empty before the object is deleted from the registry. Each entry |
| 633 | # is an identifier for the responsible component that will remove the entry |
| 634 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 635 | # in this list can only be removed. |
| 636 | # +patchStrategy=merge |
| 637 | "A String", |
| 638 | ], |
| 639 | "deletionTimestamp": "A String", # (Optional) |
| 640 | # |
| 641 | # Cloud Run fully managed: not supported |
| 642 | # |
| 643 | # Cloud Run for Anthos: supported |
| 644 | # |
| 645 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 646 | # deleted. This field is set by the server when a graceful deletion is |
| 647 | # requested by the user, and is not directly settable by a client. The |
| 648 | # resource is expected to be deleted (no longer visible from resource lists, |
| 649 | # and not reachable by name) after the time in this field, once the |
| 650 | # finalizers list is empty. As long as the finalizers list contains items, |
| 651 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 652 | # be unset or be set further into the future, although it may be shortened or |
| 653 | # the resource may be deleted prior to this time. For example, a user may |
| 654 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 655 | # sending a graceful termination signal to the containers in the pod. After |
| 656 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 657 | # to the container and after cleanup, remove the pod from the API. In the |
| 658 | # presence of network partitions, this object may still exist after this |
| 659 | # timestamp, until an administrator or automated process can determine the |
| 660 | # resource is fully terminated. |
| 661 | # If not set, graceful deletion of the object has not been requested. |
| 662 | # |
| 663 | # Populated by the system when a graceful deletion is requested. |
| 664 | # Read-only. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 665 | # More info: |
| 666 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 667 | "ownerReferences": [ # (Optional) |
| 668 | # |
| 669 | # Cloud Run fully managed: not supported |
| 670 | # |
| 671 | # Cloud Run for Anthos: supported |
| 672 | # |
| 673 | # List of objects that own this object. If ALL objects in the list have |
| 674 | # been deleted, this object will be garbage collected. |
| 675 | { # OwnerReference contains enough information to let you identify an owning |
| 676 | # object. Currently, an owning object must be in the same namespace, so there |
| 677 | # is no namespace field. |
| 678 | "controller": True or False, # If true, this reference points to the managing controller. |
| 679 | # +optional |
| 680 | "kind": "A String", # Kind of the referent. |
| 681 | # More info: |
| 682 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 683 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 684 | # the owner cannot be deleted from the key-value store until this |
| 685 | # reference is removed. |
| 686 | # Defaults to false. |
| 687 | # To set this field, a user needs "delete" permission of the owner, |
| 688 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 689 | # +optional |
| 690 | "apiVersion": "A String", # API version of the referent. |
| 691 | "name": "A String", # Name of the referent. |
| 692 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 693 | "uid": "A String", # UID of the referent. |
| 694 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 695 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 696 | ], |
| 697 | "creationTimestamp": "A String", # (Optional) |
| 698 | # |
| 699 | # CreationTimestamp is a timestamp representing the server time when this |
| 700 | # object was created. It is not guaranteed to be set in happens-before order |
| 701 | # across separate operations. Clients may not set this value. It is |
| 702 | # represented in RFC3339 form and is in UTC. |
| 703 | # |
| 704 | # Populated by the system. |
| 705 | # Read-only. |
| 706 | # Null for lists. |
| 707 | # More info: |
| 708 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 709 | "labels": { # (Optional) |
| 710 | # |
| 711 | # Map of string keys and values that can be used to organize and categorize |
| 712 | # (scope and select) objects. May match selectors of replication controllers |
| 713 | # and routes. |
| 714 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 715 | "a_key": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 716 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 717 | "generation": 42, # (Optional) |
| 718 | # |
| 719 | # A sequence number representing a specific generation of the desired state. |
| 720 | # Populated by the system. Read-only. |
| 721 | "resourceVersion": "A String", # (Optional) |
| 722 | # |
| 723 | # An opaque value that represents the internal version of this object that |
| 724 | # can be used by clients to determine when objects have changed. May be used |
| 725 | # for optimistic concurrency, change detection, and the watch operation on a |
| 726 | # resource or set of resources. Clients must treat these values as opaque and |
| 727 | # passed unmodified back to the server. They may only be valid for a |
| 728 | # particular resource or set of resources. |
| 729 | # |
| 730 | # Populated by the system. |
| 731 | # Read-only. |
| 732 | # Value must be treated as opaque by clients and . |
| 733 | # More info: |
| 734 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 735 | "selfLink": "A String", # (Optional) |
| 736 | # |
| 737 | # SelfLink is a URL representing this object. |
| 738 | # Populated by the system. |
| 739 | # Read-only. |
| 740 | # string selfLink = 4; |
| 741 | "uid": "A String", # (Optional) |
| 742 | # |
| 743 | # UID is the unique in time and space value for this object. It is typically |
| 744 | # generated by the server on successful creation of a resource and is not |
| 745 | # allowed to change on PUT operations. |
| 746 | # |
| 747 | # Populated by the system. |
| 748 | # Read-only. |
| 749 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 750 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 751 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 752 | # project ID or project number. |
| 753 | }, |
| 754 | "type": "A String", # Used to facilitate programmatic handling of secret data. |
| 755 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 756 | </div> |
| 757 | |
| 758 | <div class="method"> |
| 759 | <code class="details" id="replaceSecret">replaceSecret(name, body=None, x__xgafv=None)</code> |
| 760 | <pre>Rpc to replace a secret. |
| 761 | |
| 762 | Only the spec and metadata labels and annotations are modifiable. After |
| 763 | the Update request, Cloud Run will work to make the 'status' |
| 764 | match the requested 'spec'. |
| 765 | |
| 766 | May provide metadata.resourceVersion to enforce update from last read for |
| 767 | optimistic concurrency control. |
| 768 | |
| 769 | Args: |
| 770 | name: string, Required. The name of the secret being retrieved. If needed, replace |
| 771 | {namespace_id} with the project ID. (required) |
| 772 | body: object, The request body. |
| 773 | The object takes the form of: |
| 774 | |
| 775 | { # Cloud Run fully managed: not supported |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 776 | # |
| 777 | # Cloud Run on GKE: supported |
| 778 | # |
| 779 | # Secret holds secret data of a certain type. The total bytes of the values in |
| 780 | # the Data field must be less than MaxSecretSize bytes. |
| 781 | "data": { # Data contains the secret data. Each key must consist of alphanumeric |
| 782 | # characters, '-', '_' or '.'. The serialized form of the secret data is a |
| 783 | # base64 encoded string, representing the arbitrary (possibly non-string) |
| 784 | # data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 |
| 785 | "a_key": "A String", |
| 786 | }, |
| 787 | "stringData": { # stringData allows specifying non-binary secret data in string form. |
| 788 | # It is provided as a write-only convenience method. |
| 789 | # All keys and values are merged into the data field on write, overwriting |
| 790 | # any existing values. It is never output when reading from the API. |
| 791 | # +k8s:conversion-gen=false |
| 792 | "a_key": "A String", |
| 793 | }, |
| 794 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Standard object's metadata. |
| 795 | # More info: |
| 796 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 797 | # persisted resources must have, which includes all objects users must create. |
| 798 | "annotations": { # (Optional) |
| 799 | # |
| 800 | # Annotations is an unstructured key value map stored with a resource that |
| 801 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 802 | # are not queryable and should be preserved when modifying objects. More |
| 803 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 804 | "a_key": "A String", |
| 805 | }, |
| 806 | "generateName": "A String", # (Optional) |
| 807 | # |
| 808 | # Cloud Run fully managed: not supported |
| 809 | # |
| 810 | # Cloud Run for Anthos: supported |
| 811 | # |
| 812 | # GenerateName is an optional prefix, used by the server, to generate a |
| 813 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 814 | # used, the name returned to the client will be different than the name |
| 815 | # passed. This value will also be combined with a unique suffix. The provided |
| 816 | # value has the same validation rules as the Name field, and may be truncated |
| 817 | # by the length of the suffix required to make the value unique on the |
| 818 | # server. |
| 819 | # |
| 820 | # If this field is specified and the generated name exists, the server will |
| 821 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 822 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 823 | # time allotted, and the client should retry (optionally after the time |
| 824 | # indicated in the Retry-After header). |
| 825 | # |
| 826 | # Applied only if Name is not specified. |
| 827 | # More info: |
| 828 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 829 | # string generateName = 2; |
| 830 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 831 | # Is required when creating |
| 832 | # resources, although some resources may allow a client to request the |
| 833 | # generation of an appropriate name automatically. Name is primarily intended |
| 834 | # for creation idempotence and configuration definition. Cannot be updated. |
| 835 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 836 | # +optional |
| 837 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 838 | # |
| 839 | # Cloud Run fully managed: not supported |
| 840 | # |
| 841 | # Cloud Run for Anthos: supported |
| 842 | # |
| 843 | # Number of seconds allowed for this object to gracefully terminate before |
| 844 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 845 | # set. May only be shortened. Read-only. |
| 846 | "clusterName": "A String", # (Optional) |
| 847 | # |
| 848 | # Cloud Run fully managed: not supported |
| 849 | # |
| 850 | # Cloud Run for Anthos: supported |
| 851 | # |
| 852 | # The name of the cluster which the object belongs to. |
| 853 | # This is used to distinguish resources with same name and namespace in |
| 854 | # different clusters. This field is not set anywhere right now and apiserver |
| 855 | # is going to ignore it if set in create or update request. |
| 856 | "finalizers": [ # (Optional) |
| 857 | # |
| 858 | # Cloud Run fully managed: not supported |
| 859 | # |
| 860 | # Cloud Run for Anthos: supported |
| 861 | # |
| 862 | # Must be empty before the object is deleted from the registry. Each entry |
| 863 | # is an identifier for the responsible component that will remove the entry |
| 864 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 865 | # in this list can only be removed. |
| 866 | # +patchStrategy=merge |
| 867 | "A String", |
| 868 | ], |
| 869 | "deletionTimestamp": "A String", # (Optional) |
| 870 | # |
| 871 | # Cloud Run fully managed: not supported |
| 872 | # |
| 873 | # Cloud Run for Anthos: supported |
| 874 | # |
| 875 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 876 | # deleted. This field is set by the server when a graceful deletion is |
| 877 | # requested by the user, and is not directly settable by a client. The |
| 878 | # resource is expected to be deleted (no longer visible from resource lists, |
| 879 | # and not reachable by name) after the time in this field, once the |
| 880 | # finalizers list is empty. As long as the finalizers list contains items, |
| 881 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 882 | # be unset or be set further into the future, although it may be shortened or |
| 883 | # the resource may be deleted prior to this time. For example, a user may |
| 884 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 885 | # sending a graceful termination signal to the containers in the pod. After |
| 886 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 887 | # to the container and after cleanup, remove the pod from the API. In the |
| 888 | # presence of network partitions, this object may still exist after this |
| 889 | # timestamp, until an administrator or automated process can determine the |
| 890 | # resource is fully terminated. |
| 891 | # If not set, graceful deletion of the object has not been requested. |
| 892 | # |
| 893 | # Populated by the system when a graceful deletion is requested. |
| 894 | # Read-only. |
| 895 | # More info: |
| 896 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 897 | "ownerReferences": [ # (Optional) |
| 898 | # |
| 899 | # Cloud Run fully managed: not supported |
| 900 | # |
| 901 | # Cloud Run for Anthos: supported |
| 902 | # |
| 903 | # List of objects that own this object. If ALL objects in the list have |
| 904 | # been deleted, this object will be garbage collected. |
| 905 | { # OwnerReference contains enough information to let you identify an owning |
| 906 | # object. Currently, an owning object must be in the same namespace, so there |
| 907 | # is no namespace field. |
| 908 | "controller": True or False, # If true, this reference points to the managing controller. |
| 909 | # +optional |
| 910 | "kind": "A String", # Kind of the referent. |
| 911 | # More info: |
| 912 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 913 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 914 | # the owner cannot be deleted from the key-value store until this |
| 915 | # reference is removed. |
| 916 | # Defaults to false. |
| 917 | # To set this field, a user needs "delete" permission of the owner, |
| 918 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 919 | # +optional |
| 920 | "apiVersion": "A String", # API version of the referent. |
| 921 | "name": "A String", # Name of the referent. |
| 922 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 923 | "uid": "A String", # UID of the referent. |
| 924 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 925 | }, |
| 926 | ], |
| 927 | "creationTimestamp": "A String", # (Optional) |
| 928 | # |
| 929 | # CreationTimestamp is a timestamp representing the server time when this |
| 930 | # object was created. It is not guaranteed to be set in happens-before order |
| 931 | # across separate operations. Clients may not set this value. It is |
| 932 | # represented in RFC3339 form and is in UTC. |
| 933 | # |
| 934 | # Populated by the system. |
| 935 | # Read-only. |
| 936 | # Null for lists. |
| 937 | # More info: |
| 938 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 939 | "labels": { # (Optional) |
| 940 | # |
| 941 | # Map of string keys and values that can be used to organize and categorize |
| 942 | # (scope and select) objects. May match selectors of replication controllers |
| 943 | # and routes. |
| 944 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 945 | "a_key": "A String", |
| 946 | }, |
| 947 | "generation": 42, # (Optional) |
| 948 | # |
| 949 | # A sequence number representing a specific generation of the desired state. |
| 950 | # Populated by the system. Read-only. |
| 951 | "resourceVersion": "A String", # (Optional) |
| 952 | # |
| 953 | # An opaque value that represents the internal version of this object that |
| 954 | # can be used by clients to determine when objects have changed. May be used |
| 955 | # for optimistic concurrency, change detection, and the watch operation on a |
| 956 | # resource or set of resources. Clients must treat these values as opaque and |
| 957 | # passed unmodified back to the server. They may only be valid for a |
| 958 | # particular resource or set of resources. |
| 959 | # |
| 960 | # Populated by the system. |
| 961 | # Read-only. |
| 962 | # Value must be treated as opaque by clients and . |
| 963 | # More info: |
| 964 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 965 | "selfLink": "A String", # (Optional) |
| 966 | # |
| 967 | # SelfLink is a URL representing this object. |
| 968 | # Populated by the system. |
| 969 | # Read-only. |
| 970 | # string selfLink = 4; |
| 971 | "uid": "A String", # (Optional) |
| 972 | # |
| 973 | # UID is the unique in time and space value for this object. It is typically |
| 974 | # generated by the server on successful creation of a resource and is not |
| 975 | # allowed to change on PUT operations. |
| 976 | # |
| 977 | # Populated by the system. |
| 978 | # Read-only. |
| 979 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 980 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 981 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 982 | # project ID or project number. |
| 983 | }, |
| 984 | "type": "A String", # Used to facilitate programmatic handling of secret data. |
| 985 | } |
| 986 | |
| 987 | x__xgafv: string, V1 error format. |
| 988 | Allowed values |
| 989 | 1 - v1 error format |
| 990 | 2 - v2 error format |
| 991 | |
| 992 | Returns: |
| 993 | An object of the form: |
| 994 | |
| 995 | { # Cloud Run fully managed: not supported |
| 996 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 997 | # Cloud Run on GKE: supported |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 998 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 999 | # Secret holds secret data of a certain type. The total bytes of the values in |
| 1000 | # the Data field must be less than MaxSecretSize bytes. |
| 1001 | "data": { # Data contains the secret data. Each key must consist of alphanumeric |
| 1002 | # characters, '-', '_' or '.'. The serialized form of the secret data is a |
| 1003 | # base64 encoded string, representing the arbitrary (possibly non-string) |
| 1004 | # data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 |
| 1005 | "a_key": "A String", |
| 1006 | }, |
| 1007 | "stringData": { # stringData allows specifying non-binary secret data in string form. |
| 1008 | # It is provided as a write-only convenience method. |
| 1009 | # All keys and values are merged into the data field on write, overwriting |
| 1010 | # any existing values. It is never output when reading from the API. |
| 1011 | # +k8s:conversion-gen=false |
| 1012 | "a_key": "A String", |
| 1013 | }, |
| 1014 | "metadata": { # k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all # Standard object's metadata. |
| 1015 | # More info: |
| 1016 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 1017 | # persisted resources must have, which includes all objects users must create. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1018 | "annotations": { # (Optional) |
| 1019 | # |
| 1020 | # Annotations is an unstructured key value map stored with a resource that |
| 1021 | # may be set by external tools to store and retrieve arbitrary metadata. They |
| 1022 | # are not queryable and should be preserved when modifying objects. More |
| 1023 | # info: http://kubernetes.io/docs/user-guide/annotations |
| 1024 | "a_key": "A String", |
| 1025 | }, |
| 1026 | "generateName": "A String", # (Optional) |
| 1027 | # |
| 1028 | # Cloud Run fully managed: not supported |
| 1029 | # |
| 1030 | # Cloud Run for Anthos: supported |
| 1031 | # |
| 1032 | # GenerateName is an optional prefix, used by the server, to generate a |
| 1033 | # unique name ONLY IF the Name field has not been provided. If this field is |
| 1034 | # used, the name returned to the client will be different than the name |
| 1035 | # passed. This value will also be combined with a unique suffix. The provided |
| 1036 | # value has the same validation rules as the Name field, and may be truncated |
| 1037 | # by the length of the suffix required to make the value unique on the |
| 1038 | # server. |
| 1039 | # |
| 1040 | # If this field is specified and the generated name exists, the server will |
| 1041 | # NOT return a 409 - instead, it will either return 201 Created or 500 with |
| 1042 | # Reason ServerTimeout indicating a unique name could not be found in the |
| 1043 | # time allotted, and the client should retry (optionally after the time |
| 1044 | # indicated in the Retry-After header). |
| 1045 | # |
| 1046 | # Applied only if Name is not specified. |
| 1047 | # More info: |
| 1048 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency |
| 1049 | # string generateName = 2; |
| 1050 | "name": "A String", # Name must be unique within a namespace, within a Cloud Run region. |
| 1051 | # Is required when creating |
| 1052 | # resources, although some resources may allow a client to request the |
| 1053 | # generation of an appropriate name automatically. Name is primarily intended |
| 1054 | # for creation idempotence and configuration definition. Cannot be updated. |
| 1055 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| 1056 | # +optional |
| 1057 | "deletionGracePeriodSeconds": 42, # (Optional) |
| 1058 | # |
| 1059 | # Cloud Run fully managed: not supported |
| 1060 | # |
| 1061 | # Cloud Run for Anthos: supported |
| 1062 | # |
| 1063 | # Number of seconds allowed for this object to gracefully terminate before |
| 1064 | # it will be removed from the system. Only set when deletionTimestamp is also |
| 1065 | # set. May only be shortened. Read-only. |
| 1066 | "clusterName": "A String", # (Optional) |
| 1067 | # |
| 1068 | # Cloud Run fully managed: not supported |
| 1069 | # |
| 1070 | # Cloud Run for Anthos: supported |
| 1071 | # |
| 1072 | # The name of the cluster which the object belongs to. |
| 1073 | # This is used to distinguish resources with same name and namespace in |
| 1074 | # different clusters. This field is not set anywhere right now and apiserver |
| 1075 | # is going to ignore it if set in create or update request. |
| 1076 | "finalizers": [ # (Optional) |
| 1077 | # |
| 1078 | # Cloud Run fully managed: not supported |
| 1079 | # |
| 1080 | # Cloud Run for Anthos: supported |
| 1081 | # |
| 1082 | # Must be empty before the object is deleted from the registry. Each entry |
| 1083 | # is an identifier for the responsible component that will remove the entry |
| 1084 | # from the list. If the deletionTimestamp of the object is non-nil, entries |
| 1085 | # in this list can only be removed. |
| 1086 | # +patchStrategy=merge |
| 1087 | "A String", |
| 1088 | ], |
| 1089 | "deletionTimestamp": "A String", # (Optional) |
| 1090 | # |
| 1091 | # Cloud Run fully managed: not supported |
| 1092 | # |
| 1093 | # Cloud Run for Anthos: supported |
| 1094 | # |
| 1095 | # DeletionTimestamp is RFC 3339 date and time at which this resource will be |
| 1096 | # deleted. This field is set by the server when a graceful deletion is |
| 1097 | # requested by the user, and is not directly settable by a client. The |
| 1098 | # resource is expected to be deleted (no longer visible from resource lists, |
| 1099 | # and not reachable by name) after the time in this field, once the |
| 1100 | # finalizers list is empty. As long as the finalizers list contains items, |
| 1101 | # deletion is blocked. Once the deletionTimestamp is set, this value may not |
| 1102 | # be unset or be set further into the future, although it may be shortened or |
| 1103 | # the resource may be deleted prior to this time. For example, a user may |
| 1104 | # request that a pod is deleted in 30 seconds. The Kubelet will react by |
| 1105 | # sending a graceful termination signal to the containers in the pod. After |
| 1106 | # that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) |
| 1107 | # to the container and after cleanup, remove the pod from the API. In the |
| 1108 | # presence of network partitions, this object may still exist after this |
| 1109 | # timestamp, until an administrator or automated process can determine the |
| 1110 | # resource is fully terminated. |
| 1111 | # If not set, graceful deletion of the object has not been requested. |
| 1112 | # |
| 1113 | # Populated by the system when a graceful deletion is requested. |
| 1114 | # Read-only. |
| 1115 | # More info: |
| 1116 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| 1117 | "ownerReferences": [ # (Optional) |
| 1118 | # |
| 1119 | # Cloud Run fully managed: not supported |
| 1120 | # |
| 1121 | # Cloud Run for Anthos: supported |
| 1122 | # |
| 1123 | # List of objects that own this object. If ALL objects in the list have |
| 1124 | # been deleted, this object will be garbage collected. |
| 1125 | { # OwnerReference contains enough information to let you identify an owning |
| 1126 | # object. Currently, an owning object must be in the same namespace, so there |
| 1127 | # is no namespace field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1128 | "controller": True or False, # If true, this reference points to the managing controller. |
| 1129 | # +optional |
| 1130 | "kind": "A String", # Kind of the referent. |
| 1131 | # More info: |
| 1132 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| 1133 | "blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then |
| 1134 | # the owner cannot be deleted from the key-value store until this |
| 1135 | # reference is removed. |
| 1136 | # Defaults to false. |
| 1137 | # To set this field, a user needs "delete" permission of the owner, |
| 1138 | # otherwise 422 (Unprocessable Entity) will be returned. |
| 1139 | # +optional |
| 1140 | "apiVersion": "A String", # API version of the referent. |
| 1141 | "name": "A String", # Name of the referent. |
| 1142 | # More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1143 | "uid": "A String", # UID of the referent. |
| 1144 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1145 | }, |
| 1146 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1147 | "creationTimestamp": "A String", # (Optional) |
| 1148 | # |
| 1149 | # CreationTimestamp is a timestamp representing the server time when this |
| 1150 | # object was created. It is not guaranteed to be set in happens-before order |
| 1151 | # across separate operations. Clients may not set this value. It is |
| 1152 | # represented in RFC3339 form and is in UTC. |
| 1153 | # |
| 1154 | # Populated by the system. |
| 1155 | # Read-only. |
| 1156 | # Null for lists. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1157 | # More info: |
| 1158 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1159 | "labels": { # (Optional) |
| 1160 | # |
| 1161 | # Map of string keys and values that can be used to organize and categorize |
| 1162 | # (scope and select) objects. May match selectors of replication controllers |
| 1163 | # and routes. |
| 1164 | # More info: http://kubernetes.io/docs/user-guide/labels |
| 1165 | "a_key": "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1166 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1167 | "generation": 42, # (Optional) |
| 1168 | # |
| 1169 | # A sequence number representing a specific generation of the desired state. |
| 1170 | # Populated by the system. Read-only. |
| 1171 | "resourceVersion": "A String", # (Optional) |
| 1172 | # |
| 1173 | # An opaque value that represents the internal version of this object that |
| 1174 | # can be used by clients to determine when objects have changed. May be used |
| 1175 | # for optimistic concurrency, change detection, and the watch operation on a |
| 1176 | # resource or set of resources. Clients must treat these values as opaque and |
| 1177 | # passed unmodified back to the server. They may only be valid for a |
| 1178 | # particular resource or set of resources. |
| 1179 | # |
| 1180 | # Populated by the system. |
| 1181 | # Read-only. |
| 1182 | # Value must be treated as opaque by clients and . |
| 1183 | # More info: |
| 1184 | # https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency |
| 1185 | "selfLink": "A String", # (Optional) |
| 1186 | # |
| 1187 | # SelfLink is a URL representing this object. |
| 1188 | # Populated by the system. |
| 1189 | # Read-only. |
| 1190 | # string selfLink = 4; |
| 1191 | "uid": "A String", # (Optional) |
| 1192 | # |
| 1193 | # UID is the unique in time and space value for this object. It is typically |
| 1194 | # generated by the server on successful creation of a resource and is not |
| 1195 | # allowed to change on PUT operations. |
| 1196 | # |
| 1197 | # Populated by the system. |
| 1198 | # Read-only. |
| 1199 | # More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
| 1200 | "namespace": "A String", # Namespace defines the space within each name must be unique, within a |
| 1201 | # Cloud Run region. In Cloud Run the namespace must be equal to either the |
| 1202 | # project ID or project number. |
| 1203 | }, |
| 1204 | "type": "A String", # Used to facilitate programmatic handling of secret data. |
| 1205 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1206 | </div> |
| 1207 | |
| 1208 | </body></html> |