Reference documentation and code samples for the Google Cloud Config V1 Client class Deployment.
A Deployment is a group of resources and configs managed and provisioned by Infra Manager.
Generated from protobuf message google.cloud.config.v1.Deployment
Namespace
Google \ Cloud \ Config \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ terraform_blueprint
TerraformBlueprint
A blueprint described using Terraform's HashiCorp Configuration Language as a root module.
↳ name
string
Identifier. Resource name of the deployment. Format: projects/{project}/locations/{location}/deployments/{deployment}
↳ create_time
↳ update_time
↳ labels
↳ state
int
Output only. Current state of the deployment.
↳ latest_revision
string
Output only. Revision name that was most recently applied. Format: projects/{project}/locations/{location}/deployments/{deployment}/ revisions/{revision}
↳ state_detail
string
Output only. Additional information regarding the current state.
↳ error_code
int
Output only. Error code describing errors that may have occurred.
↳ delete_results
↳ delete_build
string
Output only. Cloud Build instance UUID associated with deleting this deployment.
↳ delete_logs
string
Output only. Location of Cloud Build logs in Google Cloud Storage, populated when deleting this deployment. Format: gs://{bucket}/{object}
.
↳ tf_errors
array< TerraformError
>
Output only. Errors encountered when deleting this deployment. Errors are truncated to 10 entries, see delete_results
and error_logs
for full details.
↳ error_logs
string
Output only. Location of Terraform error logs in Google Cloud Storage. Format: gs://{bucket}/{object}
.
↳ artifacts_gcs_bucket
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
↳ service_account
string
Required. User-specified Service Account (SA) credentials to be used when actuating resources. Format: projects/{projectID}/serviceAccounts/{serviceAccount}
↳ import_existing_resources
bool
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.
↳ worker_pool
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.
↳ lock_state
int
Output only. Current lock state of the deployment.
↳ tf_version_constraint
string
Optional. The user-specified Terraform version constraint. Example: "=1.3.10".
↳ tf_version
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".
↳ quota_validation
int
Optional. Input to control quota checks for resources in terraform configuration files. There are limited resources on which quota validation applies.
↳ annotations
array| Google\Protobuf\Internal\MapField
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.
getTerraformBlueprint
A blueprint described using Terraform's HashiCorp Configuration Language as a root module.
hasTerraformBlueprint
setTerraformBlueprint
A blueprint described using Terraform's HashiCorp Configuration Language as a root module.
$this
getName
Identifier. Resource name of the deployment.
Format: projects/{project}/locations/{location}/deployments/{deployment}
string
setName
Identifier. Resource name of the deployment.
Format: projects/{project}/locations/{location}/deployments/{deployment}
var
string
$this
getCreateTime
Output only. Time when the deployment was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time when the deployment was created.
$this
getUpdateTime
Output only. Time when the deployment was last modified.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Time when the deployment was last modified.
$this
getLabels
Optional. User-defined metadata for the deployment.
setLabels
Optional. User-defined metadata for the deployment.
$this
getState
Output only. Current state of the deployment.
int
setState
Output only. Current state of the deployment.
var
int
$this
getLatestRevision
Output only. Revision name that was most recently applied.
Format: projects/{project}/locations/{location}/deployments/{deployment}/
revisions/{revision}
string
setLatestRevision
Output only. Revision name that was most recently applied.
Format: projects/{project}/locations/{location}/deployments/{deployment}/
revisions/{revision}
var
string
$this
getStateDetail
Output only. Additional information regarding the current state.
string
setStateDetail
Output only. Additional information regarding the current state.
var
string
$this
getErrorCode
Output only. Error code describing errors that may have occurred.
int
setErrorCode
Output only. Error code describing errors that may have occurred.
var
int
$this
getDeleteResults
Output only. Location of artifacts from a DeleteDeployment operation.
hasDeleteResults
clearDeleteResults
setDeleteResults
Output only. Location of artifacts from a DeleteDeployment operation.
$this
getDeleteBuild
Output only. Cloud Build instance UUID associated with deleting this deployment.
string
setDeleteBuild
Output only. Cloud Build instance UUID associated with deleting this deployment.
var
string
$this
getDeleteLogs
Output only. Location of Cloud Build logs in Google Cloud Storage,
populated when deleting this deployment. Format: gs://{bucket}/{object}
.
string
setDeleteLogs
Output only. Location of Cloud Build logs in Google Cloud Storage,
populated when deleting this deployment. Format: gs://{bucket}/{object}
.
var
string
$this
getTfErrors
Output only. Errors encountered when deleting this deployment.
Errors are truncated to 10 entries, see delete_results
and error_logs
for full details.
setTfErrors
Output only. Errors encountered when deleting this deployment.
Errors are truncated to 10 entries, see delete_results
and error_logs
for full details.
$this
getErrorLogs
Output only. Location of Terraform error logs in Google Cloud Storage.
Format: gs://{bucket}/{object}
.
string
setErrorLogs
Output only. Location of Terraform error logs in Google Cloud Storage.
Format: gs://{bucket}/{object}
.
var
string
$this
getArtifactsGcsBucket
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
string
hasArtifactsGcsBucket
clearArtifactsGcsBucket
setArtifactsGcsBucket
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
var
string
$this
getServiceAccount
Required. User-specified Service Account (SA) credentials to be used when actuating resources.
Format: projects/{projectID}/serviceAccounts/{serviceAccount}
string
hasServiceAccount
clearServiceAccount
setServiceAccount
Required. User-specified Service Account (SA) credentials to be used when actuating resources.
Format: projects/{projectID}/serviceAccounts/{serviceAccount}
var
string
$this
getImportExistingResources
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.
bool
hasImportExistingResources
clearImportExistingResources
setImportExistingResources
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.
var
bool
$this
getWorkerPool
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.
string
hasWorkerPool
clearWorkerPool
setWorkerPool
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.
var
string
$this
getLockState
Output only. Current lock state of the deployment.
int
setLockState
Output only. Current lock state of the deployment.
var
int
$this
getTfVersionConstraint
Optional. The user-specified Terraform version constraint.
Example: "=1.3.10".
string
hasTfVersionConstraint
clearTfVersionConstraint
setTfVersionConstraint
Optional. The user-specified Terraform version constraint.
Example: "=1.3.10".
var
string
$this
getTfVersion
Output only. The current Terraform version set on the deployment.
It is in the format of "Major.Minor.Patch", for example, "1.3.10".
string
setTfVersion
Output only. The current Terraform version set on the deployment.
It is in the format of "Major.Minor.Patch", for example, "1.3.10".
var
string
$this
getQuotaValidation
Optional. Input to control quota checks for resources in terraform configuration files. There are limited resources on which quota validation applies.
int
setQuotaValidation
Optional. Input to control quota checks for resources in terraform configuration files. There are limited resources on which quota validation applies.
var
int
$this
getAnnotations
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.
setAnnotations
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.
$this
getBlueprint
string
