Interface TargetOrBuilder (1.52.0)

Version 1.52.0

• 1.53.0 (latest)
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.8
• 1.0.2

public interface TargetOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract boolean containsAnnotations(String key)

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.

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

containsAssociatedEntities(String key)

public abstract boolean containsAssociatedEntities(String key)

Optional. Map of entity IDs to their associated entities. Associated entities allows specifying places other than the deployment target for specific features. For example, the Gateway API canary can be configured to deploy the HTTPRoute to a different cluster(s) than the deployment cluster using associated entities. An entity ID must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: ^a-z?$.

map<string, .google.cloud.deploy.v1.AssociatedEntities> associated_entities = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

containsDeployParameters(String key)

public abstract boolean containsDeployParameters(String key)

Optional. The deploy parameters to use for this target.

map<string, string> deploy_parameters = 20 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

containsLabels(String key)

public abstract boolean containsLabels(String key)

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.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAnnotations() (deprecated)

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type	Description
Map<String,String>

getAnnotationsCount()

public abstract int getAnnotationsCount()

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.

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getAnnotationsMap()

public abstract Map<String,String> getAnnotationsMap()

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.

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public abstract String getAnnotationsOrDefault(String key, String defaultValue)

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.

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getAnnotationsOrThrow(String key)

public abstract String getAnnotationsOrThrow(String key)

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.

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
String

getAnthosCluster()

public abstract AnthosCluster getAnthosCluster()

Optional. Information specifying an Anthos Cluster.

.google.cloud.deploy.v1.AnthosCluster anthos_cluster = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AnthosCluster	The anthosCluster.

getAnthosClusterOrBuilder()

public abstract AnthosClusterOrBuilder getAnthosClusterOrBuilder()

Optional. Information specifying an Anthos Cluster.

.google.cloud.deploy.v1.AnthosCluster anthos_cluster = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AnthosClusterOrBuilder

getAssociatedEntities() (deprecated)

public abstract Map<String,AssociatedEntities> getAssociatedEntities()

Use #getAssociatedEntitiesMap() instead.

Returns
Type	Description
Map<String,AssociatedEntities>

getAssociatedEntitiesCount()

public abstract int getAssociatedEntitiesCount()

Optional. Map of entity IDs to their associated entities. Associated entities allows specifying places other than the deployment target for specific features. For example, the Gateway API canary can be configured to deploy the HTTPRoute to a different cluster(s) than the deployment cluster using associated entities. An entity ID must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: ^a-z?$.

map<string, .google.cloud.deploy.v1.AssociatedEntities> associated_entities = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getAssociatedEntitiesMap()

public abstract Map<String,AssociatedEntities> getAssociatedEntitiesMap()

Optional. Map of entity IDs to their associated entities. Associated entities allows specifying places other than the deployment target for specific features. For example, the Gateway API canary can be configured to deploy the HTTPRoute to a different cluster(s) than the deployment cluster using associated entities. An entity ID must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: ^a-z?$.

map<string, .google.cloud.deploy.v1.AssociatedEntities> associated_entities = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,AssociatedEntities>

getAssociatedEntitiesOrDefault(String key, AssociatedEntities defaultValue)

public abstract AssociatedEntities getAssociatedEntitiesOrDefault(String key, AssociatedEntities defaultValue)

Optional. Map of entity IDs to their associated entities. Associated entities allows specifying places other than the deployment target for specific features. For example, the Gateway API canary can be configured to deploy the HTTPRoute to a different cluster(s) than the deployment cluster using associated entities. An entity ID must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: ^a-z?$.

map<string, .google.cloud.deploy.v1.AssociatedEntities> associated_entities = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	AssociatedEntities

Returns
Type	Description
AssociatedEntities

getAssociatedEntitiesOrThrow(String key)

public abstract AssociatedEntities getAssociatedEntitiesOrThrow(String key)

Optional. Map of entity IDs to their associated entities. Associated entities allows specifying places other than the deployment target for specific features. For example, the Gateway API canary can be configured to deploy the HTTPRoute to a different cluster(s) than the deployment cluster using associated entities. An entity ID must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: ^a-z?$.

map<string, .google.cloud.deploy.v1.AssociatedEntities> associated_entities = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
AssociatedEntities

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Time at which the Target was created.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time at which the Target was created.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getCustomTarget()

public abstract CustomTarget getCustomTarget()

Optional. Information specifying a Custom Target.

.google.cloud.deploy.v1.CustomTarget custom_target = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CustomTarget	The customTarget.

getCustomTargetOrBuilder()

public abstract CustomTargetOrBuilder getCustomTargetOrBuilder()

Optional. Information specifying a Custom Target.

.google.cloud.deploy.v1.CustomTarget custom_target = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CustomTargetOrBuilder

getDeployParameters() (deprecated)

public abstract Map<String,String> getDeployParameters()

Use #getDeployParametersMap() instead.

Returns
Type	Description
Map<String,String>

getDeployParametersCount()

public abstract int getDeployParametersCount()

Optional. The deploy parameters to use for this target.

map<string, string> deploy_parameters = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getDeployParametersMap()

public abstract Map<String,String> getDeployParametersMap()

Optional. The deploy parameters to use for this target.

map<string, string> deploy_parameters = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,String>

getDeployParametersOrDefault(String key, String defaultValue)

public abstract String getDeployParametersOrDefault(String key, String defaultValue)

Optional. The deploy parameters to use for this target.

map<string, string> deploy_parameters = 20 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getDeployParametersOrThrow(String key)

public abstract String getDeployParametersOrThrow(String key)

Optional. The deploy parameters to use for this target.

map<string, string> deploy_parameters = 20 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
String

getDeploymentTargetCase()

public abstract Target.DeploymentTargetCase getDeploymentTargetCase()

Returns
Type	Description
Target.DeploymentTargetCase

getDescription()

public abstract String getDescription()

Optional. Description of the Target. Max length is 255 characters.

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. Description of the Target. Max length is 255 characters.

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for description.

getEtag()

public abstract String getEtag()

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.

string etag = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

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.

string etag = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for etag.

getExecutionConfigs(int index)

public abstract ExecutionConfig getExecutionConfigs(int index)

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.

repeated .google.cloud.deploy.v1.ExecutionConfig execution_configs = 16;

Parameter
Name	Description
index	int

Returns
Type	Description
ExecutionConfig

getExecutionConfigsCount()

public abstract int getExecutionConfigsCount()

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.

repeated .google.cloud.deploy.v1.ExecutionConfig execution_configs = 16;

Returns
Type	Description
int

getExecutionConfigsList()

public abstract List<ExecutionConfig> getExecutionConfigsList()

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.

repeated .google.cloud.deploy.v1.ExecutionConfig execution_configs = 16;

Returns
Type	Description
List<ExecutionConfig>

getExecutionConfigsOrBuilder(int index)

public abstract ExecutionConfigOrBuilder getExecutionConfigsOrBuilder(int index)

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.

repeated .google.cloud.deploy.v1.ExecutionConfig execution_configs = 16;

Parameter
Name	Description
index	int

Returns
Type	Description
ExecutionConfigOrBuilder

getExecutionConfigsOrBuilderList()

public abstract List<? extends ExecutionConfigOrBuilder> getExecutionConfigsOrBuilderList()

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.

repeated .google.cloud.deploy.v1.ExecutionConfig execution_configs = 16;

Returns
Type	Description
List<? extends com.google.cloud.deploy.v1.ExecutionConfigOrBuilder>

getGke()

public abstract GkeCluster getGke()

Optional. Information specifying a GKE Cluster.

.google.cloud.deploy.v1.GkeCluster gke = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
GkeCluster	The gke.

getGkeOrBuilder()

public abstract GkeClusterOrBuilder getGkeOrBuilder()

Optional. Information specifying a GKE Cluster.

.google.cloud.deploy.v1.GkeCluster gke = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
GkeClusterOrBuilder

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

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.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

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.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

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.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

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.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
String

getMultiTarget()

public abstract MultiTarget getMultiTarget()

Optional. Information specifying a multiTarget.

.google.cloud.deploy.v1.MultiTarget multi_target = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
MultiTarget	The multiTarget.

getMultiTargetOrBuilder()

public abstract MultiTargetOrBuilder getMultiTargetOrBuilder()

Optional. Information specifying a multiTarget.

.google.cloud.deploy.v1.MultiTarget multi_target = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
MultiTargetOrBuilder

getName()

public abstract String getName()

Optional. Name of the Target. Format is projects/{project}/locations/{location}/targets/{target}. The target component must match a-z?

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Optional. Name of the Target. Format is projects/{project}/locations/{location}/targets/{target}. The target component must match a-z?

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for name.

getRequireApproval()

public abstract boolean getRequireApproval()

Optional. Whether or not the Target requires approval.

bool require_approval = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The requireApproval.

getRun()

public abstract CloudRunLocation getRun()

Optional. Information specifying a Cloud Run deployment target.

.google.cloud.deploy.v1.CloudRunLocation run = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CloudRunLocation	The run.

getRunOrBuilder()

public abstract CloudRunLocationOrBuilder getRunOrBuilder()

Optional. Information specifying a Cloud Run deployment target.

.google.cloud.deploy.v1.CloudRunLocation run = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
CloudRunLocationOrBuilder

getTargetId()

public abstract String getTargetId()

Output only. Resource id of the Target.

string target_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The targetId.

getTargetIdBytes()

public abstract ByteString getTargetIdBytes()

Output only. Resource id of the Target.

string target_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for targetId.

getUid()

public abstract String getUid()

Output only. Unique identifier of the Target.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The uid.

getUidBytes()

public abstract ByteString getUidBytes()

Output only. Unique identifier of the Target.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for uid.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Most recent time at which the Target was updated.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Most recent time at which the Target was updated.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

hasAnthosCluster()

public abstract boolean hasAnthosCluster()

Optional. Information specifying an Anthos Cluster.

.google.cloud.deploy.v1.AnthosCluster anthos_cluster = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the anthosCluster field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Time at which the Target was created.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasCustomTarget()

public abstract boolean hasCustomTarget()

Optional. Information specifying a Custom Target.

.google.cloud.deploy.v1.CustomTarget custom_target = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the customTarget field is set.

hasGke()

public abstract boolean hasGke()

Optional. Information specifying a GKE Cluster.

.google.cloud.deploy.v1.GkeCluster gke = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the gke field is set.

hasMultiTarget()

public abstract boolean hasMultiTarget()

Optional. Information specifying a multiTarget.

.google.cloud.deploy.v1.MultiTarget multi_target = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the multiTarget field is set.

hasRun()

public abstract boolean hasRun()

Optional. Information specifying a Cloud Run deployment target.

.google.cloud.deploy.v1.CloudRunLocation run = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the run field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Most recent time at which the Target was updated.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.