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.
Implements
Inherited Members
Namespace: Google.Apis.Config.v1.Data
Assembly: Google.Apis.Config.v1.dll
Syntax
public class Preview : IDirectResponseSchema
Properties
Annotations
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.
Declaration
[JsonProperty("annotations")]
public virtual IDictionary<string, string> Annotations { get; set; }
Property Value
Type | Description |
---|---|
IDictionary<string, string> |
ArtifactsGcsBucket
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://--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
If omitted and deployment resource ref
provided has artifacts_gcs_bucket defined, that artifact bucket is used.
Declaration
[JsonProperty("artifactsGcsBucket")]
public virtual string ArtifactsGcsBucket { get; set; }
Property Value
Type | Description |
---|---|
string |
Build
Output only. Cloud Build instance UUID associated with this preview.
Declaration
[JsonProperty("build")]
public virtual string Build { get; set; }
Property Value
Type | Description |
---|---|
string |
CreateTime
object representation of CreateTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type | Description |
---|---|
object |
CreateTimeDateTimeOffset
DateTimeOffset representation of CreateTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
CreateTimeRaw
Output only. Time the preview was created.
Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
Deployment
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.
Declaration
[JsonProperty("deployment")]
public virtual string Deployment { get; set; }
Property Value
Type | Description |
---|---|
string |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
ErrorCode
Output only. Code describing any errors that may have occurred.
Declaration
[JsonProperty("errorCode")]
public virtual string ErrorCode { get; set; }
Property Value
Type | Description |
---|---|
string |
ErrorLogs
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}
.
Declaration
[JsonProperty("errorLogs")]
public virtual string ErrorLogs { get; set; }
Property Value
Type | Description |
---|---|
string |
ErrorStatus
Output only. Additional information regarding the current state.
Declaration
[JsonProperty("errorStatus")]
public virtual Status ErrorStatus { get; set; }
Property Value
Type | Description |
---|---|
Status |
Labels
Optional. User-defined labels for the preview.
Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type | Description |
---|---|
IDictionary<string, string> |
Logs
Output only. Location of preview logs in gs://{bucket}/{object}
format.
Declaration
[JsonProperty("logs")]
public virtual string Logs { get; set; }
Property Value
Type | Description |
---|---|
string |
Name
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}
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
PreviewArtifacts
Output only. Artifacts from preview.
Declaration
[JsonProperty("previewArtifacts")]
public virtual PreviewArtifacts PreviewArtifacts { get; set; }
Property Value
Type | Description |
---|---|
PreviewArtifacts |
PreviewMode
Optional. Current mode of preview.
Declaration
[JsonProperty("previewMode")]
public virtual string PreviewMode { get; set; }
Property Value
Type | Description |
---|---|
string |
ServiceAccount
Required. User-specified Service Account (SA) credentials to be used when previewing resources. Format:
projects/{projectID}/serviceAccounts/{serviceAccount}
Declaration
[JsonProperty("serviceAccount")]
public virtual string ServiceAccount { get; set; }
Property Value
Type | Description |
---|---|
string |
State
Output only. Current state of the preview.
Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type | Description |
---|---|
string |
TerraformBlueprint
The terraform blueprint to preview.
Declaration
[JsonProperty("terraformBlueprint")]
public virtual TerraformBlueprint TerraformBlueprint { get; set; }
Property Value
Type | Description |
---|---|
TerraformBlueprint |
TfErrors
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.
Declaration
[JsonProperty("tfErrors")]
public virtual IList<TerraformError> TfErrors { get; set; }
Property Value
Type | Description |
---|---|
IList<TerraformError> |
TfVersion
Output only. The current Terraform version set on the preview. It is in the format of "Major.Minor.Patch", for example, "1.3.10".
Declaration
[JsonProperty("tfVersion")]
public virtual string TfVersion { get; set; }
Property Value
Type | Description |
---|---|
string |
TfVersionConstraint
Optional. The user-specified Terraform version constraint. Example: "=1.3.10".
Declaration
[JsonProperty("tfVersionConstraint")]
public virtual string TfVersionConstraint { get; set; }
Property Value
Type | Description |
---|---|
string |
WorkerPool
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.
Declaration
[JsonProperty("workerPool")]
public virtual string WorkerPool { get; set; }
Property Value
Type | Description |
---|---|
string |