Cloud Run V2 API - Class Google::Cloud::Run::V2::Instance (v0.29.0)

Reference documentation and code samples for the Cloud Run V2 API class Google::Cloud::Run::V2::Instance.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#annotations

def annotations() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String})

#annotations=

def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String})
Returns
  • (::Google::Protobuf::Map{::String => ::String})

#binary_authorization

def binary_authorization() -> ::Google::Cloud::Run::V2::BinaryAuthorization
Returns

#binary_authorization=

def binary_authorization=(value) -> ::Google::Cloud::Run::V2::BinaryAuthorization
Parameter
Returns

#client

def client() -> ::String
Returns
  • (::String) — Arbitrary identifier for the API client.

#client=

def client=(value) -> ::String
Parameter
  • value (::String) — Arbitrary identifier for the API client.
Returns
  • (::String) — Arbitrary identifier for the API client.

#client_version

def client_version() -> ::String
Returns
  • (::String) — Arbitrary version identifier for the API client.

#client_version=

def client_version=(value) -> ::String
Parameter
  • value (::String) — Arbitrary version identifier for the API client.
Returns
  • (::String) — Arbitrary version identifier for the API client.

#conditions

def conditions() -> ::Array<::Google::Cloud::Run::V2::Condition>
Returns
  • (::Array<::Google::Cloud::Run::V2::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

def container_statuses() -> ::Array<::Google::Cloud::Run::V2::ContainerStatus>
Returns

#containers

def containers() -> ::Array<::Google::Cloud::Run::V2::Container>
Returns

#containers=

def containers=(value) -> ::Array<::Google::Cloud::Run::V2::Container>
Parameter
Returns

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#creator

def creator() -> ::String
Returns
  • (::String) — Output only. Email address of the authenticated creator.

#delete_time

def delete_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — User-provided description of the Instance. This field currently has a 512-character limit.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — User-provided description of the Instance. This field currently has a 512-character limit.
Returns
  • (::String) — User-provided description of the Instance. This field currently has a 512-character limit.

#encryption_key

def encryption_key() -> ::String
Returns
  • (::String) — 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=

def encryption_key=(value) -> ::String
Parameter
  • value (::String) — 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
Returns
  • (::String) — 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

def encryption_key_revocation_action() -> ::Google::Cloud::Run::V2::EncryptionKeyRevocationAction
Returns

#encryption_key_revocation_action=

def encryption_key_revocation_action=(value) -> ::Google::Cloud::Run::V2::EncryptionKeyRevocationAction
Parameter
Returns

#encryption_key_shutdown_duration

def encryption_key_shutdown_duration() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.

#encryption_key_shutdown_duration=

def encryption_key_shutdown_duration=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.
Returns
  • (::Google::Protobuf::Duration) — If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.

#etag

def etag() -> ::String
Returns
  • (::String) — Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
Returns
  • (::String) — Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

#expire_time

def expire_time() -> ::Google::Protobuf::Timestamp
Returns

#generation

def generation() -> ::Integer
Returns
  • (::Integer) — 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.

#gpu_zonal_redundancy_disabled

def gpu_zonal_redundancy_disabled() -> ::Boolean
Returns
  • (::Boolean) — Optional. True if GPU zonal redundancy is disabled on this instance.

#gpu_zonal_redundancy_disabled=

def gpu_zonal_redundancy_disabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. True if GPU zonal redundancy is disabled on this instance.
Returns
  • (::Boolean) — Optional. True if GPU zonal redundancy is disabled on this instance.

#iap_enabled

def iap_enabled() -> ::Boolean
Returns
  • (::Boolean) — Optional. IAP settings on the Instance.

#iap_enabled=

def iap_enabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. IAP settings on the Instance.
Returns
  • (::Boolean) — Optional. IAP settings on the Instance.

#ingress

def ingress() -> ::Google::Cloud::Run::V2::IngressTraffic
Returns
  • (::Google::Cloud::Run::V2::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.

#ingress=

def ingress=(value) -> ::Google::Cloud::Run::V2::IngressTraffic
Parameter
  • value (::Google::Cloud::Run::V2::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.
Returns
  • (::Google::Cloud::Run::V2::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

def invoker_iam_disabled() -> ::Boolean
Returns
  • (::Boolean) — 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.

#invoker_iam_disabled=

def invoker_iam_disabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String})

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String})
Returns
  • (::Google::Protobuf::Map{::String => ::String})

#last_modifier

def last_modifier() -> ::String
Returns
  • (::String) — Output only. Email address of the last authenticated modifier.

#launch_stage

def launch_stage() -> ::Google::Api::LaunchStage
Returns
  • (::Google::Api::LaunchStage) — The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features.

    For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.

#launch_stage=

def launch_stage=(value) -> ::Google::Api::LaunchStage
Parameter
  • value (::Google::Api::LaunchStage) — The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features.

    For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.

Returns
  • (::Google::Api::LaunchStage) — The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features.

    For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.

#log_uri

def log_uri() -> ::String
Returns
  • (::String) — Output only. The Google Console URI to obtain logs for the Instance.

#name

def name() -> ::String
Returns
  • (::String) — 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}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — 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}

Returns
  • (::String) — 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}

#node_selector

def node_selector() -> ::Google::Cloud::Run::V2::NodeSelector
Returns

#node_selector=

def node_selector=(value) -> ::Google::Cloud::Run::V2::NodeSelector
Parameter
Returns

#observed_generation

def observed_generation() -> ::Integer
Returns
  • (::Integer) — 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.

#reconciling

def reconciling() -> ::Boolean
Returns
  • (::Boolean) — 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.

#satisfies_pzs

def satisfies_pzs() -> ::Boolean
Returns
  • (::Boolean) — Output only. Reserved for future use.

#service_account

def service_account() -> ::String
Returns
  • (::String)

#service_account=

def service_account=(value) -> ::String
Parameter
  • value (::String)
Returns
  • (::String)

#terminal_condition

def terminal_condition() -> ::Google::Cloud::Run::V2::Condition
Returns
  • (::Google::Cloud::Run::V2::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.

#uid

def uid() -> ::String
Returns
  • (::String) — 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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns

#urls

def urls() -> ::Array<::String>
Returns
  • (::Array<::String>) — Output only. All URLs serving traffic for this Instance.

#volumes

def volumes() -> ::Array<::Google::Cloud::Run::V2::Volume>
Returns

#volumes=

def volumes=(value) -> ::Array<::Google::Cloud::Run::V2::Volume>
Parameter
Returns

#vpc_access

def vpc_access() -> ::Google::Cloud::Run::V2::VpcAccess
Returns
  • (::Google::Cloud::Run::V2::VpcAccess) — Optional. VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.

#vpc_access=

def vpc_access=(value) -> ::Google::Cloud::Run::V2::VpcAccess
Parameter
  • value (::Google::Cloud::Run::V2::VpcAccess) — Optional. VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.
Returns
  • (::Google::Cloud::Run::V2::VpcAccess) — Optional. VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.