Google Cloud Deploy V1 API - Class Google::Cloud::Deploy::V1::Target (v1.2.0)

Reference documentation and code samples for the Google Cloud Deploy V1 API class Google::Cloud::Deploy::V1::Target.

A Target resource in the Cloud Deploy API.

A Target defines a location to which a Skaffold configuration can be deployed.

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}) — Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

#annotations=

def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

#anthos_cluster

def anthos_cluster() -> ::Google::Cloud::Deploy::V1::AnthosCluster
Returns

#anthos_cluster=

def anthos_cluster=(value) -> ::Google::Cloud::Deploy::V1::AnthosCluster
Parameter
Returns

#create_time

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

#custom_target

def custom_target() -> ::Google::Cloud::Deploy::V1::CustomTarget
Returns

#custom_target=

def custom_target=(value) -> ::Google::Cloud::Deploy::V1::CustomTarget
Parameter
Returns

#deploy_parameters

def deploy_parameters() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. The deploy parameters to use for this target.

#deploy_parameters=

def deploy_parameters=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. The deploy parameters to use for this target.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. The deploy parameters to use for this target.

#description

def description() -> ::String
Returns
  • (::String) — Optional. Description of the Target. Max length is 255 characters.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. Description of the Target. Max length is 255 characters.
Returns
  • (::String) — Optional. Description of the Target. Max length is 255 characters.

#etag

def etag() -> ::String
Returns
  • (::String) — Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
Returns
  • (::String) — Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

#execution_configs

def execution_configs() -> ::Array<::Google::Cloud::Deploy::V1::ExecutionConfig>
Returns
  • (::Array<::Google::Cloud::Deploy::V1::ExecutionConfig>) — Configurations for all execution that relates to this Target. Each ExecutionEnvironmentUsage value may only be used in a single configuration; using the same value multiple times is an error. When one or more configurations are specified, they must include the RENDER and DEPLOY ExecutionEnvironmentUsage values. When no configurations are specified, execution will use the default specified in DefaultPool.

#execution_configs=

def execution_configs=(value) -> ::Array<::Google::Cloud::Deploy::V1::ExecutionConfig>
Parameter
  • value (::Array<::Google::Cloud::Deploy::V1::ExecutionConfig>) — Configurations for all execution that relates to this Target. Each ExecutionEnvironmentUsage value may only be used in a single configuration; using the same value multiple times is an error. When one or more configurations are specified, they must include the RENDER and DEPLOY ExecutionEnvironmentUsage values. When no configurations are specified, execution will use the default specified in DefaultPool.
Returns
  • (::Array<::Google::Cloud::Deploy::V1::ExecutionConfig>) — Configurations for all execution that relates to this Target. Each ExecutionEnvironmentUsage value may only be used in a single configuration; using the same value multiple times is an error. When one or more configurations are specified, they must include the RENDER and DEPLOY ExecutionEnvironmentUsage values. When no configurations are specified, execution will use the default specified in DefaultPool.

#gke

def gke() -> ::Google::Cloud::Deploy::V1::GkeCluster
Returns

#gke=

def gke=(value) -> ::Google::Cloud::Deploy::V1::GkeCluster
Parameter
Returns

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints:

    • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.
    • All characters must use UTF-8 encoding, and international characters are allowed.
    • Keys must start with a lowercase letter or international character.
    • Each resource is limited to a maximum of 64 labels.

    Both keys and values are additionally constrained to be <= 128 bytes.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints:

    • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.
    • All characters must use UTF-8 encoding, and international characters are allowed.
    • Keys must start with a lowercase letter or international character.
    • Each resource is limited to a maximum of 64 labels.

    Both keys and values are additionally constrained to be <= 128 bytes.

Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints:

    • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.
    • All characters must use UTF-8 encoding, and international characters are allowed.
    • Keys must start with a lowercase letter or international character.
    • Each resource is limited to a maximum of 64 labels.

    Both keys and values are additionally constrained to be <= 128 bytes.

#multi_target

def multi_target() -> ::Google::Cloud::Deploy::V1::MultiTarget
Returns

#multi_target=

def multi_target=(value) -> ::Google::Cloud::Deploy::V1::MultiTarget
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — Optional. Name of the Target. Format is projects/{project}/locations/{location}/targets/{target}. The target component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Optional. Name of the Target. Format is projects/{project}/locations/{location}/targets/{target}. The target component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?
Returns
  • (::String) — Optional. Name of the Target. Format is projects/{project}/locations/{location}/targets/{target}. The target component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?

#require_approval

def require_approval() -> ::Boolean
Returns
  • (::Boolean) — Optional. Whether or not the Target requires approval.

#require_approval=

def require_approval=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Whether or not the Target requires approval.
Returns
  • (::Boolean) — Optional. Whether or not the Target requires approval.

#run

def run() -> ::Google::Cloud::Deploy::V1::CloudRunLocation
Returns

#run=

def run=(value) -> ::Google::Cloud::Deploy::V1::CloudRunLocation
Parameter
Returns

#target_id

def target_id() -> ::String
Returns
  • (::String) — Output only. Resource id of the Target.

#uid

def uid() -> ::String
Returns
  • (::String) — Output only. Unique identifier of the Target.

#update_time

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