Infrastructure Manager v1 API - Class Deployment (1.6.0) 

public sealed class Deployment : IMessage<Deployment>, IEquatable<Deployment>, IDeepCloneable<Deployment>, IBufferMessage, IMessage

Reference documentation and code samples for the Infrastructure Manager v1 API class Deployment.

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

Inheritance

object > Deployment

Namespace

Google.Cloud.Config.V1

Assembly

Google.Cloud.Config.V1.dll

Constructors

Deployment()

public Deployment()

Deployment(Deployment)

public Deployment(Deployment other)
Parameter
Name Description
other Deployment

Properties

Annotations

public MapField<string, string> Annotations { get; }

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.

Property Value
Type Description
MapFieldstringstring

ArtifactsGcsBucket

public string ArtifactsGcsBucket { get; set; }

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
Property Value
Type Description
string

BlueprintCase

public Deployment.BlueprintOneofCase BlueprintCase { get; }
Property Value
Type Description
DeploymentBlueprintOneofCase

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Time when the deployment was created.

Property Value
Type Description
Timestamp

DeleteBuild

public string DeleteBuild { get; set; }

Output only. Cloud Build instance UUID associated with deleting this deployment.

Property Value
Type Description
string

DeleteLogs

public string DeleteLogs { get; set; }

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

Property Value
Type Description
string

DeleteResults

public ApplyResults DeleteResults { get; set; }

Output only. Location of artifacts from a DeleteDeployment operation.

Property Value
Type Description
ApplyResults

DeploymentName

public DeploymentName DeploymentName { get; set; }

DeploymentName-typed view over the Name resource name property.

Property Value
Type Description
DeploymentName

ErrorCode

public Deployment.Types.ErrorCode ErrorCode { get; set; }

Output only. Error code describing errors that may have occurred.

Property Value
Type Description
DeploymentTypesErrorCode

ErrorLogs

public string ErrorLogs { get; set; }

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

Property Value
Type Description
string

HasArtifactsGcsBucket

public bool HasArtifactsGcsBucket { get; }

Gets whether the "artifacts_gcs_bucket" field is set

Property Value
Type Description
bool

HasImportExistingResources

public bool HasImportExistingResources { get; }

Gets whether the "import_existing_resources" field is set

Property Value
Type Description
bool

HasServiceAccount

public bool HasServiceAccount { get; }

Gets whether the "service_account" field is set

Property Value
Type Description
bool

HasTfVersionConstraint

public bool HasTfVersionConstraint { get; }

Gets whether the "tf_version_constraint" field is set

Property Value
Type Description
bool

HasWorkerPool

public bool HasWorkerPool { get; }

Gets whether the "worker_pool" field is set

Property Value
Type Description
bool

ImportExistingResources

public bool ImportExistingResources { get; set; }

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.

Property Value
Type Description
bool

Labels

public MapField<string, string> Labels { get; }

User-defined metadata for the deployment.

Property Value
Type Description
MapFieldstringstring

LatestRevision

public string LatestRevision { get; set; }

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

Property Value
Type Description
string

LockState

public Deployment.Types.LockState LockState { get; set; }

Output only. Current lock state of the deployment.

Property Value
Type Description
DeploymentTypesLockState

Name

public string Name { get; set; }

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

Property Value
Type Description
string

QuotaValidation

public QuotaValidation QuotaValidation { get; set; }

Optional. Input to control quota checks for resources in terraform configuration files. There are limited resources on which quota validation applies.

Property Value
Type Description
QuotaValidation

ServiceAccount

public string ServiceAccount { get; set; }

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

Property Value
Type Description
string

ServiceAccountAsServiceAccountName

public ServiceAccountName ServiceAccountAsServiceAccountName { get; set; }

ServiceAccountName-typed view over the ServiceAccount resource name property.

Property Value
Type Description
ServiceAccountName

State

public Deployment.Types.State State { get; set; }

Output only. Current state of the deployment.

Property Value
Type Description
DeploymentTypesState

StateDetail

public string StateDetail { get; set; }

Output only. Additional information regarding the current state.

Property Value
Type Description
string

TerraformBlueprint

public TerraformBlueprint TerraformBlueprint { get; set; }

A blueprint described using Terraform's HashiCorp Configuration Language as a root module.

Property Value
Type Description
TerraformBlueprint

TfErrors

public RepeatedField<TerraformError> TfErrors { get; }

Output only. Errors encountered when deleting this deployment. Errors are truncated to 10 entries, see delete_results and error_logs for full details.

Property Value
Type Description
RepeatedFieldTerraformError

TfVersion

public string TfVersion { get; set; }

Output only. The current Terraform version set on the deployment. It is in the format of "Major.Minor.Patch", for example, "1.3.10".

Property Value
Type Description
string

TfVersionConstraint

public string TfVersionConstraint { get; set; }

Optional. The user-specified Terraform version constraint. Example: "=1.3.10".

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Time when the deployment was last modified.

Property Value
Type Description
Timestamp

WorkerPool

public string WorkerPool { get; set; }

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.

Property Value
Type Description
string

WorkerPoolAsWorkerPoolName

public WorkerPoolName WorkerPoolAsWorkerPoolName { get; set; }

WorkerPoolName-typed view over the WorkerPool resource name property.

Property Value
Type Description
WorkerPoolName