Class Preview (0.32.0)

public final class Preview extends GeneratedMessageV3 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Preview

Implements

PreviewOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ANNOTATIONS_FIELD_NUMBER

public static final int ANNOTATIONS_FIELD_NUMBER

Field Value
Type	Description
`int`

ARTIFACTS_GCS_BUCKET_FIELD_NUMBER

public static final int ARTIFACTS_GCS_BUCKET_FIELD_NUMBER

Field Value
Type	Description
`int`

BUILD_FIELD_NUMBER

public static final int BUILD_FIELD_NUMBER

Field Value
Type	Description
`int`

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

DEPLOYMENT_FIELD_NUMBER

public static final int DEPLOYMENT_FIELD_NUMBER

Field Value
Type	Description
`int`

ERROR_CODE_FIELD_NUMBER

public static final int ERROR_CODE_FIELD_NUMBER

Field Value
Type	Description
`int`

ERROR_LOGS_FIELD_NUMBER

public static final int ERROR_LOGS_FIELD_NUMBER

Field Value
Type	Description
`int`

ERROR_STATUS_FIELD_NUMBER

public static final int ERROR_STATUS_FIELD_NUMBER

Field Value
Type	Description
`int`

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

Field Value
Type	Description
`int`

LOGS_FIELD_NUMBER

public static final int LOGS_FIELD_NUMBER

Field Value
Type	Description
`int`

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

PREVIEW_ARTIFACTS_FIELD_NUMBER

public static final int PREVIEW_ARTIFACTS_FIELD_NUMBER

Field Value
Type	Description
`int`

PREVIEW_MODE_FIELD_NUMBER

public static final int PREVIEW_MODE_FIELD_NUMBER

Field Value
Type	Description
`int`

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER

Field Value
Type	Description
`int`

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

Field Value
Type	Description
`int`

TERRAFORM_BLUEPRINT_FIELD_NUMBER

public static final int TERRAFORM_BLUEPRINT_FIELD_NUMBER

Field Value
Type	Description
`int`

TF_ERRORS_FIELD_NUMBER

public static final int TF_ERRORS_FIELD_NUMBER

Field Value
Type	Description
`int`

TF_VERSION_CONSTRAINT_FIELD_NUMBER

public static final int TF_VERSION_CONSTRAINT_FIELD_NUMBER

Field Value
Type	Description
`int`

TF_VERSION_FIELD_NUMBER

public static final int TF_VERSION_FIELD_NUMBER

Field Value
Type	Description
`int`

WORKER_POOL_FIELD_NUMBER

public static final int WORKER_POOL_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static Preview getDefaultInstance()

Returns
Type	Description
`Preview`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static Preview.Builder newBuilder()

Returns
Type	Description
`Preview.Builder`

newBuilder(Preview prototype)

public static Preview.Builder newBuilder(Preview prototype)

Parameter
Name	Description
`prototype`	`Preview`

Returns
Type	Description
`Preview.Builder`

parseDelimitedFrom(InputStream input)

public static Preview parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Preview`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Preview parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Preview`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static Preview parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`Preview`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Preview parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Preview`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static Preview parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`Preview`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Preview parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Preview`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static Preview parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`Preview`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Preview parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Preview`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static Preview parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Preview`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Preview parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Preview`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static Preview parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`Preview`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Preview parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Preview`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<Preview> parser()

Returns
Type	Description
`Parser<Preview>`

Methods

containsAnnotations(String key)

public boolean containsAnnotations(String key)

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

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

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

containsLabels(String key)

public boolean containsLabels(String key)

Optional. User-defined labels for the preview.

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

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getAnnotations() (deprecated)

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type	Description
`Map<String,String>`

getAnnotationsCount()

public int getAnnotationsCount()

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

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

Returns
Type	Description
`int`

getAnnotationsMap()

public Map<String,String> getAnnotationsMap()

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

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

Returns
Type	Description
`Map<String,String>`

getAnnotationsOrDefault(String key, String defaultValue)

public String getAnnotationsOrDefault(String key, String defaultValue)

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

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

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getAnnotationsOrThrow(String key)

public String getAnnotationsOrThrow(String key)

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

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

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

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
Type	Description
`String`	The artifactsGcsBucket.

getArtifactsGcsBucketBytes()

public ByteString getArtifactsGcsBucketBytes()

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 Preview.BlueprintCase getBlueprintCase()

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`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
Type	Description
`Timestamp`	The createTime.

getCreateTimeOrBuilder()

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

getDefaultInstanceForType()

public Preview getDefaultInstanceForType()

Returns
Type	Description
`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
Type	Description
`String`	The deployment.

getDeploymentBytes()

public ByteString getDeploymentBytes()

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

Returns
Type	Description
`ByteString`	The bytes for deployment.

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
Type	Description
`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
Type	Description
`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
Type	Description
`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
Type	Description
`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
Type	Description
`com.google.rpc.Status`	The errorStatus.

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
Type	Description
`com.google.rpc.StatusOrBuilder`

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`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
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`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
Name	Description
`key`	`String`

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`ByteString`	The bytes for logs.

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
Type	Description
`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
Type	Description
`ByteString`	The bytes for name.

getParserForType()

public Parser<Preview> getParserForType()

Returns
Type	Description
`Parser<Preview>`

Overrides

GeneratedMessageV3.getParserForType()

getPreviewArtifacts()

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

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getServiceAccount()

public String getServiceAccount()

Required. 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) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

Required. 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) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`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
Type	Description
`TerraformBlueprint`	The terraformBlueprint.

getTerraformBlueprintOrBuilder()

public TerraformBlueprintOrBuilder getTerraformBlueprintOrBuilder()

The terraform blueprint to preview.

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

Returns
Type	Description
`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
Name	Description
`index`	`int`

Returns
Type	Description
`TerraformError`

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
Type	Description
`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
Type	Description
`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
Name	Description
`index`	`int`

Returns
Type	Description
`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
Type	Description
`List<? extends com.google.cloud.config.v1.TerraformErrorOrBuilder>`

getTfVersion()

public 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 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 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 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 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 ByteString getWorkerPoolBytes()

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

Returns
Type	Description
`ByteString`	The bytes for workerPool.

hasArtifactsGcsBucket()

public boolean hasArtifactsGcsBucket()

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 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 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 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 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 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 boolean hasWorkerPool()

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

Returns
Type	Description
`boolean`	Whether the workerPool field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`com.google.protobuf.MapFieldReflectionAccessor`

Overrides

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Preview.Builder newBuilderForType()

Returns
Type	Description
`Preview.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Preview.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`Preview.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Preview.Builder toBuilder()

Returns
Type	Description
`Preview.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`