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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
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 | |
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 | |
WORKER_POOL_FIELD_NUMBER
public static final int WORKER_POOL_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Preview getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Preview.Builder newBuilder()
newBuilder(Preview prototype)
public static Preview.Builder newBuilder(Preview prototype)
Parameter |
---|
Name | Description |
prototype | Preview
|
public static Preview parseDelimitedFrom(InputStream input)
public static Preview parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Preview parseFrom(byte[] data)
Parameter |
---|
Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Preview parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Preview parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Preview parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Preview parseFrom(CodedInputStream input)
public static Preview parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Preview parseFrom(InputStream input)
public static Preview parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Preview parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Preview parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Preview> parser()
Methods
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
|
equals(Object obj)
public boolean equals(Object obj)
Parameter |
---|
Name | Description |
obj | Object
|
Overrides
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()
Optional. User-defined location of Cloud Build logs, artifacts, and
in Google Cloud Storage.
Format: gs://{bucket}/{folder}
A default bucket will be bootstrapped if the field is not set or empty
Default Bucket Format: gs://<project number>-<region>-blueprint-config
Constraints:
- The bucket needs to be in the same project as the deployment
- The path cannot be within the path of
gcs_source
If omitted and deployment resource ref provided has artifacts_gcs_bucket
defined, that artifact bucket is used.
optional string artifacts_gcs_bucket = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns |
---|
Type | Description |
ByteString | The bytes for artifactsGcsBucket.
|
getBlueprintCase()
public Preview.BlueprintCase getBlueprintCase()
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];
getDefaultInstanceForType()
public Preview getDefaultInstanceForType()
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()
Optional. Optional deployment reference. If specified, the preview will be
performed using the provided deployment's current state and use any
relevant fields from the deployment unless explicitly specified in the
preview create request.
string deployment = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
Returns |
---|
Type | Description |
ByteString | The bytes for deployment.
|
getErrorCode()
public 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];
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()
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];
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];
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
|
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()
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()
Overrides
getPreviewArtifacts()
public PreviewArtifacts getPreviewArtifacts()
Output only. Artifacts from preview.
.google.cloud.config.v1.PreviewArtifacts preview_artifacts = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
getPreviewArtifactsOrBuilder()
public PreviewArtifactsOrBuilder getPreviewArtifactsOrBuilder()
Output only. Artifacts from preview.
.google.cloud.config.v1.PreviewArtifacts preview_artifacts = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
getPreviewMode()
public Preview.PreviewMode getPreviewMode()
Optional. Current mode of preview.
.google.cloud.config.v1.Preview.PreviewMode preview_mode = 15 [(.google.api.field_behavior) = OPTIONAL];
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
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 |
---|
Type | Description |
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 |
---|
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];
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.
|
public TerraformBlueprint getTerraformBlueprint()
The terraform blueprint to preview.
.google.cloud.config.v1.TerraformBlueprint terraform_blueprint = 6;
public TerraformBlueprintOrBuilder getTerraformBlueprintOrBuilder()
The terraform blueprint to preview.
.google.cloud.config.v1.TerraformBlueprint terraform_blueprint = 6;
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
|
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];
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
|
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> | |
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. The user-specified Worker Pool resource in which the Cloud Build
job will execute. Format
projects/{project}/locations/{location}/workerPools/{workerPoolId} If this
field is unspecified, the default Cloud Build worker pool will be used. If
omitted and deployment resource ref provided has worker_pool defined, that
worker pool is used.
optional string worker_pool = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
Returns |
---|
Type | Description |
ByteString | The bytes for workerPool.
|
hasArtifactsGcsBucket()
public boolean hasArtifactsGcsBucket()
Optional. User-defined location of Cloud Build logs, artifacts, and
in Google Cloud Storage.
Format: gs://{bucket}/{folder}
A default bucket will be bootstrapped if the field is not set or empty
Default Bucket Format: gs://<project number>-<region>-blueprint-config
Constraints:
- The bucket needs to be in the same project as the deployment
- The path cannot be within the path of
gcs_source
If omitted and deployment resource ref provided has artifacts_gcs_bucket
defined, that artifact bucket is used.
optional string artifacts_gcs_bucket = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns |
---|
Type | Description |
boolean | Whether the artifactsGcsBucket field is set.
|
hasCreateTime()
public 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.
|
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.
|
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 |
---|
Type | Description |
boolean | Whether the workerPool field is set.
|
hashCode()
Returns |
---|
Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
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()
Overrides
newBuilderForType()
public Preview.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Preview.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Preview.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides