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
Static Fields
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
ANTHOS_CLUSTER_FIELD_NUMBER
public static final int ANTHOS_CLUSTER_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
Field Value
EXECUTION_CONFIGS_FIELD_NUMBER
public static final int EXECUTION_CONFIGS_FIELD_NUMBER
Field Value
GKE_FIELD_NUMBER
public static final int GKE_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
REQUIRE_APPROVAL_FIELD_NUMBER
public static final int REQUIRE_APPROVAL_FIELD_NUMBER
Field Value
RUN_FIELD_NUMBER
public static final int RUN_FIELD_NUMBER
Field Value
TARGET_ID_FIELD_NUMBER
public static final int TARGET_ID_FIELD_NUMBER
Field Value
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Target getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Target.Builder newBuilder()
Returns
newBuilder(Target prototype)
public static Target.Builder newBuilder(Target prototype)
Parameter
| Name | Description |
| prototype | Target
|
Returns
public static Target parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Target parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Target parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Target parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Target parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Target parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Target parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Target parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Target parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Target parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Target parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Target parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Target> parser()
Returns
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];
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];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAnnotations()
public Map<String,String> getAnnotations()
Returns
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];
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];
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];
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];
getAnthosCluster()
public AnthosCluster getAnthosCluster()
Information specifying an Anthos Cluster.
.google.cloud.deploy.v1.AnthosCluster anthos_cluster = 17;
getAnthosClusterOrBuilder()
public AnthosClusterOrBuilder getAnthosClusterOrBuilder()
Information specifying an Anthos Cluster.
.google.cloud.deploy.v1.AnthosCluster anthos_cluster = 17;
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];
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];
getDefaultInstanceForType()
public Target getDefaultInstanceForType()
Returns
getDeploymentTargetCase()
public Target.DeploymentTargetCase getDeploymentTargetCase()
Returns
getDescription()
public String getDescription()
Optional. Description of the Target. Max length is 255 characters.
string description = 4 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| 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];
| Type | Description |
| ByteString | The bytes for description.
|
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];
| Type | Description |
| 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];
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;
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;
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;
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;
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;
| Type | Description |
| List<? extends com.google.cloud.deploy.v1.ExecutionConfigOrBuilder> | |
getGke()
public GkeCluster getGke()
Information specifying a GKE Cluster.
.google.cloud.deploy.v1.GkeCluster gke = 15;
getGkeOrBuilder()
public GkeClusterOrBuilder getGkeOrBuilder()
Information specifying a GKE Cluster.
.google.cloud.deploy.v1.GkeCluster gke = 15;
getLabels()
public Map<String,String> getLabels()
Returns
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];
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];
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];
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];
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];
| Type | Description |
| 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];
getParserForType()
public Parser<Target> getParserForType()
Returns
Overrides
getRequireApproval()
public boolean getRequireApproval()
Optional. Whether or not the Target requires approval.
bool require_approval = 13 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | The requireApproval.
|
getRun()
public CloudRunLocation getRun()
Information specifying a Cloud Run deployment target.
.google.cloud.deploy.v1.CloudRunLocation run = 18;
getRunOrBuilder()
public CloudRunLocationOrBuilder getRunOrBuilder()
Information specifying a Cloud Run deployment target.
.google.cloud.deploy.v1.CloudRunLocation run = 18;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getTargetId()
public String getTargetId()
Output only. Resource id of the Target.
string target_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| String | The targetId.
|
getTargetIdBytes()
public ByteString getTargetIdBytes()
Output only. Resource id of the Target.
string target_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUid()
Output only. Unique identifier of the Target.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUidBytes()
public ByteString getUidBytes()
Output only. Unique identifier of the Target.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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];
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];
hasAnthosCluster()
public boolean hasAnthosCluster()
Information specifying an Anthos Cluster.
.google.cloud.deploy.v1.AnthosCluster anthos_cluster = 17;
| Type | Description |
| 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];
| Type | Description |
| boolean | Whether the createTime field is set.
|
hasGke()
Information specifying a GKE Cluster.
.google.cloud.deploy.v1.GkeCluster gke = 15;
| Type | Description |
| boolean | Whether the gke field is set.
|
hasRun()
Information specifying a Cloud Run deployment target.
.google.cloud.deploy.v1.CloudRunLocation run = 18;
| Type | Description |
| 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];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Target.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Target.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Target.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
