public sealed class Preview : IMessage<Preview>, IEquatable<Preview>, IDeepCloneable<Preview>, IBufferMessage, IMessageReference documentation and code samples for the Infrastructure Manager v1 API class 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.
Namespace
Google.Cloud.Config.V1Assembly
Google.Cloud.Config.V1.dll
Constructors
Preview()
public Preview()Preview(Preview)
public Preview(Preview other)| Parameter | |
|---|---|
| Name | Description |
other |
Preview |
Properties
Annotations
public MapField<string, string> Annotations { get; }Optional. Arbitrary key-value metadata storage e.g. to help client tools identifiy preview 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, 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-config
Constraints:
- 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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
BlueprintCase
public Preview.BlueprintOneofCase BlueprintCase { get; }| Property Value | |
|---|---|
| Type | Description |
PreviewBlueprintOneofCase |
|
Build
public string Build { get; set; }Output only. Cloud Build instance UUID associated with this preview.
| Property Value | |
|---|---|
| Type | Description |
string |
|
CreateTime
public Timestamp CreateTime { get; set; }Output only. Time the preview was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
Deployment
public string Deployment { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DeploymentAsDeploymentName
public DeploymentName DeploymentAsDeploymentName { get; set; }DeploymentName-typed view over the Deployment resource name property.
| Property Value | |
|---|---|
| Type | Description |
DeploymentName |
|
ErrorCode
public Preview.Types.ErrorCode ErrorCode { get; set; }Output only. Code describing any errors that may have occurred.
| Property Value | |
|---|---|
| Type | Description |
PreviewTypesErrorCode |
|
ErrorLogs
public string ErrorLogs { get; set; }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}.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ErrorStatus
public Status ErrorStatus { get; set; }Output only. Additional information regarding the current state.
| Property Value | |
|---|---|
| Type | Description |
Status |
|
HasArtifactsGcsBucket
public bool HasArtifactsGcsBucket { get; }Gets whether the "artifacts_gcs_bucket" 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 |
|
Labels
public MapField<string, string> Labels { get; }Optional. User-defined labels for the preview.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring |
|
Logs
public string Logs { get; set; }Output only. Location of preview logs in gs://{bucket}/{object} format.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Name
public string Name { get; set; }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}
| Property Value | |
|---|---|
| Type | Description |
string |
|
PreviewArtifacts
public PreviewArtifacts PreviewArtifacts { get; set; }Output only. Artifacts from preview.
| Property Value | |
|---|---|
| Type | Description |
PreviewArtifacts |
|
PreviewMode
public Preview.Types.PreviewMode PreviewMode { get; set; }Optional. Current mode of preview.
| Property Value | |
|---|---|
| Type | Description |
PreviewTypesPreviewMode |
|
PreviewName
public PreviewName PreviewName { get; set; }PreviewName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
PreviewName |
|
ServiceAccount
public string ServiceAccount { get; set; }Required. User-specified Service Account (SA) credentials to be used when
previewing 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 Preview.Types.State State { get; set; }Output only. Current state of the preview.
| Property Value | |
|---|---|
| Type | Description |
PreviewTypesState |
|
TerraformBlueprint
public TerraformBlueprint TerraformBlueprint { get; set; }The terraform blueprint to preview.
| Property Value | |
|---|---|
| Type | Description |
TerraformBlueprint |
|
TfErrors
public RepeatedField<TerraformError> TfErrors { get; }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.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldTerraformError |
|
TfVersion
public string TfVersion { get; set; }Output only. The current Terraform version set on the preview. 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 |
|
WorkerPool
public string WorkerPool { get; set; }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.
| 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 |
|