Infrastructure Manager V1 API - Class Google::Cloud::ConfigService::V1::Deployment (v1.2.0)

Reference documentation and code samples for the Infrastructure Manager V1 API class Google::Cloud::ConfigService::V1::Deployment.

A Deployment is a group of resources and configs managed and provisioned by Infra Manager.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#annotations

def annotations() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployments during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.

#annotations=

def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployments during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.

Returns

(::Google::Protobuf::Map{::String => ::String}) — Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployments during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.

#artifacts_gcs_bucket

def artifacts_gcs_bucket() -> ::String

Returns

(::String) —
Optional. User-defined location of Cloud Build logs and artifacts 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
- The field cannot be updated, including changing its presence

#artifacts_gcs_bucket=

def artifacts_gcs_bucket=(value) -> ::String

Parameter

value (::String) —
Optional. User-defined location of Cloud Build logs and artifacts 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
- The field cannot be updated, including changing its presence

Returns

(::String) —
Optional. User-defined location of Cloud Build logs and artifacts 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
- The field cannot be updated, including changing its presence

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Time when the deployment was created.

#delete_build

def delete_build() -> ::String

Returns

(::String) — Output only. Cloud Build instance UUID associated with deleting this deployment.

#delete_logs

def delete_logs() -> ::String

Returns

(::String) — Output only. Location of Cloud Build logs in Google Cloud Storage, populated when deleting this deployment. Format: gs://{bucket}/{object}.

#delete_results

def delete_results() -> ::Google::Cloud::ConfigService::V1::ApplyResults

Returns

(::Google::Cloud::ConfigService::V1::ApplyResults) — Output only. Location of artifacts from a DeleteDeployment operation.

#error_code

def error_code() -> ::Google::Cloud::ConfigService::V1::Deployment::ErrorCode

Returns

(::Google::Cloud::ConfigService::V1::Deployment::ErrorCode) — Output only. Error code describing errors that may have occurred.

#error_logs

def error_logs() -> ::String

Returns

(::String) — Output only. Location of Terraform error logs in Google Cloud Storage. Format: gs://{bucket}/{object}.

#import_existing_resources

def import_existing_resources() -> ::Boolean

Returns

(::Boolean) — By default, Infra Manager will return a failure when Terraform encounters a 409 code (resource conflict error) during actuation. If this flag is set to true, Infra Manager will instead attempt to automatically import the resource into the Terraform state (for supported resource types) and continue actuation.

Not all resource types are supported, refer to documentation.

#import_existing_resources=

def import_existing_resources=(value) -> ::Boolean

Parameter

value (::Boolean) — By default, Infra Manager will return a failure when Terraform encounters a 409 code (resource conflict error) during actuation. If this flag is set to true, Infra Manager will instead attempt to automatically import the resource into the Terraform state (for supported resource types) and continue actuation.

Not all resource types are supported, refer to documentation.

Returns

(::Boolean) — By default, Infra Manager will return a failure when Terraform encounters a 409 code (resource conflict error) during actuation. If this flag is set to true, Infra Manager will instead attempt to automatically import the resource into the Terraform state (for supported resource types) and continue actuation.

Not all resource types are supported, refer to documentation.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — User-defined metadata for the deployment.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — User-defined metadata for the deployment.

Returns

(::Google::Protobuf::Map{::String => ::String}) — User-defined metadata for the deployment.

#latest_revision

def latest_revision() -> ::String

Returns

(::String) — Output only. Revision name that was most recently applied. Format: projects/{project}/locations/{location}/deployments/{deployment}/ revisions/\\{revision}

#lock_state

def lock_state() -> ::Google::Cloud::ConfigService::V1::Deployment::LockState

Returns

(::Google::Cloud::ConfigService::V1::Deployment::LockState) — Output only. Current lock state of the deployment.

#name

def name() -> ::String

Returns

(::String) — Resource name of the deployment. Format: projects/{project}/locations/{location}/deployments/{deployment}

#name=

def name=(value) -> ::String

Parameter

value (::String) — Resource name of the deployment. Format: projects/{project}/locations/{location}/deployments/{deployment}

Returns

(::String) — Resource name of the deployment. Format: projects/{project}/locations/{location}/deployments/{deployment}

#quota_validation

def quota_validation() -> ::Google::Cloud::ConfigService::V1::QuotaValidation

Returns

(::Google::Cloud::ConfigService::V1::QuotaValidation) — Optional. Input to control quota checks for resources in terraform configuration files. There are limited resources on which quota validation applies.

#quota_validation=

def quota_validation=(value) -> ::Google::Cloud::ConfigService::V1::QuotaValidation

Parameter

value (::Google::Cloud::ConfigService::V1::QuotaValidation) — Optional. Input to control quota checks for resources in terraform configuration files. There are limited resources on which quota validation applies.

Returns

(::Google::Cloud::ConfigService::V1::QuotaValidation) — Optional. Input to control quota checks for resources in terraform configuration files. There are limited resources on which quota validation applies.

#service_account

def service_account() -> ::String

Returns

(::String) — Required. User-specified Service Account (SA) credentials to be used when actuating resources. Format: projects/{projectID}/serviceAccounts/{serviceAccount}

#service_account=

def service_account=(value) -> ::String

Parameter

value (::String) — Required. User-specified Service Account (SA) credentials to be used when actuating resources. Format: projects/{projectID}/serviceAccounts/{serviceAccount}

Returns

(::String) — Required. User-specified Service Account (SA) credentials to be used when actuating resources. Format: projects/{projectID}/serviceAccounts/{serviceAccount}

#state

def state() -> ::Google::Cloud::ConfigService::V1::Deployment::State

Returns

(::Google::Cloud::ConfigService::V1::Deployment::State) — Output only. Current state of the deployment.

#state_detail

def state_detail() -> ::String

Returns

(::String) — Output only. Additional information regarding the current state.

#terraform_blueprint

def terraform_blueprint() -> ::Google::Cloud::ConfigService::V1::TerraformBlueprint

Returns

(::Google::Cloud::ConfigService::V1::TerraformBlueprint) — A blueprint described using Terraform's HashiCorp Configuration Language as a root module.

#terraform_blueprint=

def terraform_blueprint=(value) -> ::Google::Cloud::ConfigService::V1::TerraformBlueprint

Parameter

value (::Google::Cloud::ConfigService::V1::TerraformBlueprint) — A blueprint described using Terraform's HashiCorp Configuration Language as a root module.

Returns

(::Google::Cloud::ConfigService::V1::TerraformBlueprint) — A blueprint described using Terraform's HashiCorp Configuration Language as a root module.

#tf_errors

def tf_errors() -> ::Array<::Google::Cloud::ConfigService::V1::TerraformError>

Returns

(::Array<::Google::Cloud::ConfigService::V1::TerraformError>) — Output only. Errors encountered when deleting this deployment. Errors are truncated to 10 entries, see delete_results and error_logs for full details.

#tf_version

def tf_version() -> ::String

Returns

(::String) — Output only. The current Terraform version set on the deployment. 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".

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Time when the deployment was last modified.

#worker_pool

def worker_pool() -> ::String

Returns

(::String) — Optional. The user-specified Cloud Build 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.

#worker_pool=

def worker_pool=(value) -> ::String

Parameter

value (::String) — Optional. The user-specified Cloud Build 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.

Returns

(::String) — Optional. The user-specified Cloud Build 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.