Class Instance (0.15.0)

Instance(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A Cloud Run Instance represents a single group of containers running in a region.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name Description
name str
The fully qualified name of this Instance. In CreateInstanceRequest, this field is ignored, and instead composed from CreateInstanceRequest.parent and CreateInstanceRequest.instance_id. Format: projects/{project}/locations/{location}/instances/{instance_id}
description str
User-provided description of the Instance. This field currently has a 512-character limit.
uid str
Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
generation int
Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. The creation time.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. The last-modified time.
delete_time google.protobuf.timestamp_pb2.Timestamp
Output only. The deletion time.
expire_time google.protobuf.timestamp_pb2.Timestamp
Output only. For a deleted resource, the time after which it will be permamently deleted.
creator str
Output only. Email address of the authenticated creator.
last_modifier str
Output only. Email address of the last authenticated modifier.
client str
Arbitrary identifier for the API client.
client_version str
Arbitrary version identifier for the API client.
launch_stage google.api.launch_stage_pb2.LaunchStage
The launch stage as defined by `Google Cloud Platform Launch Stages
binary_authorization google.cloud.run_v2.types.BinaryAuthorization
Settings for the Binary Authorization feature.
vpc_access google.cloud.run_v2.types.VpcAccess
Optional. VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.
containers MutableSequence[google.cloud.run_v2.types.Container]
Required. Holds the single container that defines the unit of execution for this Instance.
volumes MutableSequence[google.cloud.run_v2.types.Volume]
A list of Volumes to make available to containers.
encryption_key str
A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
encryption_key_revocation_action google.cloud.run_v2.types.EncryptionKeyRevocationAction
The action to take if the encryption key is revoked.
encryption_key_shutdown_duration google.protobuf.duration_pb2.Duration
If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.
node_selector google.cloud.run_v2.types.NodeSelector
Optional. The node selector for the instance.
gpu_zonal_redundancy_disabled bool
Optional. True if GPU zonal redundancy is disabled on this instance. This field is a member of oneof_ _gpu_zonal_redundancy_disabled.
ingress google.cloud.run_v2.types.IngressTraffic
Optional. Provides the ingress settings for this Instance. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active.
invoker_iam_disabled bool
Optional. Disables IAM permission check for run.routes.invoke for callers of this Instance. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check.
iap_enabled bool
Optional. IAP settings on the Instance.
observed_generation int
Output only. The generation of this Instance currently serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.
log_uri str
Output only. The Google Console URI to obtain logs for the Instance.
terminal_condition google.cloud.run_v2.types.Condition
Output only. The Condition of this Instance, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.
conditions MutableSequence[google.cloud.run_v2.types.Condition]
Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Instance does not reach its Serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.
container_statuses MutableSequence[google.cloud.run_v2.types.ContainerStatus]
Output only. Status information for each of the specified containers. The status includes the resolved digest for specified images.
satisfies_pzs bool
Output only. Reserved for future use.
urls MutableSequence[str]
Output only. All URLs serving traffic for this Instance.
reconciling bool
Output only. Returns true if the Instance is currently being acted upon by the system to bring it into the desired state. When a new Instance is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Instance to the desired serving state. This process is called reconciliation. While reconciliation is in process, observed_generation will have a transient value that might mismatch the intended state. Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Instance, or there was an error, and reconciliation failed. This state can be found in terminal_condition.state.
etag str
Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

Classes

AnnotationsEntry

AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.