Preview

import type { Preview } from "https://googleapis.deno.dev/v1/config:v1.ts";

A preview represents a set of actions Infra Manager would perform to move the resources towards the desired state as specified in the configuration.

interface Preview {

annotations?: {

[key: string]: string;

};

artifactsGcsBucket?: string;

readonly build?: string;

readonly createTime?: Date;

deployment?: string;

readonly errorCode?:

| "ERROR_CODE_UNSPECIFIED"

| "CLOUD_BUILD_PERMISSION_DENIED"

| "BUCKET_CREATION_PERMISSION_DENIED"

| "BUCKET_CREATION_FAILED"

| "DEPLOYMENT_LOCK_ACQUIRE_FAILED"

| "PREVIEW_BUILD_API_FAILED"

| "PREVIEW_BUILD_RUN_FAILED";

readonly errorLogs?: string;

readonly errorStatus?: Status;

labels?: {

[key: string]: string;

};

readonly logs?: string;

name?: string;

readonly previewArtifacts?: PreviewArtifacts;

previewMode?: "PREVIEW_MODE_UNSPECIFIED" | "DEFAULT" | "DELETE";

serviceAccount?: string;

readonly state?:

| "STATE_UNSPECIFIED"

| "CREATING"

| "SUCCEEDED"

| "APPLYING"

| "STALE"

| "DELETING"

| "FAILED"

| "DELETED";

terraformBlueprint?: TerraformBlueprint;

readonly tfErrors?: TerraformError[];

readonly tfVersion?: string;

tfVersionConstraint?: string;

workerPool?: string;

}

§Properties

annotations?: {

[key: string]: string;

}

[src]

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.

artifactsGcsBucket?: string

[src]

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.

readonly build?: string

[src]

Output only. Cloud Build instance UUID associated with this preview.

readonly createTime?: Date

[src]

Output only. Time the preview was created.

deployment?: string

[src]

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.

[src]

Output only. Code describing any errors that may have occurred.

readonly errorLogs?: string

[src]

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}.

readonly errorStatus?: Status

[src]

Output only. Additional information regarding the current state.

labels?: {

[key: string]: string;

}

[src]

Optional. User-defined labels for the preview.

readonly logs?: string

[src]

Output only. Location of preview logs in gs://{bucket}/{object} format.

name?: string

[src]

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}

readonly previewArtifacts?: PreviewArtifacts

[src]

Output only. Artifacts from preview.

previewMode?: "PREVIEW_MODE_UNSPECIFIED" | "DEFAULT" | "DELETE"

[src]

Optional. Current mode of preview.

serviceAccount?: string

[src]

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

[src]

Output only. Current state of the preview.

terraformBlueprint?: TerraformBlueprint

[src]

The terraform blueprint to preview.

readonly tfErrors?: TerraformError[]

[src]

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.

readonly tfVersion?: string

[src]

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

tfVersionConstraint?: string

[src]

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

workerPool?: string

[src]

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.