Class protos.google.cloud.config.v1.TerraformError (0.5.0)

Represents a TerraformError.

Package

@google-cloud/config

Constructors

(constructor)(properties)

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

Constructs a new TerraformError.

Parameter
Name Description
properties ITerraformError

Properties to set

Properties

error

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

TerraformError error.

errorDescription

public errorDescription: string;

TerraformError errorDescription.

httpResponseCode

public httpResponseCode: number;

TerraformError httpResponseCode.

resourceAddress

public resourceAddress: string;

TerraformError resourceAddress.

Methods

create(properties)

public static create(properties?: google.cloud.config.v1.ITerraformError): google.cloud.config.v1.TerraformError;

Creates a new TerraformError instance using the specified properties.

Parameter
Name Description
properties ITerraformError

Properties to set

Returns
Type Description
TerraformError

TerraformError instance

decode(reader, length)

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

Decodes a TerraformError message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
TerraformError

TerraformError

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
TerraformError

TerraformError

encode(message, writer)

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

Encodes the specified TerraformError message. Does not implicitly messages.

Parameters
Name Description
message ITerraformError

TerraformError message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
Name Description
message ITerraformError

TerraformError message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
TerraformError

TerraformError

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for TerraformError

Parameter
Name Description
typeUrlPrefix string

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

Returns
Type Description
string

The default type url

toJSON()

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

Converts this TerraformError to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message TerraformError

TerraformError

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a TerraformError message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not