Interface DeploymentGroupOrBuilder (0.68.0)

0.68.0 (latest) 0.65.0 0.64.0 0.62.0 0.60.0 0.59.0 0.58.0 0.57.0 0.55.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.47.0 0.45.0 0.44.0 0.41.0 0.40.0 0.39.0 0.37.0 0.36.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.26.0 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.1.0

public interface DeploymentGroupOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract 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 abstract 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

getAnnotations() (deprecated)

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type	Description
Map<String,String>

getAnnotationsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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

getDeploymentUnits(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getProvisioningError()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getState()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.