Class Preview.Builder (0.17.0)

public static final class Preview.Builder extends GeneratedMessageV3.Builder<Preview.Builder> implements PreviewOrBuilder

A preview represents a set of actions Infra Manager would perform to move the resources towards the desired state as specified in the configuration.

Protobuf type google.cloud.config.v1.Preview

Implements

PreviewOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllTfErrors(Iterable<? extends TerraformError> values)

public Preview.Builder addAllTfErrors(Iterable<? extends TerraformError> values)

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
NameDescription
valuesIterable<? extends com.google.cloud.config.v1.TerraformError>
Returns
TypeDescription
Preview.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Preview.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Preview.Builder
Overrides

addTfErrors(TerraformError value)

public Preview.Builder addTfErrors(TerraformError value)

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
NameDescription
valueTerraformError
Returns
TypeDescription
Preview.Builder

addTfErrors(TerraformError.Builder builderForValue)

public Preview.Builder addTfErrors(TerraformError.Builder builderForValue)

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
NameDescription
builderForValueTerraformError.Builder
Returns
TypeDescription
Preview.Builder

addTfErrors(int index, TerraformError value)

public Preview.Builder addTfErrors(int index, TerraformError value)

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];

Parameters
NameDescription
indexint
valueTerraformError
Returns
TypeDescription
Preview.Builder

addTfErrors(int index, TerraformError.Builder builderForValue)

public Preview.Builder addTfErrors(int index, TerraformError.Builder builderForValue)

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];

Parameters
NameDescription
indexint
builderForValueTerraformError.Builder
Returns
TypeDescription
Preview.Builder

addTfErrorsBuilder()

public TerraformError.Builder addTfErrorsBuilder()

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
TypeDescription
TerraformError.Builder

addTfErrorsBuilder(int index)

public TerraformError.Builder addTfErrorsBuilder(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
NameDescription
indexint
Returns
TypeDescription
TerraformError.Builder

build()

public Preview build()
Returns
TypeDescription
Preview

buildPartial()

public Preview buildPartial()
Returns
TypeDescription
Preview

clear()

public Preview.Builder clear()
Returns
TypeDescription
Preview.Builder
Overrides

clearArtifactsGcsBucket()

public Preview.Builder clearArtifactsGcsBucket()

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
TypeDescription
Preview.Builder

This builder for chaining.

clearBlueprint()

public Preview.Builder clearBlueprint()
Returns
TypeDescription
Preview.Builder

clearBuild()

public Preview.Builder clearBuild()

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

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

Returns
TypeDescription
Preview.Builder

This builder for chaining.

clearCreateTime()

public Preview.Builder clearCreateTime()

Output only. Time the preview was created.

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

Returns
TypeDescription
Preview.Builder

clearDeployment()

public Preview.Builder clearDeployment()

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
TypeDescription
Preview.Builder

This builder for chaining.

clearErrorCode()

public Preview.Builder clearErrorCode()

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
TypeDescription
Preview.Builder

This builder for chaining.

clearErrorLogs()

public Preview.Builder clearErrorLogs()

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
TypeDescription
Preview.Builder

This builder for chaining.

clearErrorStatus()

public Preview.Builder clearErrorStatus()

Output only. Additional information regarding the current state.

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

Returns
TypeDescription
Preview.Builder

clearField(Descriptors.FieldDescriptor field)

public Preview.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Preview.Builder
Overrides

clearLabels()

public Preview.Builder clearLabels()
Returns
TypeDescription
Preview.Builder

clearLogs()

public Preview.Builder clearLogs()

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

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

Returns
TypeDescription
Preview.Builder

This builder for chaining.

clearName()

public Preview.Builder clearName()

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
TypeDescription
Preview.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Preview.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Preview.Builder
Overrides

clearPreviewArtifacts()

public Preview.Builder clearPreviewArtifacts()

Output only. Artifacts from preview.

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

Returns
TypeDescription
Preview.Builder

clearPreviewMode()

public Preview.Builder clearPreviewMode()

Optional. Current mode of preview.

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

Returns
TypeDescription
Preview.Builder

This builder for chaining.

clearServiceAccount()

public Preview.Builder clearServiceAccount()

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
TypeDescription
Preview.Builder

This builder for chaining.

clearState()

public Preview.Builder clearState()

Output only. Current state of the preview.

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

Returns
TypeDescription
Preview.Builder

This builder for chaining.

clearTerraformBlueprint()

public Preview.Builder clearTerraformBlueprint()

The terraform blueprint to preview.

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

Returns
TypeDescription
Preview.Builder

clearTfErrors()

public Preview.Builder clearTfErrors()

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
TypeDescription
Preview.Builder

clearWorkerPool()

public Preview.Builder clearWorkerPool()

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
TypeDescription
Preview.Builder

This builder for chaining.

clone()

public Preview.Builder clone()
Returns
TypeDescription
Preview.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

Optional. User-defined labels for the preview.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getArtifactsGcsBucket()

public 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
TypeDescription
String

The artifactsGcsBucket.

getArtifactsGcsBucketBytes()

public 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
TypeDescription
ByteString

The bytes for artifactsGcsBucket.

getBlueprintCase()

public Preview.BlueprintCase getBlueprintCase()
Returns
TypeDescription
Preview.BlueprintCase

getBuild()

public String getBuild()

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

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

Returns
TypeDescription
String

The build.

getBuildBytes()

public ByteString getBuildBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for build.

getCreateTime()

public Timestamp getCreateTime()

Output only. Time the preview was created.

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

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Time the preview was created.

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

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time the preview was created.

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

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Preview getDefaultInstanceForType()
Returns
TypeDescription
Preview

getDeployment()

public 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
TypeDescription
String

The deployment.

getDeploymentBytes()

public 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
TypeDescription
ByteString

The bytes for deployment.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getErrorCode()

public 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
TypeDescription
Preview.ErrorCode

The errorCode.

getErrorCodeValue()

public 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
TypeDescription
int

The enum numeric value on the wire for errorCode.

getErrorLogs()

public 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
TypeDescription
String

The errorLogs.

getErrorLogsBytes()

public 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
TypeDescription
ByteString

The bytes for errorLogs.

getErrorStatus()

public Status getErrorStatus()

Output only. Additional information regarding the current state.

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

Returns
TypeDescription
com.google.rpc.Status

The errorStatus.

getErrorStatusBuilder()

public Status.Builder getErrorStatusBuilder()

Output only. Additional information regarding the current state.

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

Returns
TypeDescription
com.google.rpc.Status.Builder

getErrorStatusOrBuilder()

public StatusOrBuilder getErrorStatusOrBuilder()

Output only. Additional information regarding the current state.

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

Returns
TypeDescription
com.google.rpc.StatusOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. User-defined labels for the preview.

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

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. User-defined labels for the preview.

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

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. User-defined labels for the preview.

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

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. User-defined labels for the preview.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getLogs()

public String getLogs()

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

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

Returns
TypeDescription
String

The logs.

getLogsBytes()

public ByteString getLogsBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for logs.

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getName()

public 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
TypeDescription
String

The name.

getNameBytes()

public 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
TypeDescription
ByteString

The bytes for name.

getPreviewArtifacts()

public PreviewArtifacts getPreviewArtifacts()

Output only. Artifacts from preview.

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

Returns
TypeDescription
PreviewArtifacts

The previewArtifacts.

getPreviewArtifactsBuilder()

public PreviewArtifacts.Builder getPreviewArtifactsBuilder()

Output only. Artifacts from preview.

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

Returns
TypeDescription
PreviewArtifacts.Builder

getPreviewArtifactsOrBuilder()

public PreviewArtifactsOrBuilder getPreviewArtifactsOrBuilder()

Output only. Artifacts from preview.

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

Returns
TypeDescription
PreviewArtifactsOrBuilder

getPreviewMode()

public Preview.PreviewMode getPreviewMode()

Optional. Current mode of preview.

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

Returns
TypeDescription
Preview.PreviewMode

The previewMode.

getPreviewModeValue()

public int getPreviewModeValue()

Optional. Current mode of preview.

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

Returns
TypeDescription
int

The enum numeric value on the wire for previewMode.

getServiceAccount()

public 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
TypeDescription
String

The serviceAccount.

getServiceAccountBytes()

public 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
TypeDescription
ByteString

The bytes for serviceAccount.

getState()

public 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
TypeDescription
Preview.State

The state.

getStateValue()

public int getStateValue()

Output only. Current state of the preview.

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

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getTerraformBlueprint()

public TerraformBlueprint getTerraformBlueprint()

The terraform blueprint to preview.

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

Returns
TypeDescription
TerraformBlueprint

The terraformBlueprint.

getTerraformBlueprintBuilder()

public TerraformBlueprint.Builder getTerraformBlueprintBuilder()

The terraform blueprint to preview.

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

Returns
TypeDescription
TerraformBlueprint.Builder

getTerraformBlueprintOrBuilder()

public TerraformBlueprintOrBuilder getTerraformBlueprintOrBuilder()

The terraform blueprint to preview.

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

Returns
TypeDescription
TerraformBlueprintOrBuilder

getTfErrors(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
TerraformError

getTfErrorsBuilder(int index)

public TerraformError.Builder getTfErrorsBuilder(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
NameDescription
indexint
Returns
TypeDescription
TerraformError.Builder

getTfErrorsBuilderList()

public List<TerraformError.Builder> getTfErrorsBuilderList()

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
TypeDescription
List<Builder>

getTfErrorsCount()

public 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
TypeDescription
int

getTfErrorsList()

public 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
TypeDescription
List<TerraformError>

getTfErrorsOrBuilder(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
TerraformErrorOrBuilder

getTfErrorsOrBuilderList()

public 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
TypeDescription
List<? extends com.google.cloud.config.v1.TerraformErrorOrBuilder>

getWorkerPool()

public 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
TypeDescription
String

The workerPool.

getWorkerPoolBytes()

public 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
TypeDescription
ByteString

The bytes for workerPool.

hasArtifactsGcsBucket()

public 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
TypeDescription
boolean

Whether the artifactsGcsBucket field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Time the preview was created.

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasErrorStatus()

public boolean hasErrorStatus()

Output only. Additional information regarding the current state.

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

Returns
TypeDescription
boolean

Whether the errorStatus field is set.

hasPreviewArtifacts()

public boolean hasPreviewArtifacts()

Output only. Artifacts from preview.

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

Returns
TypeDescription
boolean

Whether the previewArtifacts field is set.

hasTerraformBlueprint()

public boolean hasTerraformBlueprint()

The terraform blueprint to preview.

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

Returns
TypeDescription
boolean

Whether the terraformBlueprint field is set.

hasWorkerPool()

public 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
TypeDescription
boolean

Whether the workerPool field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCreateTime(Timestamp value)

public Preview.Builder mergeCreateTime(Timestamp value)

Output only. Time the preview was created.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Preview.Builder

mergeErrorStatus(Status value)

public Preview.Builder mergeErrorStatus(Status value)

Output only. Additional information regarding the current state.

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

Parameter
NameDescription
valuecom.google.rpc.Status
Returns
TypeDescription
Preview.Builder

mergeFrom(Preview other)

public Preview.Builder mergeFrom(Preview other)
Parameter
NameDescription
otherPreview
Returns
TypeDescription
Preview.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Preview.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Preview.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Preview.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Preview.Builder
Overrides

mergePreviewArtifacts(PreviewArtifacts value)

public Preview.Builder mergePreviewArtifacts(PreviewArtifacts value)

Output only. Artifacts from preview.

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

Parameter
NameDescription
valuePreviewArtifacts
Returns
TypeDescription
Preview.Builder

mergeTerraformBlueprint(TerraformBlueprint value)

public Preview.Builder mergeTerraformBlueprint(TerraformBlueprint value)

The terraform blueprint to preview.

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

Parameter
NameDescription
valueTerraformBlueprint
Returns
TypeDescription
Preview.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Preview.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Preview.Builder
Overrides

putAllLabels(Map<String,String> values)

public Preview.Builder putAllLabels(Map<String,String> values)

Optional. User-defined labels for the preview.

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

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
Preview.Builder

putLabels(String key, String value)

public Preview.Builder putLabels(String key, String value)

Optional. User-defined labels for the preview.

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

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
Preview.Builder

removeLabels(String key)

public Preview.Builder removeLabels(String key)

Optional. User-defined labels for the preview.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
Preview.Builder

removeTfErrors(int index)

public Preview.Builder removeTfErrors(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
NameDescription
indexint
Returns
TypeDescription
Preview.Builder

setArtifactsGcsBucket(String value)

public Preview.Builder setArtifactsGcsBucket(String value)

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];

Parameter
NameDescription
valueString

The artifactsGcsBucket to set.

Returns
TypeDescription
Preview.Builder

This builder for chaining.

setArtifactsGcsBucketBytes(ByteString value)

public Preview.Builder setArtifactsGcsBucketBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for artifactsGcsBucket to set.

Returns
TypeDescription
Preview.Builder

This builder for chaining.

setBuild(String value)

public Preview.Builder setBuild(String value)

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

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

Parameter
NameDescription
valueString

The build to set.

Returns
TypeDescription
Preview.Builder

This builder for chaining.

setBuildBytes(ByteString value)

public Preview.Builder setBuildBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for build to set.

Returns
TypeDescription
Preview.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public Preview.Builder setCreateTime(Timestamp value)

Output only. Time the preview was created.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Preview.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Preview.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Time the preview was created.

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Preview.Builder

setDeployment(String value)

public Preview.Builder setDeployment(String value)

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) = { ... }

Parameter
NameDescription
valueString

The deployment to set.

Returns
TypeDescription
Preview.Builder

This builder for chaining.

setDeploymentBytes(ByteString value)

public Preview.Builder setDeploymentBytes(ByteString value)

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) = { ... }

Parameter
NameDescription
valueByteString

The bytes for deployment to set.

Returns
TypeDescription
Preview.Builder

This builder for chaining.

setErrorCode(Preview.ErrorCode value)

public Preview.Builder setErrorCode(Preview.ErrorCode value)

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];

Parameter
NameDescription
valuePreview.ErrorCode

The errorCode to set.

Returns
TypeDescription
Preview.Builder

This builder for chaining.

setErrorCodeValue(int value)

public Preview.Builder setErrorCodeValue(int value)

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];

Parameter
NameDescription
valueint

The enum numeric value on the wire for errorCode to set.

Returns
TypeDescription
Preview.Builder

This builder for chaining.

setErrorLogs(String value)

public Preview.Builder setErrorLogs(String value)

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];

Parameter
NameDescription
valueString

The errorLogs to set.

Returns
TypeDescription
Preview.Builder

This builder for chaining.

setErrorLogsBytes(ByteString value)

public Preview.Builder setErrorLogsBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for errorLogs to set.

Returns
TypeDescription
Preview.Builder

This builder for chaining.

setErrorStatus(Status value)

public Preview.Builder setErrorStatus(Status value)

Output only. Additional information regarding the current state.

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

Parameter
NameDescription
valuecom.google.rpc.Status
Returns
TypeDescription
Preview.Builder

setErrorStatus(Status.Builder builderForValue)

public Preview.Builder setErrorStatus(Status.Builder builderForValue)

Output only. Additional information regarding the current state.

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

Parameter
NameDescription
builderForValuecom.google.rpc.Status.Builder
Returns
TypeDescription
Preview.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Preview.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Preview.Builder
Overrides

setLogs(String value)

public Preview.Builder setLogs(String value)

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

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

Parameter
NameDescription
valueString

The logs to set.

Returns
TypeDescription
Preview.Builder

This builder for chaining.

setLogsBytes(ByteString value)

public Preview.Builder setLogsBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for logs to set.

Returns
TypeDescription
Preview.Builder

This builder for chaining.

setName(String value)

public Preview.Builder setName(String value)

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];

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Preview.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Preview.Builder setNameBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Preview.Builder

This builder for chaining.

setPreviewArtifacts(PreviewArtifacts value)

public Preview.Builder setPreviewArtifacts(PreviewArtifacts value)

Output only. Artifacts from preview.

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

Parameter
NameDescription
valuePreviewArtifacts
Returns
TypeDescription
Preview.Builder

setPreviewArtifacts(PreviewArtifacts.Builder builderForValue)

public Preview.Builder setPreviewArtifacts(PreviewArtifacts.Builder builderForValue)

Output only. Artifacts from preview.

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

Parameter
NameDescription
builderForValuePreviewArtifacts.Builder
Returns
TypeDescription
Preview.Builder

setPreviewMode(Preview.PreviewMode value)

public Preview.Builder setPreviewMode(Preview.PreviewMode value)

Optional. Current mode of preview.

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

Parameter
NameDescription
valuePreview.PreviewMode

The previewMode to set.

Returns
TypeDescription
Preview.Builder

This builder for chaining.

setPreviewModeValue(int value)

public Preview.Builder setPreviewModeValue(int value)

Optional. Current mode of preview.

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for previewMode to set.

Returns
TypeDescription
Preview.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Preview.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Preview.Builder
Overrides

setServiceAccount(String value)

public Preview.Builder setServiceAccount(String value)

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) = { ... }

Parameter
NameDescription
valueString

The serviceAccount to set.

Returns
TypeDescription
Preview.Builder

This builder for chaining.

setServiceAccountBytes(ByteString value)

public Preview.Builder setServiceAccountBytes(ByteString value)

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) = { ... }

Parameter
NameDescription
valueByteString

The bytes for serviceAccount to set.

Returns
TypeDescription
Preview.Builder

This builder for chaining.

setState(Preview.State value)

public Preview.Builder setState(Preview.State value)

Output only. Current state of the preview.

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

Parameter
NameDescription
valuePreview.State

The state to set.

Returns
TypeDescription
Preview.Builder

This builder for chaining.

setStateValue(int value)

public Preview.Builder setStateValue(int value)

Output only. Current state of the preview.

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
Preview.Builder

This builder for chaining.

setTerraformBlueprint(TerraformBlueprint value)

public Preview.Builder setTerraformBlueprint(TerraformBlueprint value)

The terraform blueprint to preview.

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

Parameter
NameDescription
valueTerraformBlueprint
Returns
TypeDescription
Preview.Builder

setTerraformBlueprint(TerraformBlueprint.Builder builderForValue)

public Preview.Builder setTerraformBlueprint(TerraformBlueprint.Builder builderForValue)

The terraform blueprint to preview.

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

Parameter
NameDescription
builderForValueTerraformBlueprint.Builder
Returns
TypeDescription
Preview.Builder

setTfErrors(int index, TerraformError value)

public Preview.Builder setTfErrors(int index, TerraformError value)

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];

Parameters
NameDescription
indexint
valueTerraformError
Returns
TypeDescription
Preview.Builder

setTfErrors(int index, TerraformError.Builder builderForValue)

public Preview.Builder setTfErrors(int index, TerraformError.Builder builderForValue)

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];

Parameters
NameDescription
indexint
builderForValueTerraformError.Builder
Returns
TypeDescription
Preview.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Preview.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Preview.Builder
Overrides

setWorkerPool(String value)

public Preview.Builder setWorkerPool(String value)

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) = { ... }

Parameter
NameDescription
valueString

The workerPool to set.

Returns
TypeDescription
Preview.Builder

This builder for chaining.

setWorkerPoolBytes(ByteString value)

public Preview.Builder setWorkerPoolBytes(ByteString value)

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) = { ... }

Parameter
NameDescription
valueByteString

The bytes for workerPool to set.

Returns
TypeDescription
Preview.Builder

This builder for chaining.