Class DeploymentGroup (0.68.0)

public final class DeploymentGroup extends GeneratedMessage implements DeploymentGroupOrBuilder

A DeploymentGroup is a collection of DeploymentUnits that in a DAG-like structure.

Protobuf type google.cloud.config.v1.DeploymentGroup

Static Fields

ANNOTATIONS_FIELD_NUMBER

public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DEPLOYMENT_UNITS_FIELD_NUMBER

public static final int DEPLOYMENT_UNITS_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PROVISIONING_ERROR_FIELD_NUMBER

public static final int PROVISIONING_ERROR_FIELD_NUMBER
Field Value
Type Description
int

PROVISIONING_STATE_DESCRIPTION_FIELD_NUMBER

public static final int PROVISIONING_STATE_DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

PROVISIONING_STATE_FIELD_NUMBER

public static final int PROVISIONING_STATE_FIELD_NUMBER
Field Value
Type Description
int

STATE_DESCRIPTION_FIELD_NUMBER

public static final int STATE_DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_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 DeploymentGroup getDefaultInstance()
Returns
Type Description
DeploymentGroup

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DeploymentGroup.Builder newBuilder()
Returns
Type Description
DeploymentGroup.Builder

newBuilder(DeploymentGroup prototype)

public static DeploymentGroup.Builder newBuilder(DeploymentGroup prototype)
Parameter
Name Description
prototype DeploymentGroup
Returns
Type Description
DeploymentGroup.Builder

parseDelimitedFrom(InputStream input)

public static DeploymentGroup parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DeploymentGroup
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DeploymentGroup parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeploymentGroup
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DeploymentGroup parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DeploymentGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DeploymentGroup parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeploymentGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DeploymentGroup parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DeploymentGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DeploymentGroup parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeploymentGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DeploymentGroup parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DeploymentGroup
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DeploymentGroup parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeploymentGroup
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DeploymentGroup parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DeploymentGroup
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DeploymentGroup parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeploymentGroup
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DeploymentGroup parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DeploymentGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DeploymentGroup parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeploymentGroup
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DeploymentGroup> parser()
Returns
Type Description
Parser<DeploymentGroup>

Methods

containsAnnotations(String key)

public boolean containsAnnotations(String key)

Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployment group during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.

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

Parameter
Name Description
key String
Returns
Type Description
boolean

containsLabels(String key)

public boolean containsLabels(String key)

Optional. User-defined metadata for the deployment group.

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

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAnnotations() (deprecated)

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public int getAnnotationsCount()

Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployment group during automation. See https://google.aip.dev/148#annotations for details on 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. Arbitrary key-value metadata storage e.g. to help client tools identify deployment group during automation. See https://google.aip.dev/148#annotations for details on 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 String getAnnotationsOrDefault(String key, String defaultValue)

Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployment group during automation. See https://google.aip.dev/148#annotations for details on 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 String getAnnotationsOrThrow(String key)

Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployment group during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.

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

Parameter
Name Description
key String
Returns
Type Description
String

getCreateTime()

public Timestamp getCreateTime()

Output only. Time when the deployment group was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time when the deployment group was created.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public DeploymentGroup getDefaultInstanceForType()
Returns
Type Description
DeploymentGroup

getDeploymentUnits(int index)

public DeploymentUnit getDeploymentUnits(int index)

The deployment units of the deployment group in a DAG like structure. When a deployment group is being provisioned, the deployment units are deployed in a DAG order. The provided units must be in a DAG order, otherwise an error will be returned.

repeated .google.cloud.config.v1.DeploymentUnit deployment_units = 8;

Parameter
Name Description
index int
Returns
Type Description
DeploymentUnit

getDeploymentUnitsCount()

public int getDeploymentUnitsCount()

The deployment units of the deployment group in a DAG like structure. When a deployment group is being provisioned, the deployment units are deployed in a DAG order. The provided units must be in a DAG order, otherwise an error will be returned.

repeated .google.cloud.config.v1.DeploymentUnit deployment_units = 8;

Returns
Type Description
int

getDeploymentUnitsList()

public List<DeploymentUnit> getDeploymentUnitsList()

The deployment units of the deployment group in a DAG like structure. When a deployment group is being provisioned, the deployment units are deployed in a DAG order. The provided units must be in a DAG order, otherwise an error will be returned.

repeated .google.cloud.config.v1.DeploymentUnit deployment_units = 8;

Returns
Type Description
List<DeploymentUnit>

getDeploymentUnitsOrBuilder(int index)

public DeploymentUnitOrBuilder getDeploymentUnitsOrBuilder(int index)

The deployment units of the deployment group in a DAG like structure. When a deployment group is being provisioned, the deployment units are deployed in a DAG order. The provided units must be in a DAG order, otherwise an error will be returned.

repeated .google.cloud.config.v1.DeploymentUnit deployment_units = 8;

Parameter
Name Description
index int
Returns
Type Description
DeploymentUnitOrBuilder

getDeploymentUnitsOrBuilderList()

public List<? extends DeploymentUnitOrBuilder> getDeploymentUnitsOrBuilderList()

The deployment units of the deployment group in a DAG like structure. When a deployment group is being provisioned, the deployment units are deployed in a DAG order. The provided units must be in a DAG order, otherwise an error will be returned.

repeated .google.cloud.config.v1.DeploymentUnit deployment_units = 8;

Returns
Type Description
List<? extends com.google.cloud.config.v1.DeploymentUnitOrBuilder>

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. User-defined metadata for the deployment group.

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

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. User-defined metadata for the deployment group.

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

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. User-defined metadata for the deployment group.

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. User-defined metadata for the deployment group.

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

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

Identifier. The name of the deployment group. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The name of the deployment group. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<DeploymentGroup> getParserForType()
Returns
Type Description
Parser<DeploymentGroup>
Overrides

getProvisioningError()

public Status getProvisioningError()

Output only. The error status of the deployment group provisioning or deprovisioning.

.google.rpc.Status provisioning_error = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.Status

The provisioningError.

getProvisioningErrorOrBuilder()

public StatusOrBuilder getProvisioningErrorOrBuilder()

Output only. The error status of the deployment group provisioning or deprovisioning.

.google.rpc.Status provisioning_error = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.StatusOrBuilder

getProvisioningState()

public DeploymentGroup.ProvisioningState getProvisioningState()

Output only. The provisioning state of the deployment group.

.google.cloud.config.v1.DeploymentGroup.ProvisioningState provisioning_state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DeploymentGroup.ProvisioningState

The provisioningState.

getProvisioningStateDescription()

public String getProvisioningStateDescription()

Output only. Additional information regarding the current provisioning state.

string provisioning_state_description = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The provisioningStateDescription.

getProvisioningStateDescriptionBytes()

public ByteString getProvisioningStateDescriptionBytes()

Output only. Additional information regarding the current provisioning state.

string provisioning_state_description = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for provisioningStateDescription.

getProvisioningStateValue()

public int getProvisioningStateValue()

Output only. The provisioning state of the deployment group.

.google.cloud.config.v1.DeploymentGroup.ProvisioningState provisioning_state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for provisioningState.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public DeploymentGroup.State getState()

Output only. Current state of the deployment group.

.google.cloud.config.v1.DeploymentGroup.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DeploymentGroup.State

The state.

getStateDescription()

public String getStateDescription()

Output only. Additional information regarding the current state.

string state_description = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The stateDescription.

getStateDescriptionBytes()

public ByteString getStateDescriptionBytes()

Output only. Additional information regarding the current state.

string state_description = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for stateDescription.

getStateValue()

public int getStateValue()

Output only. Current state of the deployment group.

.google.cloud.config.v1.DeploymentGroup.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Time when the deployment group was last updated.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Time when the deployment group was last updated.

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

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Time when the deployment group was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasProvisioningError()

public boolean hasProvisioningError()

Output only. The error status of the deployment group provisioning or deprovisioning.

.google.rpc.Status provisioning_error = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the provisioningError field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Time when the deployment group was last updated.

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

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DeploymentGroup.Builder newBuilderForType()
Returns
Type Description
DeploymentGroup.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected DeploymentGroup.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DeploymentGroup.Builder
Overrides

toBuilder()

public DeploymentGroup.Builder toBuilder()
Returns
Type Description
DeploymentGroup.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException