Interface DeploymentOrBuilder (0.5.0)

Version 0.5.0

• 0.30.0 (latest)
• 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 DeploymentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

User-defined metadata for the deployment.

map<string, string> labels = 4;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getArtifactsGcsBucket()

public abstract String getArtifactsGcsBucket()

Optional. User-defined location of Cloud Build logs and artifacts in Google Cloud Storage. Format: gs://{bucket}/{folder}

A default bucket will be bootstrapped if the field is not set or empty. Default bucket format: gs://<project number>-<region>-blueprint-config Constraints:

• The bucket needs to be in the same project as the deployment
• The path cannot be within the path of gcs_source
• The field cannot be updated, including changing its presence

optional string artifacts_gcs_bucket = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The artifactsGcsBucket.

getArtifactsGcsBucketBytes()

public abstract ByteString getArtifactsGcsBucketBytes()

Optional. User-defined location of Cloud Build logs and artifacts in Google Cloud Storage. Format: gs://{bucket}/{folder}

A default bucket will be bootstrapped if the field is not set or empty. Default bucket format: gs://<project number>-<region>-blueprint-config Constraints:

• The bucket needs to be in the same project as the deployment
• The path cannot be within the path of gcs_source
• The field cannot be updated, including changing its presence

optional string artifacts_gcs_bucket = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for artifactsGcsBucket.

getBlueprintCase()

public abstract Deployment.BlueprintCase getBlueprintCase()

Returns
Type	Description
Deployment.BlueprintCase

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Time when the deployment 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 was created.

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

Returns
Type	Description
TimestampOrBuilder

getDeleteBuild()

public abstract String getDeleteBuild()

Output only. Cloud Build instance UUID associated with deleting this deployment.

string delete_build = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The deleteBuild.

getDeleteBuildBytes()

public abstract ByteString getDeleteBuildBytes()

Output only. Cloud Build instance UUID associated with deleting this deployment.

string delete_build = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for deleteBuild.

getDeleteLogs()

public abstract String getDeleteLogs()

Output only. Location of Cloud Build logs in Google Cloud Storage, populated when deleting this deployment. Format: gs://{bucket}/{object}.

string delete_logs = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The deleteLogs.

getDeleteLogsBytes()

public abstract ByteString getDeleteLogsBytes()

Output only. Location of Cloud Build logs in Google Cloud Storage, populated when deleting this deployment. Format: gs://{bucket}/{object}.

string delete_logs = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for deleteLogs.

getDeleteResults()

public abstract ApplyResults getDeleteResults()

Output only. Location of artifacts from a DeleteDeployment operation.

.google.cloud.config.v1.ApplyResults delete_results = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ApplyResults	The deleteResults.

getDeleteResultsOrBuilder()

public abstract ApplyResultsOrBuilder getDeleteResultsOrBuilder()

Output only. Location of artifacts from a DeleteDeployment operation.

.google.cloud.config.v1.ApplyResults delete_results = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ApplyResultsOrBuilder

getErrorCode()

public abstract Deployment.ErrorCode getErrorCode()

Output only. Error code describing errors that may have occurred.

.google.cloud.config.v1.Deployment.ErrorCode error_code = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Deployment.ErrorCode	The errorCode.

getErrorCodeValue()

public abstract int getErrorCodeValue()

Output only. Error code describing errors that may have occurred.

.google.cloud.config.v1.Deployment.ErrorCode error_code = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for errorCode.

getErrorLogs()

public abstract String getErrorLogs()

Output only. Location of Terraform error logs in Google Cloud Storage. Format: gs://{bucket}/{object}.

string error_logs = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The errorLogs.

getErrorLogsBytes()

public abstract ByteString getErrorLogsBytes()

Output only. Location of Terraform error logs in Google Cloud Storage. Format: gs://{bucket}/{object}.

string error_logs = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for errorLogs.

getImportExistingResources()

public abstract boolean getImportExistingResources()

By default, Infra Manager will return a failure when Terraform encounters a 409 code (resource conflict error) during actuation. If this flag is set to true, Infra Manager will instead attempt to automatically import the resource into the Terraform state (for supported resource types) and continue actuation.

Not all resource types are supported, refer to documentation.

optional bool import_existing_resources = 17;

Returns
Type	Description
boolean	The importExistingResources.

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

User-defined metadata for the deployment.

map<string, string> labels = 4;

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

User-defined metadata for the deployment.

map<string, string> labels = 4;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

User-defined metadata for the deployment.

map<string, string> labels = 4;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

User-defined metadata for the deployment.

map<string, string> labels = 4;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getLatestRevision()

public abstract String getLatestRevision()

Output only. Revision name that was most recently applied. Format: projects/{project}/locations/{location}/deployments/{deployment}/ revisions/{revision}

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

Returns
Type	Description
String	The latestRevision.

getLatestRevisionBytes()

public abstract ByteString getLatestRevisionBytes()

Output only. Revision name that was most recently applied. Format: projects/{project}/locations/{location}/deployments/{deployment}/ revisions/{revision}

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

Returns
Type	Description
ByteString	The bytes for latestRevision.

getLockState()

public abstract Deployment.LockState getLockState()

Output only. Current lock state of the deployment.

.google.cloud.config.v1.Deployment.LockState lock_state = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Deployment.LockState	The lockState.

getLockStateValue()

public abstract int getLockStateValue()

Output only. Current lock state of the deployment.

.google.cloud.config.v1.Deployment.LockState lock_state = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for lockState.

getName()

public abstract String getName()

Resource name of the deployment. Format: projects/{project}/locations/{location}/deployments/{deployment}

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Resource name of the deployment. Format: projects/{project}/locations/{location}/deployments/{deployment}

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getServiceAccount()

public abstract String getServiceAccount()

Optional. User-specified Service Account (SA) credentials to be used when actuating resources. Format: projects/{projectID}/serviceAccounts/{serviceAccount}

optional string service_account = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The serviceAccount.

getServiceAccountBytes()

public abstract ByteString getServiceAccountBytes()

Optional. User-specified Service Account (SA) credentials to be used when actuating resources. Format: projects/{projectID}/serviceAccounts/{serviceAccount}

optional string service_account = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for serviceAccount.

getState()

public abstract Deployment.State getState()

Output only. Current state of the deployment.

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

Returns
Type	Description
Deployment.State	The state.

getStateDetail()

public abstract String getStateDetail()

Output only. Additional information regarding the current state.

string state_detail = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The stateDetail.

getStateDetailBytes()

public abstract ByteString getStateDetailBytes()

Output only. Additional information regarding the current state.

string state_detail = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for stateDetail.

getStateValue()

public abstract int getStateValue()

Output only. Current state of the deployment.

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

Returns
Type	Description
int	The enum numeric value on the wire for state.

getTerraformBlueprint()

public abstract TerraformBlueprint getTerraformBlueprint()

A blueprint described using Terraform's HashiCorp Configuration Language as a root module.

.google.cloud.config.v1.TerraformBlueprint terraform_blueprint = 6;

Returns
Type	Description
TerraformBlueprint	The terraformBlueprint.

getTerraformBlueprintOrBuilder()

public abstract TerraformBlueprintOrBuilder getTerraformBlueprintOrBuilder()

A blueprint described using Terraform's HashiCorp Configuration Language as a root module.

.google.cloud.config.v1.TerraformBlueprint terraform_blueprint = 6;

Returns
Type	Description
TerraformBlueprintOrBuilder

getTfErrors(int index)

public abstract TerraformError getTfErrors(int index)

Output only. Errors encountered when deleting this deployment. Errors are truncated to 10 entries, see delete_results and error_logs for full details.

repeated .google.cloud.config.v1.TerraformError tf_errors = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
TerraformError

getTfErrorsCount()

public abstract int getTfErrorsCount()

Output only. Errors encountered when deleting this deployment. Errors are truncated to 10 entries, see delete_results and error_logs for full details.

repeated .google.cloud.config.v1.TerraformError tf_errors = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getTfErrorsList()

public abstract List<TerraformError> getTfErrorsList()

Output only. Errors encountered when deleting this deployment. Errors are truncated to 10 entries, see delete_results and error_logs for full details.

repeated .google.cloud.config.v1.TerraformError tf_errors = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<TerraformError>

getTfErrorsOrBuilder(int index)

public abstract TerraformErrorOrBuilder getTfErrorsOrBuilder(int index)

Output only. Errors encountered when deleting this deployment. Errors are truncated to 10 entries, see delete_results and error_logs for full details.

repeated .google.cloud.config.v1.TerraformError tf_errors = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
TerraformErrorOrBuilder

getTfErrorsOrBuilderList()

public abstract List<? extends TerraformErrorOrBuilder> getTfErrorsOrBuilderList()

Output only. Errors encountered when deleting this deployment. Errors are truncated to 10 entries, see delete_results and error_logs for full details.

repeated .google.cloud.config.v1.TerraformError tf_errors = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Time when the deployment was last modified.

.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 was last modified.

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

Returns
Type	Description
TimestampOrBuilder

getWorkerPool()

public abstract String getWorkerPool()

Optional. The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: projects/{project}/locations/{location}/workerPools/{workerPoolId}. If this field is unspecified, the default Cloud Build worker pool will be used.

optional string worker_pool = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The workerPool.

getWorkerPoolBytes()

public abstract ByteString getWorkerPoolBytes()

Optional. The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: projects/{project}/locations/{location}/workerPools/{workerPoolId}. If this field is unspecified, the default Cloud Build worker pool will be used.

optional string worker_pool = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for workerPool.

hasArtifactsGcsBucket()

public abstract boolean hasArtifactsGcsBucket()

Optional. User-defined location of Cloud Build logs and artifacts in Google Cloud Storage. Format: gs://{bucket}/{folder}

A default bucket will be bootstrapped if the field is not set or empty. Default bucket format: gs://<project number>-<region>-blueprint-config Constraints:

• The bucket needs to be in the same project as the deployment
• The path cannot be within the path of gcs_source
• The field cannot be updated, including changing its presence

optional string artifacts_gcs_bucket = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the artifactsGcsBucket field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Time when the deployment was created.

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

Returns
Type	Description
boolean	Whether the createTime field is set.

hasDeleteResults()

public abstract boolean hasDeleteResults()

Output only. Location of artifacts from a DeleteDeployment operation.

.google.cloud.config.v1.ApplyResults delete_results = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the deleteResults field is set.

hasImportExistingResources()

public abstract boolean hasImportExistingResources()

By default, Infra Manager will return a failure when Terraform encounters a 409 code (resource conflict error) during actuation. If this flag is set to true, Infra Manager will instead attempt to automatically import the resource into the Terraform state (for supported resource types) and continue actuation.

Not all resource types are supported, refer to documentation.

optional bool import_existing_resources = 17;

Returns
Type	Description
boolean	Whether the importExistingResources field is set.

hasServiceAccount()

public abstract boolean hasServiceAccount()

Optional. User-specified Service Account (SA) credentials to be used when actuating resources. Format: projects/{projectID}/serviceAccounts/{serviceAccount}

optional string service_account = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
boolean	Whether the serviceAccount field is set.

hasTerraformBlueprint()

public abstract boolean hasTerraformBlueprint()

A blueprint described using Terraform's HashiCorp Configuration Language as a root module.

.google.cloud.config.v1.TerraformBlueprint terraform_blueprint = 6;

Returns
Type	Description
boolean	Whether the terraformBlueprint field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Time when the deployment was last modified.

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

Returns
Type	Description
boolean	Whether the updateTime field is set.

hasWorkerPool()

public abstract boolean hasWorkerPool()

Optional. The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: projects/{project}/locations/{location}/workerPools/{workerPoolId}. If this field is unspecified, the default Cloud Build worker pool will be used.

optional string worker_pool = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
boolean	Whether the workerPool field is set.