Class protos.google.cloud.gkemulticloud.v1.AwsCluster (1.5.0)

Represents an AwsCluster.

Package

@google-cloud/gkemulticloud

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.gkemulticloud.v1.IAwsCluster);

Constructs a new AwsCluster.

Parameter
Name Description
properties IAwsCluster

Properties to set

Properties

annotations

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

AwsCluster annotations.

authorization

public authorization?: (google.cloud.gkemulticloud.v1.IAwsAuthorization|null);

AwsCluster authorization.

awsRegion

public awsRegion: string;

AwsCluster awsRegion.

binaryAuthorization

public binaryAuthorization?: (google.cloud.gkemulticloud.v1.IBinaryAuthorization|null);

AwsCluster binaryAuthorization.

clusterCaCertificate

public clusterCaCertificate: string;

AwsCluster clusterCaCertificate.

controlPlane

public controlPlane?: (google.cloud.gkemulticloud.v1.IAwsControlPlane|null);

AwsCluster controlPlane.

createTime

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

AwsCluster createTime.

description

public description: string;

AwsCluster description.

endpoint

public endpoint: string;

AwsCluster endpoint.

errors

public errors: google.cloud.gkemulticloud.v1.IAwsClusterError[];

AwsCluster errors.

etag

public etag: string;

AwsCluster etag.

fleet

public fleet?: (google.cloud.gkemulticloud.v1.IFleet|null);

AwsCluster fleet.

loggingConfig

public loggingConfig?: (google.cloud.gkemulticloud.v1.ILoggingConfig|null);

AwsCluster loggingConfig.

monitoringConfig

public monitoringConfig?: (google.cloud.gkemulticloud.v1.IMonitoringConfig|null);

AwsCluster monitoringConfig.

name

public name: string;

AwsCluster name.

networking

public networking?: (google.cloud.gkemulticloud.v1.IAwsClusterNetworking|null);

AwsCluster networking.

reconciling

public reconciling: boolean;

AwsCluster reconciling.

state

public state: (google.cloud.gkemulticloud.v1.AwsCluster.State|keyof typeof google.cloud.gkemulticloud.v1.AwsCluster.State);

AwsCluster state.

uid

public uid: string;

AwsCluster uid.

updateTime

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

AwsCluster updateTime.

workloadIdentityConfig

public workloadIdentityConfig?: (google.cloud.gkemulticloud.v1.IWorkloadIdentityConfig|null);

AwsCluster workloadIdentityConfig.

Methods

create(properties)

public static create(properties?: google.cloud.gkemulticloud.v1.IAwsCluster): google.cloud.gkemulticloud.v1.AwsCluster;

Creates a new AwsCluster instance using the specified properties.

Parameter
Name Description
properties IAwsCluster

Properties to set

Returns
Type Description
AwsCluster

AwsCluster instance

decode(reader, length)

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

Decodes an AwsCluster 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
AwsCluster

AwsCluster

decodeDelimited(reader)

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

Decodes an AwsCluster message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
AwsCluster

AwsCluster

encode(message, writer)

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

Encodes the specified AwsCluster message. Does not implicitly messages.

Parameters
Name Description
message IAwsCluster

AwsCluster 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.gkemulticloud.v1.IAwsCluster, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IAwsCluster

AwsCluster 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.gkemulticloud.v1.AwsCluster;

Creates an AwsCluster 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
AwsCluster

AwsCluster

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AwsCluster

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 AwsCluster to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message AwsCluster

AwsCluster

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 an AwsCluster 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