Package com.google.cloud.config.v1
Interface PreviewOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Preview,Preview.Builder
@Generated
public interface PreviewOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleanOptional.booleancontainsLabels(String key) Optional.Deprecated.intOptional.Optional.getAnnotationsOrDefault(String key, String defaultValue) Optional.Optional.Optional.com.google.protobuf.ByteStringOptional.getBuild()Output only.com.google.protobuf.ByteStringOutput only.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Optional.com.google.protobuf.ByteStringOptional.Output only.intOutput only.Output only.com.google.protobuf.ByteStringOutput only.Output only.Output only.Deprecated.intOptional.Optional.getLabelsOrDefault(String key, String defaultValue) Optional.getLabelsOrThrow(String key) Optional.getLogs()Output only.com.google.protobuf.ByteStringOutput only.getName()Identifier.com.google.protobuf.ByteStringIdentifier.Output only.Output only.Optional.intOptional.Optional.Optional.Required.com.google.protobuf.ByteStringRequired.getState()Output only.intOutput only.The terraform blueprint to preview.The terraform blueprint to preview.getTfErrors(int index) Output only.intOutput only.Output only.getTfErrorsOrBuilder(int index) Output only.List<? extends TerraformErrorOrBuilder>Output only.Output only.com.google.protobuf.ByteStringOutput only.Optional.com.google.protobuf.ByteStringOptional.Optional.com.google.protobuf.ByteStringOptional.booleanOptional.booleanOutput only.booleanOutput only.booleanOutput only.booleanOptional.booleanThe terraform blueprint to preview.booleanOptional.booleanOptional.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
hasTerraformBlueprint
boolean hasTerraformBlueprint()The terraform blueprint to preview.
.google.cloud.config.v1.TerraformBlueprint terraform_blueprint = 6;- Returns:
- Whether the terraformBlueprint field is set.
-
getTerraformBlueprint
TerraformBlueprint getTerraformBlueprint()The terraform blueprint to preview.
.google.cloud.config.v1.TerraformBlueprint terraform_blueprint = 6;- Returns:
- The terraformBlueprint.
-
getTerraformBlueprintOrBuilder
TerraformBlueprintOrBuilder getTerraformBlueprintOrBuilder()The terraform blueprint to preview.
.google.cloud.config.v1.TerraformBlueprint terraform_blueprint = 6; -
getName
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:
- The name.
-
getNameBytes
com.google.protobuf.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:
- The bytes for name.
-
hasCreateTime
boolean hasCreateTime()Output only. Time the preview was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the createTime field is set.
-
getCreateTime
com.google.protobuf.Timestamp getCreateTime()Output only. Time the preview was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The createTime.
-
getCreateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. Time the preview was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getLabelsCount
int getLabelsCount()Optional. User-defined labels for the preview.
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL]; -
containsLabels
Optional. User-defined labels for the preview.
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL]; -
getLabels
Deprecated.UsegetLabelsMap()instead. -
getLabelsMap
Optional. User-defined labels for the preview.
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL]; -
getLabelsOrDefault
Optional. User-defined labels for the preview.
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL]; -
getLabelsOrThrow
Optional. User-defined labels for the preview.
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL]; -
getStateValue
int getStateValue()Output only. Current state of the preview.
.google.cloud.config.v1.Preview.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The enum numeric value on the wire for state.
-
getState
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:
- The state.
-
getDeployment
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:
- The deployment.
-
getDeploymentBytes
com.google.protobuf.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:
- The bytes for deployment.
-
getPreviewModeValue
int getPreviewModeValue()Optional. Current mode of preview.
.google.cloud.config.v1.Preview.PreviewMode preview_mode = 15 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The enum numeric value on the wire for previewMode.
-
getPreviewMode
Preview.PreviewMode getPreviewMode()Optional. Current mode of preview.
.google.cloud.config.v1.Preview.PreviewMode preview_mode = 15 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The previewMode.
-
getServiceAccount
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:
- The serviceAccount.
-
getServiceAccountBytes
com.google.protobuf.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:
- The bytes for serviceAccount.
-
hasArtifactsGcsBucket
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:
- Whether the artifactsGcsBucket field is set.
-
getArtifactsGcsBucket
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:
- The artifactsGcsBucket.
-
getArtifactsGcsBucketBytes
com.google.protobuf.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:
- The bytes for artifactsGcsBucket.
-
hasWorkerPool
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:
- Whether the workerPool field is set.
-
getWorkerPool
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:
- The workerPool.
-
getWorkerPoolBytes
com.google.protobuf.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:
- The bytes for workerPool.
-
getErrorCodeValue
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:
- The enum numeric value on the wire for errorCode.
-
getErrorCode
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:
- The errorCode.
-
hasErrorStatus
boolean hasErrorStatus()Output only. Additional information regarding the current state.
.google.rpc.Status error_status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the errorStatus field is set.
-
getErrorStatus
Status getErrorStatus()Output only. Additional information regarding the current state.
.google.rpc.Status error_status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The errorStatus.
-
getErrorStatusOrBuilder
StatusOrBuilder getErrorStatusOrBuilder()Output only. Additional information regarding the current state.
.google.rpc.Status error_status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getBuild
String getBuild()Output only. Cloud Build instance UUID associated with this preview.
string build = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The build.
-
getBuildBytes
com.google.protobuf.ByteString getBuildBytes()Output only. Cloud Build instance UUID associated with this preview.
string build = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The bytes for build.
-
getTfErrorsList
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]; -
getTfErrors
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]; -
getTfErrorsCount
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]; -
getTfErrorsOrBuilderList
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]; -
getTfErrorsOrBuilder
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]; -
getErrorLogs
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:
- The errorLogs.
-
getErrorLogsBytes
com.google.protobuf.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:
- The bytes for errorLogs.
-
hasPreviewArtifacts
boolean hasPreviewArtifacts()Output only. Artifacts from preview.
.google.cloud.config.v1.PreviewArtifacts preview_artifacts = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the previewArtifacts field is set.
-
getPreviewArtifacts
PreviewArtifacts getPreviewArtifacts()Output only. Artifacts from preview.
.google.cloud.config.v1.PreviewArtifacts preview_artifacts = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The previewArtifacts.
-
getPreviewArtifactsOrBuilder
PreviewArtifactsOrBuilder getPreviewArtifactsOrBuilder()Output only. Artifacts from preview.
.google.cloud.config.v1.PreviewArtifacts preview_artifacts = 16 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getLogs
String getLogs()Output only. Location of preview logs in `gs://{bucket}/{object}` format.string logs = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The logs.
-
getLogsBytes
com.google.protobuf.ByteString getLogsBytes()Output only. Location of preview logs in `gs://{bucket}/{object}` format.string logs = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The bytes for logs.
-
getTfVersion
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:
- The tfVersion.
-
getTfVersionBytes
com.google.protobuf.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:
- The bytes for tfVersion.
-
hasTfVersionConstraint
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:
- Whether the tfVersionConstraint field is set.
-
getTfVersionConstraint
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:
- The tfVersionConstraint.
-
getTfVersionConstraintBytes
com.google.protobuf.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:
- The bytes for tfVersionConstraint.
-
getAnnotationsCount
int getAnnotationsCount()Optional. Arbitrary key-value metadata storage e.g. to help client tools identify 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]; -
containsAnnotations
Optional. Arbitrary key-value metadata storage e.g. to help client tools identify 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]; -
getAnnotations
Deprecated.UsegetAnnotationsMap()instead. -
getAnnotationsMap
Optional. Arbitrary key-value metadata storage e.g. to help client tools identify 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]; -
getAnnotationsOrDefault
Optional. Arbitrary key-value metadata storage e.g. to help client tools identify 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]; -
getAnnotationsOrThrow
Optional. Arbitrary key-value metadata storage e.g. to help client tools identify 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]; -
hasProviderConfig
boolean hasProviderConfig()Optional. This field specifies the provider configurations.
.google.cloud.config.v1.ProviderConfig provider_config = 21 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- Whether the providerConfig field is set.
-
getProviderConfig
ProviderConfig getProviderConfig()Optional. This field specifies the provider configurations.
.google.cloud.config.v1.ProviderConfig provider_config = 21 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The providerConfig.
-
getProviderConfigOrBuilder
ProviderConfigOrBuilder getProviderConfigOrBuilder()Optional. This field specifies the provider configurations.
.google.cloud.config.v1.ProviderConfig provider_config = 21 [(.google.api.field_behavior) = OPTIONAL]; -
getBlueprintCase
Preview.BlueprintCase getBlueprintCase()
-