Class Target (1.17.0)

public final class Target extends GeneratedMessageV3 implements TargetOrBuilder

A Target resource in the Google Cloud Deploy API.

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

Protobuf type google.cloud.deploy.v1.Target

Implements

TargetOrBuilder

Static Fields

ANNOTATIONS_FIELD_NUMBER

public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

ANTHOS_CLUSTER_FIELD_NUMBER

public static final int ANTHOS_CLUSTER_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
TypeDescription
int

EXECUTION_CONFIGS_FIELD_NUMBER

public static final int EXECUTION_CONFIGS_FIELD_NUMBER
Field Value
TypeDescription
int

GKE_FIELD_NUMBER

public static final int GKE_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

MULTI_TARGET_FIELD_NUMBER

public static final int MULTI_TARGET_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

REQUIRE_APPROVAL_FIELD_NUMBER

public static final int REQUIRE_APPROVAL_FIELD_NUMBER
Field Value
TypeDescription
int

RUN_FIELD_NUMBER

public static final int RUN_FIELD_NUMBER
Field Value
TypeDescription
int

TARGET_ID_FIELD_NUMBER

public static final int TARGET_ID_FIELD_NUMBER
Field Value
TypeDescription
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Target getDefaultInstance()
Returns
TypeDescription
Target

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Target.Builder newBuilder()
Returns
TypeDescription
Target.Builder

newBuilder(Target prototype)

public static Target.Builder newBuilder(Target prototype)
Parameter
NameDescription
prototypeTarget
Returns
TypeDescription
Target.Builder

parseDelimitedFrom(InputStream input)

public static Target parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Target
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Target parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Target
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Target parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Target
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Target parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Target
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Target parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Target
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Target parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Target
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Target parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Target
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Target parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Target
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Target parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Target
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Target parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Target
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Target parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Target
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Target parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Target
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Target> parser()
Returns
TypeDescription
Parser<Target>

Methods

containsAnnotations(String key)

public boolean containsAnnotations(String key)

Optional. User annotations. These attributes can only be set and used by the user, and not by Google 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
NameDescription
keyString
Returns
TypeDescription
boolean

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels are attributes that can be set and used by both the user and by Google 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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAnnotations()

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
TypeDescription
Map<String,String>

getAnnotationsCount()

public int getAnnotationsCount()

Optional. User annotations. These attributes can only be set and used by the user, and not by Google 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
TypeDescription
int

getAnnotationsMap()

public Map<String,String> getAnnotationsMap()

Optional. User annotations. These attributes can only be set and used by the user, and not by Google 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
TypeDescription
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public String getAnnotationsOrDefault(String key, String defaultValue)

Optional. User annotations. These attributes can only be set and used by the user, and not by Google 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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getAnnotationsOrThrow(String key)

public String getAnnotationsOrThrow(String key)

Optional. User annotations. These attributes can only be set and used by the user, and not by Google 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
NameDescription
keyString
Returns
TypeDescription
String

getAnthosCluster()

public AnthosCluster getAnthosCluster()

Information specifying an Anthos Cluster.

.google.cloud.deploy.v1.AnthosCluster anthos_cluster = 17;

Returns
TypeDescription
AnthosCluster

The anthosCluster.

getAnthosClusterOrBuilder()

public AnthosClusterOrBuilder getAnthosClusterOrBuilder()

Information specifying an Anthos Cluster.

.google.cloud.deploy.v1.AnthosCluster anthos_cluster = 17;

Returns
TypeDescription
AnthosClusterOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Time at which the Target was created.

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

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time at which the Target was created.

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

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Target getDefaultInstanceForType()
Returns
TypeDescription
Target

getDeploymentTargetCase()

public Target.DeploymentTargetCase getDeploymentTargetCase()
Returns
TypeDescription
Target.DeploymentTargetCase

getDescription()

public String getDescription()

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

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

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for description.

getEtag()

public 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
TypeDescription
String

The etag.

getEtagBytes()

public 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
TypeDescription
ByteString

The bytes for etag.

getExecutionConfigs(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
ExecutionConfig

getExecutionConfigsCount()

public 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
TypeDescription
int

getExecutionConfigsList()

public 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
TypeDescription
List<ExecutionConfig>

getExecutionConfigsOrBuilder(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
ExecutionConfigOrBuilder

getExecutionConfigsOrBuilderList()

public 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
TypeDescription
List<? extends com.google.cloud.deploy.v1.ExecutionConfigOrBuilder>

getGke()

public GkeCluster getGke()

Information specifying a GKE Cluster.

.google.cloud.deploy.v1.GkeCluster gke = 15;

Returns
TypeDescription
GkeCluster

The gke.

getGkeOrBuilder()

public GkeClusterOrBuilder getGkeOrBuilder()

Information specifying a GKE Cluster.

.google.cloud.deploy.v1.GkeCluster gke = 15;

Returns
TypeDescription
GkeClusterOrBuilder

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels are attributes that can be set and used by both the user and by Google 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
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels are attributes that can be set and used by both the user and by Google 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
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels are attributes that can be set and used by both the user and by Google 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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Labels are attributes that can be set and used by both the user and by Google 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
NameDescription
keyString
Returns
TypeDescription
String

getMultiTarget()

public MultiTarget getMultiTarget()

Information specifying a multiTarget.

.google.cloud.deploy.v1.MultiTarget multi_target = 19;

Returns
TypeDescription
MultiTarget

The multiTarget.

getMultiTargetOrBuilder()

public MultiTargetOrBuilder getMultiTargetOrBuilder()

Information specifying a multiTarget.

.google.cloud.deploy.v1.MultiTarget multi_target = 19;

Returns
TypeDescription
MultiTargetOrBuilder

getName()

public String getName()

Optional. Name of the Target. Format is projects/{project}/locations/{location}/targets/a-z{0,62}.

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Optional. Name of the Target. Format is projects/{project}/locations/{location}/targets/a-z{0,62}.

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

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Target> getParserForType()
Returns
TypeDescription
Parser<Target>
Overrides

getRequireApproval()

public boolean getRequireApproval()

Optional. Whether or not the Target requires approval.

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

Returns
TypeDescription
boolean

The requireApproval.

getRun()

public CloudRunLocation getRun()

Information specifying a Cloud Run deployment target.

.google.cloud.deploy.v1.CloudRunLocation run = 18;

Returns
TypeDescription
CloudRunLocation

The run.

getRunOrBuilder()

public CloudRunLocationOrBuilder getRunOrBuilder()

Information specifying a Cloud Run deployment target.

.google.cloud.deploy.v1.CloudRunLocation run = 18;

Returns
TypeDescription
CloudRunLocationOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTargetId()

public String getTargetId()

Output only. Resource id of the Target.

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

Returns
TypeDescription
String

The targetId.

getTargetIdBytes()

public ByteString getTargetIdBytes()

Output only. Resource id of the Target.

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

Returns
TypeDescription
ByteString

The bytes for targetId.

getUid()

public String getUid()

Output only. Unique identifier of the Target.

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

Returns
TypeDescription
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. Unique identifier of the Target.

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

Returns
TypeDescription
ByteString

The bytes for uid.

getUpdateTime()

public 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
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public 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
TypeDescription
TimestampOrBuilder

hasAnthosCluster()

public boolean hasAnthosCluster()

Information specifying an Anthos Cluster.

.google.cloud.deploy.v1.AnthosCluster anthos_cluster = 17;

Returns
TypeDescription
boolean

Whether the anthosCluster field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Time at which the Target was created.

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasGke()

public boolean hasGke()

Information specifying a GKE Cluster.

.google.cloud.deploy.v1.GkeCluster gke = 15;

Returns
TypeDescription
boolean

Whether the gke field is set.

hasMultiTarget()

public boolean hasMultiTarget()

Information specifying a multiTarget.

.google.cloud.deploy.v1.MultiTarget multi_target = 19;

Returns
TypeDescription
boolean

Whether the multiTarget field is set.

hasRun()

public boolean hasRun()

Information specifying a Cloud Run deployment target.

.google.cloud.deploy.v1.CloudRunLocation run = 18;

Returns
TypeDescription
boolean

Whether the run field is set.

hasUpdateTime()

public 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
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Target.Builder newBuilderForType()
Returns
TypeDescription
Target.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Target.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Target.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Target.Builder toBuilder()
Returns
TypeDescription
Target.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException