Interface PreviewOrBuilder (0.26.0) 

public interface PreviewOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Optional. User-defined labels for the preview.

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

Parameter
Name Description
key String
Returns
Type Description
boolean

getArtifactsGcsBucket()

public abstract String getArtifactsGcsBucket()

Optional. User-defined location of Cloud Build logs, artifacts, and 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 If omitted and deployment resource ref provided has artifacts_gcs_bucket defined, that artifact bucket is used.

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

Returns
Type Description
String

The artifactsGcsBucket.

getArtifactsGcsBucketBytes()

public abstract ByteString getArtifactsGcsBucketBytes()

Optional. User-defined location of Cloud Build logs, artifacts, and 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 If omitted and deployment resource ref provided has artifacts_gcs_bucket defined, that artifact bucket is used.

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

Returns
Type Description
ByteString

The bytes for artifactsGcsBucket.

getBlueprintCase()

public abstract Preview.BlueprintCase getBlueprintCase()
Returns
Type Description
Preview.BlueprintCase

getBuild()

public abstract String getBuild()

Output only. Cloud Build instance UUID associated with this preview.

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

Returns
Type Description
String

The build.

getBuildBytes()

public abstract ByteString getBuildBytes()

Output only. Cloud Build instance UUID associated with this preview.

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

Returns
Type Description
ByteString

The bytes for build.

getCreateTime()

public abstract Timestamp getCreateTime()

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

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

Returns
Type Description
TimestampOrBuilder

getDeployment()

public abstract String getDeployment()

Optional. Optional deployment reference. If specified, the preview will be performed using the provided deployment's current state and use any relevant fields from the deployment unless explicitly specified in the preview create request.

string deployment = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The deployment.

getDeploymentBytes()

public abstract ByteString getDeploymentBytes()

Optional. Optional deployment reference. If specified, the preview will be performed using the provided deployment's current state and use any relevant fields from the deployment unless explicitly specified in the preview create request.

string deployment = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for deployment.

getErrorCode()

public abstract Preview.ErrorCode getErrorCode()

Output only. Code describing any errors that may have occurred.

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

Returns
Type Description
Preview.ErrorCode

The errorCode.

getErrorCodeValue()

public abstract int getErrorCodeValue()

Output only. Code describing any errors that may have occurred.

.google.cloud.config.v1.Preview.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. Link to tf-error.ndjson file, which contains the full list of the errors encountered during a Terraform preview. 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. Link to tf-error.ndjson file, which contains the full list of the errors encountered during a Terraform preview. Format: gs://{bucket}/{object}.

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

Returns
Type Description
ByteString

The bytes for errorLogs.

getErrorStatus()

public abstract Status getErrorStatus()

Output only. Additional information regarding the current state.

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

Returns
Type Description
com.google.rpc.Status

The errorStatus.

getErrorStatusOrBuilder()

public abstract StatusOrBuilder getErrorStatusOrBuilder()

Output only. Additional information regarding the current state.

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

Returns
Type Description
com.google.rpc.StatusOrBuilder

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 labels for the preview.

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

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Optional. User-defined labels for the preview.

map<string, string> labels = 3 [(.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 labels for the preview.

map<string, string> labels = 3 [(.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 labels for the preview.

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

Parameter
Name Description
key String
Returns
Type Description
String

getLogs()

public abstract String getLogs()

Output only. Location of preview logs in gs://{bucket}/{object} format.

string logs = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The logs.

getLogsBytes()

public abstract ByteString getLogsBytes()

Output only. Location of preview logs in gs://{bucket}/{object} format.

string logs = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for logs.

getName()

public abstract String getName()

Identifier. Resource name of the preview. Resource name can be user provided or server generated ID if unspecified. Format: projects/{project}/locations/{location}/previews/{preview}

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

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. Resource name of the preview. Resource name can be user provided or server generated ID if unspecified. Format: projects/{project}/locations/{location}/previews/{preview}

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

Returns
Type Description
ByteString

The bytes for name.

getPreviewArtifacts()

public abstract PreviewArtifacts getPreviewArtifacts()

Output only. Artifacts from preview.

.google.cloud.config.v1.PreviewArtifacts preview_artifacts = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PreviewArtifacts

The previewArtifacts.

getPreviewArtifactsOrBuilder()

public abstract PreviewArtifactsOrBuilder getPreviewArtifactsOrBuilder()

Output only. Artifacts from preview.

.google.cloud.config.v1.PreviewArtifacts preview_artifacts = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PreviewArtifactsOrBuilder

getPreviewMode()

public abstract Preview.PreviewMode getPreviewMode()

Optional. Current mode of preview.

.google.cloud.config.v1.Preview.PreviewMode preview_mode = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Preview.PreviewMode

The previewMode.

getPreviewModeValue()

public abstract int getPreviewModeValue()

Optional. Current mode of preview.

.google.cloud.config.v1.Preview.PreviewMode preview_mode = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for previewMode.

getServiceAccount()

public abstract String getServiceAccount()

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

string service_account = 7 [(.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 previewing resources. Format: projects/{projectID}/serviceAccounts/{serviceAccount}

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

Returns
Type Description
ByteString

The bytes for serviceAccount.

getState()

public abstract Preview.State getState()

Output only. Current state of the preview.

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

Returns
Type Description
Preview.State

The state.

getStateValue()

public abstract int getStateValue()

Output only. Current state of the preview.

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

Returns
Type Description
int

The enum numeric value on the wire for state.

getTerraformBlueprint()

public abstract TerraformBlueprint getTerraformBlueprint()

The terraform blueprint to preview.

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

Returns
Type Description
TerraformBlueprint

The terraformBlueprint.

getTerraformBlueprintOrBuilder()

public abstract TerraformBlueprintOrBuilder getTerraformBlueprintOrBuilder()

The terraform blueprint to preview.

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

Returns
Type Description
TerraformBlueprintOrBuilder

getTfErrors(int index)

public abstract TerraformError getTfErrors(int index)

Output only. Summary of errors encountered during Terraform preview. It has a size limit of 10, i.e. only top 10 errors will be summarized here.

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. Summary of errors encountered during Terraform preview. It has a size limit of 10, i.e. only top 10 errors will be summarized here.

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. Summary of errors encountered during Terraform preview. It has a size limit of 10, i.e. only top 10 errors will be summarized here.

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. Summary of errors encountered during Terraform preview. It has a size limit of 10, i.e. only top 10 errors will be summarized here.

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. Summary of errors encountered during Terraform preview. It has a size limit of 10, i.e. only top 10 errors will be summarized here.

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>

getTfVersion()

public abstract String getTfVersion()

Output only. The current Terraform version set on the preview. It is in the format of "Major.Minor.Patch", for example, "1.3.10".

string tf_version = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The tfVersion.

getTfVersionBytes()

public abstract ByteString getTfVersionBytes()

Output only. The current Terraform version set on the preview. It is in the format of "Major.Minor.Patch", for example, "1.3.10".

string tf_version = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for tfVersion.

getTfVersionConstraint()

public abstract String getTfVersionConstraint()

Optional. The user-specified Terraform version constraint. Example: "=1.3.10".

optional string tf_version_constraint = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The tfVersionConstraint.

getTfVersionConstraintBytes()

public abstract ByteString getTfVersionConstraintBytes()

Optional. The user-specified Terraform version constraint. Example: "=1.3.10".

optional string tf_version_constraint = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for tfVersionConstraint.

getWorkerPool()

public abstract String getWorkerPool()

Optional. The user-specified 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. If omitted and deployment resource ref provided has worker_pool defined, that worker pool is used.

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

Returns
Type Description
String

The workerPool.

getWorkerPoolBytes()

public abstract ByteString getWorkerPoolBytes()

Optional. The user-specified 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. If omitted and deployment resource ref provided has worker_pool defined, that worker pool is used.

optional string worker_pool = 9 [(.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, artifacts, and 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 If omitted and deployment resource ref provided has artifacts_gcs_bucket defined, that artifact bucket is used.

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

Returns
Type Description
boolean

Whether the artifactsGcsBucket field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Time the preview was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasErrorStatus()

public abstract boolean hasErrorStatus()

Output only. Additional information regarding the current state.

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

Returns
Type Description
boolean

Whether the errorStatus field is set.

hasPreviewArtifacts()

public abstract boolean hasPreviewArtifacts()

Output only. Artifacts from preview.

.google.cloud.config.v1.PreviewArtifacts preview_artifacts = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the previewArtifacts field is set.

hasTerraformBlueprint()

public abstract boolean hasTerraformBlueprint()

The terraform blueprint to preview.

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

Returns
Type Description
boolean

Whether the terraformBlueprint field is set.

hasTfVersionConstraint()

public abstract boolean hasTfVersionConstraint()

Optional. The user-specified Terraform version constraint. Example: "=1.3.10".

optional string tf_version_constraint = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the tfVersionConstraint field is set.

hasWorkerPool()

public abstract boolean hasWorkerPool()

Optional. The user-specified 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. If omitted and deployment resource ref provided has worker_pool defined, that worker pool is used.

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

Returns
Type Description
boolean

Whether the workerPool field is set.