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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ANTHOS_CLUSTER_FIELD_NUMBER
public static final int ANTHOS_CLUSTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DEPLOY_PARAMETERS_FIELD_NUMBER
public static final int DEPLOY_PARAMETERS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
EXECUTION_CONFIGS_FIELD_NUMBER
public static final int EXECUTION_CONFIGS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
GKE_FIELD_NUMBER
public static final int GKE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MULTI_TARGET_FIELD_NUMBER
public static final int MULTI_TARGET_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
REQUIRE_APPROVAL_FIELD_NUMBER
public static final int REQUIRE_APPROVAL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RUN_FIELD_NUMBER
public static final int RUN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TARGET_ID_FIELD_NUMBER
public static final int TARGET_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Target getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Target.Builder newBuilder()
newBuilder(Target prototype)
public static Target.Builder newBuilder(Target prototype)
| Parameter |
|---|
| Name | Description |
prototype | Target
|
public static Target parseDelimitedFrom(InputStream input)
public static Target parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Target parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Target parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Target parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Target parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Target parseFrom(CodedInputStream input)
public static Target parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Target parseFrom(InputStream input)
public static Target parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Target parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Target parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Target> parser()
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 |
|---|
| Name | Description |
key | String
|
containsDeployParameters(String key)
public 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
|
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:
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAnnotations()
public Map<String,String> getAnnotations()
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 |
|---|
| Type | Description |
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];
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];
| Parameter |
|---|
| Name | Description |
key | String
|
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];
| Returns |
|---|
| Type | Description |
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];
getDefaultInstanceForType()
public Target getDefaultInstanceForType()
getDeployParameters()
public Map<String,String> getDeployParameters()
getDeployParametersCount()
public 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 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 key, String defaultValue)
public 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 key)
public 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
|
getDeploymentTargetCase()
public Target.DeploymentTargetCase getDeploymentTargetCase()
getDescription()
public 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 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()
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 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 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
|
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 |
|---|
| Type | Description |
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;
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 |
|---|
| Name | Description |
index | int
|
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 |
|---|
| 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()
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:
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
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:
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:
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:
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
key | String
|
getMultiTarget()
public MultiTarget getMultiTarget()
Information specifying a multiTarget.
.google.cloud.deploy.v1.MultiTarget multi_target = 19;
getMultiTargetOrBuilder()
public MultiTargetOrBuilder getMultiTargetOrBuilder()
Information specifying a multiTarget.
.google.cloud.deploy.v1.MultiTarget multi_target = 19;
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 |
|---|
| 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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<Target> getParserForType()
Overrides
getRequireApproval()
public 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 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 |
|---|
| Type | Description |
int | |
Overrides
getTargetId()
public 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 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()
Output only. Unique identifier of the Target.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The uid.
|
getUidBytes()
public 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 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 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;
| Returns |
|---|
| 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];
| Returns |
|---|
| Type | Description |
boolean | Whether the createTime field is set.
|
hasGke()
Information specifying a GKE Cluster.
.google.cloud.deploy.v1.GkeCluster gke = 15;
| Returns |
|---|
| Type | Description |
boolean | Whether the gke field is set.
|
hasMultiTarget()
public boolean hasMultiTarget()
Information specifying a multiTarget.
.google.cloud.deploy.v1.MultiTarget multi_target = 19;
| Returns |
|---|
| Type | Description |
boolean | Whether the multiTarget field is set.
|
hasRun()
Information specifying a Cloud Run deployment target.
.google.cloud.deploy.v1.CloudRunLocation run = 18;
| Returns |
|---|
| 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];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Target.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Target.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Target.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
