Package k8s.io.apimachinery.pkg.apis.meta.v1

Stay organized with collections Save and categorize content based on your preferences.

Index

ListMeta

Metadata for synthetic resources like List. In Cloud Run, all List Resources Responses will have a ListMeta instead of ObjectMeta.

Fields
resource_version

string

Opaque string that identifies the server's internal version of this object. It can be used by clients to determine when objects have changed. If the message is passed back to the server, it must be left unmodified. https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

continue

string

Continuation token is a value emitted when the count of items is larger than the user/system limit. To retrieve the next page of items, pass the value of continue as the next request's page_token.

ObjectMeta

k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Fields
name

string

Required. The name of the resource.

In Cloud Run, name is required when creating top-level resources (Service, Job), must be unique within a Cloud Run project/region, and cannot be changed once created.

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

If ObjectMeta is part of a CreateServiceRequest, name must contain fewer than 50 characters.

generate_name

string

Not supported by Cloud Run

namespace

string

Required. Defines the space within each name must be unique within a Cloud Run region. In Cloud Run, it must be project ID or number.

uid

string

Unique, system-generated identifier for this resource. More info: https://kubernetes.io/docs/user-guide/identifiers#uids

resource_version

string

Opaque, system-generated value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server or omit the value to disable conflict-detection.

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

generation

int32

A system-provided sequence number representing a specific generation of the desired state.

create_time

Timestamp

UTC timestamp representing the server time when this object was created. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

labels

map<string, string>

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

annotations

map<string, string>

Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type.

  • autoscaling.knative.dev/maxScale: Revision.
  • autoscaling.knative.dev/minScale: Revision.
  • run.googleapis.com/binary-authorization-breakglass: Service, Job,
  • run.googleapis.com/binary-authorization: Service, Job, Execution.
  • run.googleapis.com/client-name: All resources.
  • run.googleapis.com/cloudsql-instances: Revision, Execution.
  • run.googleapis.com/cpu-throttling: Revision.
  • run.googleapis.com/custom-audiences: Service.
  • run.googleapis.com/description: Service.
  • run.googleapis.com/encryption-key-shutdown-hours: Revision
  • run.googleapis.com/encryption-key: Revision, Execution.
  • run.googleapis.com/execution-environment: Revision, Execution.
  • run.googleapis.com/gc-traffic-tags: Service.
  • run.googleapis.com/ingress: Service.
  • run.googleapis.com/network-interfaces: Revision, Execution.
  • run.googleapis.com/post-key-revocation-action-type: Revision.
  • run.googleapis.com/secrets: Revision, Execution.
  • run.googleapis.com/secure-session-agent: Revision.
  • run.googleapis.com/sessionAffinity: Revision.
  • run.googleapis.com/startup-cpu-boost: Revision.
  • run.googleapis.com/vpc-access-connector: Revision, Execution.
  • run.googleapis.com/vpc-access-egress: Revision, Execution. Execution.

More info: https://kubernetes.io/docs/user-guide/annotations

owner_references[]

OwnerReference

Not supported by Cloud Run

delete_time

Timestamp

The read-only soft deletion timestamp for this resource. In Cloud Run, users are not able to set this field. Instead, they must call the corresponding Delete API.

deletion_grace_period_seconds

int32

Not supported by Cloud Run

finalizers[]

string

Not supported by Cloud Run

cluster_name

string

Not supported by Cloud Run

OwnerReference

This is not supported or used by Cloud Run.

Fields
api_version

string

This is not supported or used by Cloud Run.

kind

string

This is not supported or used by Cloud Run.

name

string

This is not supported or used by Cloud Run.

uid

string

This is not supported or used by Cloud Run.

controller

bool

This is not supported or used by Cloud Run.

block_owner_deletion

bool

This is not supported or used by Cloud Run.

Status

Status is a return value for calls that don't return other objects.

Fields
metadata

ListMeta

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

status

string

Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

message

string

A human-readable description of the status of this operation.

reason

string

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

details

StatusDetails

Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

code

int32

Suggested HTTP return code for this status, 0 if not set.

StatusCause

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

Fields
reason

string

A machine-readable description of the cause of the error. If this value is empty there is no information available.

message

string

A human-readable description of the cause of the error. This field may be presented as-is to a reader.

field

string

The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors.

Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"

StatusDetails

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

Fields
name

string

The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

group

string

The group attribute of the resource associated with the status StatusReason.

kind

string

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

uid

string

UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/user-guide/identifiers#uids

causes[]

StatusCause

The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

retry_after_seconds

int32

If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.