Class protos.google.cloud.config.v1.Preview (0.2.0)

Represents a Preview.

Package

@google-cloud/config

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.config.v1.IPreview);

Constructs a new Preview.

Parameter
NameDescription
properties IPreview

Properties to set

Properties

_artifactsGcsBucket

public _artifactsGcsBucket?: "artifactsGcsBucket";

Preview _artifactsGcsBucket.

_workerPool

public _workerPool?: "workerPool";

Preview _workerPool.

artifactsGcsBucket

public artifactsGcsBucket?: (string|null);

Preview artifactsGcsBucket.

blueprint

public blueprint?: "terraformBlueprint";

Preview blueprint.

build

public build: string;

Preview build.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Preview createTime.

deployment

public deployment: string;

Preview deployment.

errorCode

public errorCode: (google.cloud.config.v1.Preview.ErrorCode|keyof typeof google.cloud.config.v1.Preview.ErrorCode);

Preview errorCode.

errorLogs

public errorLogs: string;

Preview errorLogs.

errorStatus

public errorStatus?: (google.rpc.IStatus|null);

Preview errorStatus.

labels

public labels: { [k: string]: string };

Preview labels.

logs

public logs: string;

Preview logs.

name

public name: string;

Preview name.

previewArtifacts

public previewArtifacts?: (google.cloud.config.v1.IPreviewArtifacts|null);

Preview previewArtifacts.

previewMode

public previewMode: (google.cloud.config.v1.Preview.PreviewMode|keyof typeof google.cloud.config.v1.Preview.PreviewMode);

Preview previewMode.

serviceAccount

public serviceAccount: string;

Preview serviceAccount.

state

public state: (google.cloud.config.v1.Preview.State|keyof typeof google.cloud.config.v1.Preview.State);

Preview state.

terraformBlueprint

public terraformBlueprint?: (google.cloud.config.v1.ITerraformBlueprint|null);

Preview terraformBlueprint.

tfErrors

public tfErrors: google.cloud.config.v1.ITerraformError[];

Preview tfErrors.

workerPool

public workerPool?: (string|null);

Preview workerPool.

Methods

create(properties)

public static create(properties?: google.cloud.config.v1.IPreview): google.cloud.config.v1.Preview;

Creates a new Preview instance using the specified properties.

Parameter
NameDescription
properties IPreview

Properties to set

Returns
TypeDescription
Preview

Preview instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.config.v1.Preview;

Decodes a Preview message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
Preview

Preview

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.config.v1.Preview;

Decodes a Preview message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
Preview

Preview

encode(message, writer)

public static encode(message: google.cloud.config.v1.IPreview, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Preview message. Does not implicitly messages.

Parameters
NameDescription
message IPreview

Preview message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.config.v1.IPreview, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Preview message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IPreview

Preview message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.config.v1.Preview;

Creates a Preview message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
Preview

Preview

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Preview

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this Preview to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.config.v1.Preview, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a Preview message. Also converts values to other types if specified.

Parameters
NameDescription
message Preview

Preview

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Preview message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not