Deployment(mapping=None, *, ignore_unknown_fields=False, **kwargs)A Deployment is a group of resources and configs managed and provisioned by Infra Manager.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes | |
|---|---|
| Name | Description |
terraform_blueprint |
google.cloud.config_v1.types.TerraformBlueprint
A blueprint described using Terraform's HashiCorp Configuration Language as a root module. This field is a member of oneof_ blueprint.
|
name |
str
Resource name of the deployment. Format: projects/{project}/locations/{location}/deployments/{deployment}
|
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Time when the deployment was created. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Time when the deployment was last modified. |
labels |
MutableMapping[str, str]
User-defined metadata for the deployment. |
state |
google.cloud.config_v1.types.Deployment.State
Output only. Current state of the deployment. |
latest_revision |
str
Output only. Revision name that was most recently applied. Format: projects/{project}/locations/{location}/deployments/{deployment}/ revisions/{revision}
|
state_detail |
str
Output only. Additional information regarding the current state. |
error_code |
google.cloud.config_v1.types.Deployment.ErrorCode
Output only. Error code describing errors that may have occurred. |
delete_results |
google.cloud.config_v1.types.ApplyResults
Output only. Location of artifacts from a DeleteDeployment operation. |
delete_build |
str
Output only. Cloud Build instance UUID associated with deleting this deployment. |
delete_logs |
str
Output only. Location of Cloud Build logs in Google Cloud Storage, populated when deleting this deployment. Format: gs://{bucket}/{object}.
|
tf_errors |
MutableSequence[google.cloud.config_v1.types.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 |
str
Output only. Location of Terraform error logs in Google Cloud Storage. Format: gs://{bucket}/{object}.
|
artifacts_gcs_bucket |
str
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://
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
This field is a member of oneof_ _artifacts_gcs_bucket.
|
service_account |
str
Optional. User-specified Service Account (SA) credentials to be used when actuating resources. Format: projects/{projectID}/serviceAccounts/{serviceAccount}
This field is a member of oneof_ _service_account.
|
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. This field is a member of oneof_ _import_existing_resources.
|
worker_pool |
str
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.
This field is a member of oneof_ _worker_pool.
|
lock_state |
google.cloud.config_v1.types.Deployment.LockState
Output only. Current lock state of the deployment. |
tf_version_constraint |
str
Optional. The user-specified Terraform version constraint. Example: "=1.3.10". This field is a member of oneof_ _tf_version_constraint.
|
tf_version |
str
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 |
google.cloud.config_v1.types.QuotaValidation
Optional. Input to control quota checks for resources in terraform configuration files. There are limited resources on which quota validation applies. |
annotations |
MutableMapping[str, str]
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. |
Classes
AnnotationsEntry
AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
ErrorCode
ErrorCode(value)Possible errors that can occur with deployments.
Values: ERROR_CODE_UNSPECIFIED (0): No error code was specified. REVISION_FAILED (1): The revision failed. See Revision for more details. CLOUD_BUILD_PERMISSION_DENIED (3): Cloud Build failed due to a permission issue. DELETE_BUILD_API_FAILED (5): Cloud Build job associated with a deployment deletion could not be started. DELETE_BUILD_RUN_FAILED (6): Cloud Build job associated with a deployment deletion was started but failed. BUCKET_CREATION_PERMISSION_DENIED (7): Cloud Storage bucket creation failed due to a permission issue. BUCKET_CREATION_FAILED (8): Cloud Storage bucket creation failed due to an issue unrelated to permissions.
LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
LockState
LockState(value)Possible lock states of a deployment.
Values: LOCK_STATE_UNSPECIFIED (0): The default value. This value is used if the lock state is omitted. LOCKED (1): The deployment is locked. UNLOCKED (2): The deployment is unlocked. LOCKING (3): The deployment is being locked. UNLOCKING (4): The deployment is being unlocked. LOCK_FAILED (5): The deployment has failed to lock. UNLOCK_FAILED (6): The deployment has failed to unlock.
State
State(value)Possible states of a deployment.
Values: STATE_UNSPECIFIED (0): The default value. This value is used if the state is omitted. CREATING (1): The deployment is being created. ACTIVE (2): The deployment is healthy. UPDATING (3): The deployment is being updated. DELETING (4): The deployment is being deleted. FAILED (5): The deployment has encountered an unexpected error. SUSPENDED (6): The deployment is no longer being actively reconciled. This may be the result of recovering the project after deletion. DELETED (7): The deployment has been deleted.