Reference documentation and code samples for the Infrastructure Manager V1 API class Google::Cloud::ConfigService::V1::Preview.
A preview represents a set of actions Infra Manager would perform to move the resources towards the desired state as specified in the configuration.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#artifacts_gcs_bucket
def artifacts_gcs_bucket() -> ::String
Returns
-
(::String) —
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-configConstraints:- The bucket needs to be in the same project as the deployment
- The path cannot be within the path of
gcs_sourceIf omitted and deployment resource ref provided has artifacts_gcs_bucket defined, that artifact bucket is used.
#artifacts_gcs_bucket=
def artifacts_gcs_bucket=(value) -> ::String
Parameter
-
value (::String) —
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-configConstraints:- The bucket needs to be in the same project as the deployment
- The path cannot be within the path of
gcs_sourceIf omitted and deployment resource ref provided has artifacts_gcs_bucket defined, that artifact bucket is used.
Returns
-
(::String) —
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-configConstraints:- The bucket needs to be in the same project as the deployment
- The path cannot be within the path of
gcs_sourceIf omitted and deployment resource ref provided has artifacts_gcs_bucket defined, that artifact bucket is used.
#build
def build() -> ::String
Returns
- (::String) — Output only. Cloud Build instance UUID associated with this preview.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Time the preview was created.
#deployment
def deployment() -> ::String
Returns
- (::String) — 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.
#deployment=
def deployment=(value) -> ::String
Parameter
- value (::String) — 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.
Returns
- (::String) — 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.
#error_code
def error_code() -> ::Google::Cloud::ConfigService::V1::Preview::ErrorCode
Returns
- (::Google::Cloud::ConfigService::V1::Preview::ErrorCode) — Output only. Code describing any errors that may have occurred.
#error_logs
def error_logs() -> ::String
Returns
-
(::String) — 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}.
#error_status
def error_status() -> ::Google::Rpc::Status
Returns
- (::Google::Rpc::Status) — Output only. Additional information regarding the current state.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined labels for the preview.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined labels for the preview.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined labels for the preview.
#logs
def logs() -> ::String
Returns
-
(::String) — Output only. Location of preview logs in
gs://{bucket}/{object}format.
#name
def name() -> ::String
Returns
-
(::String) — 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}
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — 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}
Returns
-
(::String) — 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}
#preview_artifacts
def preview_artifacts() -> ::Google::Cloud::ConfigService::V1::PreviewArtifacts
Returns
- (::Google::Cloud::ConfigService::V1::PreviewArtifacts) — Output only. Artifacts from preview.
#preview_mode
def preview_mode() -> ::Google::Cloud::ConfigService::V1::Preview::PreviewMode
Returns
- (::Google::Cloud::ConfigService::V1::Preview::PreviewMode) — Optional. Current mode of preview.
#preview_mode=
def preview_mode=(value) -> ::Google::Cloud::ConfigService::V1::Preview::PreviewMode
Parameter
- value (::Google::Cloud::ConfigService::V1::Preview::PreviewMode) — Optional. Current mode of preview.
Returns
- (::Google::Cloud::ConfigService::V1::Preview::PreviewMode) — Optional. Current mode of preview.
#service_account
def service_account() -> ::String
Returns
-
(::String) — Optional. User-specified Service Account (SA) credentials to be used when
previewing resources.
Format:
projects/{projectID}/serviceAccounts/{serviceAccount}
#service_account=
def service_account=(value) -> ::String
Parameter
-
value (::String) — Optional. User-specified Service Account (SA) credentials to be used when
previewing resources.
Format:
projects/{projectID}/serviceAccounts/{serviceAccount}
Returns
-
(::String) — Optional. User-specified Service Account (SA) credentials to be used when
previewing resources.
Format:
projects/{projectID}/serviceAccounts/{serviceAccount}
#state
def state() -> ::Google::Cloud::ConfigService::V1::Preview::State
Returns
- (::Google::Cloud::ConfigService::V1::Preview::State) — Output only. Current state of the preview.
#terraform_blueprint
def terraform_blueprint() -> ::Google::Cloud::ConfigService::V1::TerraformBlueprint
Returns
- (::Google::Cloud::ConfigService::V1::TerraformBlueprint) — The terraform blueprint to preview.
#terraform_blueprint=
def terraform_blueprint=(value) -> ::Google::Cloud::ConfigService::V1::TerraformBlueprint
Parameter
- value (::Google::Cloud::ConfigService::V1::TerraformBlueprint) — The terraform blueprint to preview.
Returns
- (::Google::Cloud::ConfigService::V1::TerraformBlueprint) — The terraform blueprint to preview.
#tf_errors
def tf_errors() -> ::Array<::Google::Cloud::ConfigService::V1::TerraformError>
Returns
- (::Array<::Google::Cloud::ConfigService::V1::TerraformError>) — 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.
#tf_version
def tf_version() -> ::String
Returns
- (::String) — Output only. The current Terraform version set on the preview. It is in the format of "Major.Minor.Patch", for example, "1.3.10".
#tf_version_constraint
def tf_version_constraint() -> ::String
Returns
- (::String) — Optional. The user-specified Terraform version constraint. Example: "=1.3.10".
#tf_version_constraint=
def tf_version_constraint=(value) -> ::String
Parameter
- value (::String) — Optional. The user-specified Terraform version constraint. Example: "=1.3.10".
Returns
- (::String) — Optional. The user-specified Terraform version constraint. Example: "=1.3.10".
#worker_pool
def worker_pool() -> ::String
Returns
- (::String) — 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.
#worker_pool=
def worker_pool=(value) -> ::String
Parameter
- value (::String) — 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.
Returns
- (::String) — 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.