com.google.cloud.deploy.v1

Interface TargetOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Target, Target.Builder

public interface TargetOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsAnnotations(String key) Optional.
boolean	containsDeployParameters(String key) Optional.
boolean	containsLabels(String key) Optional.
Map<String,String>	getAnnotations() Deprecated.
int	getAnnotationsCount() Optional.
Map<String,String>	getAnnotationsMap() Optional.
String	getAnnotationsOrDefault(String key, String defaultValue) Optional.
String	getAnnotationsOrThrow(String key) Optional.
AnthosCluster	getAnthosCluster() Optional.
AnthosClusterOrBuilder	getAnthosClusterOrBuilder() Optional.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
CustomTarget	getCustomTarget() Optional.
CustomTargetOrBuilder	getCustomTargetOrBuilder() Optional.
Target.DeploymentTargetCase	getDeploymentTargetCase()
Map<String,String>	getDeployParameters() Deprecated.
int	getDeployParametersCount() Optional.
Map<String,String>	getDeployParametersMap() Optional.
String	getDeployParametersOrDefault(String key, String defaultValue) Optional.
String	getDeployParametersOrThrow(String key) Optional.
String	getDescription() Optional.
com.google.protobuf.ByteString	getDescriptionBytes() Optional.
String	getEtag() Optional.
com.google.protobuf.ByteString	getEtagBytes() Optional.
ExecutionConfig	getExecutionConfigs(int index) Configurations for all execution that relates to this `Target`.
int	getExecutionConfigsCount() Configurations for all execution that relates to this `Target`.
List<ExecutionConfig>	getExecutionConfigsList() Configurations for all execution that relates to this `Target`.
ExecutionConfigOrBuilder	getExecutionConfigsOrBuilder(int index) Configurations for all execution that relates to this `Target`.
List<? extends ExecutionConfigOrBuilder>	getExecutionConfigsOrBuilderList() Configurations for all execution that relates to this `Target`.
GkeCluster	getGke() Optional.
GkeClusterOrBuilder	getGkeOrBuilder() Optional.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Optional.
Map<String,String>	getLabelsMap() Optional.
String	getLabelsOrDefault(String key, String defaultValue) Optional.
String	getLabelsOrThrow(String key) Optional.
MultiTarget	getMultiTarget() Optional.
MultiTargetOrBuilder	getMultiTargetOrBuilder() Optional.
String	getName() Optional.
com.google.protobuf.ByteString	getNameBytes() Optional.
boolean	getRequireApproval() Optional.
CloudRunLocation	getRun() Optional.
CloudRunLocationOrBuilder	getRunOrBuilder() Optional.
String	getTargetId() Output only.
com.google.protobuf.ByteString	getTargetIdBytes() Output only.
String	getUid() Output only.
com.google.protobuf.ByteString	getUidBytes() Output only.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasAnthosCluster() Optional.
boolean	hasCreateTime() Output only.
boolean	hasCustomTarget() Optional.
boolean	hasGke() Optional.
boolean	hasMultiTarget() Optional.
boolean	hasRun() Optional.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Optional. Name of the `Target`. Format is
 `projects/{project}/locations/{location}/targets/[a-z][a-z0-9\-]{0,62}`.
 

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

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Optional. Name of the `Target`. Format is
 `projects/{project}/locations/{location}/targets/[a-z][a-z0-9\-]{0,62}`.
 

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

Returns:

The bytes for name.

getTargetId

String getTargetId()

 Output only. Resource id of the `Target`.
 

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

Returns:

The targetId.

getTargetIdBytes

com.google.protobuf.ByteString getTargetIdBytes()

 Output only. Resource id of the `Target`.
 

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

Returns:

The bytes for targetId.

getUid

String getUid()

 Output only. Unique identifier of the `Target`.
 

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

Returns:

The uid.

getUidBytes

com.google.protobuf.ByteString getUidBytes()

 Output only. Unique identifier of the `Target`.
 

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

Returns:

The bytes for uid.

getDescription

String getDescription()

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

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

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

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

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

Returns:

The bytes for description.

getAnnotationsCount

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];

containsAnnotations

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];

getAnnotations

@Deprecated
Map<String,String> getAnnotations()

Deprecated.

Use getAnnotationsMap() instead.

getAnnotationsMap

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];

getAnnotationsOrDefault

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];

getAnnotationsOrThrow

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];

getLabelsCount

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];

containsLabels

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];

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

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];

getLabelsOrDefault

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];

getLabelsOrThrow

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];

getRequireApproval

boolean getRequireApproval()

 Optional. Whether or not the `Target` requires approval.
 

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

Returns:

The requireApproval.

hasCreateTime

boolean hasCreateTime()

 Output only. Time at which the `Target` was created.
 

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

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. Time at which the `Target` was created.
 

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

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Time at which the `Target` was created.
 

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

hasUpdateTime

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:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.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:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.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];

hasGke

boolean hasGke()

 Optional. Information specifying a GKE Cluster.
 

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

Returns:

Whether the gke field is set.

getGke

GkeCluster getGke()

 Optional. Information specifying a GKE Cluster.
 

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

Returns:

The gke.

getGkeOrBuilder

GkeClusterOrBuilder getGkeOrBuilder()

 Optional. Information specifying a GKE Cluster.
 

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

hasAnthosCluster

boolean hasAnthosCluster()

 Optional. Information specifying an Anthos Cluster.
 

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

Returns:

Whether the anthosCluster field is set.

getAnthosCluster

AnthosCluster getAnthosCluster()

 Optional. Information specifying an Anthos Cluster.
 

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

Returns:

The anthosCluster.

getAnthosClusterOrBuilder

AnthosClusterOrBuilder getAnthosClusterOrBuilder()

 Optional. Information specifying an Anthos Cluster.
 

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

hasRun

boolean hasRun()

 Optional. Information specifying a Cloud Run deployment target.
 

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

Returns:

Whether the run field is set.

getRun

CloudRunLocation getRun()

 Optional. Information specifying a Cloud Run deployment target.
 

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

Returns:

The run.

getRunOrBuilder

CloudRunLocationOrBuilder getRunOrBuilder()

 Optional. Information specifying a Cloud Run deployment target.
 

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

hasMultiTarget

boolean hasMultiTarget()

 Optional. Information specifying a multiTarget.
 

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

Returns:

Whether the multiTarget field is set.

getMultiTarget

MultiTarget getMultiTarget()

 Optional. Information specifying a multiTarget.
 

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

Returns:

The multiTarget.

getMultiTargetOrBuilder

MultiTargetOrBuilder getMultiTargetOrBuilder()

 Optional. Information specifying a multiTarget.
 

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

hasCustomTarget

boolean hasCustomTarget()

 Optional. Information specifying a Custom Target.
 

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

Returns:

Whether the customTarget field is set.

getCustomTarget

CustomTarget getCustomTarget()

 Optional. Information specifying a Custom Target.
 

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

Returns:

The customTarget.

getCustomTargetOrBuilder

CustomTargetOrBuilder getCustomTargetOrBuilder()

 Optional. Information specifying a Custom Target.
 

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

getEtag

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:

The etag.

getEtagBytes

com.google.protobuf.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:

The bytes for etag.

getExecutionConfigsList

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;

getExecutionConfigs

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;

getExecutionConfigsCount

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;

getExecutionConfigsOrBuilderList

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;

getExecutionConfigsOrBuilder

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;

getDeployParametersCount

int getDeployParametersCount()

 Optional. The deploy parameters to use for this target.
 

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

containsDeployParameters

boolean containsDeployParameters(String key)

 Optional. The deploy parameters to use for this target.
 

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

getDeployParameters

@Deprecated
Map<String,String> getDeployParameters()

Deprecated.

Use getDeployParametersMap() instead.

getDeployParametersMap

Map<String,String> getDeployParametersMap()

 Optional. The deploy parameters to use for this target.
 

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

getDeployParametersOrDefault

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];

getDeployParametersOrThrow

String getDeployParametersOrThrow(String key)

 Optional. The deploy parameters to use for this target.
 

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

getDeploymentTargetCase

Target.DeploymentTargetCase getDeploymentTargetCase()