Class protos.google.cloud.gkemulticloud.v1.AttachedCluster (1.1.0)

Represents an AttachedCluster.

Package

@google-cloud/gkemulticloud

Constructors

(constructor)(properties)

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

Constructs a new AttachedCluster.

Parameter
NameDescription
properties IAttachedCluster

Properties to set

Properties

annotations

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

AttachedCluster annotations.

authorization

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

AttachedCluster authorization.

binaryAuthorization

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

AttachedCluster binaryAuthorization.

clusterRegion

public clusterRegion: string;

AttachedCluster clusterRegion.

createTime

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

AttachedCluster createTime.

description

public description: string;

AttachedCluster description.

distribution

public distribution: string;

AttachedCluster distribution.

errors

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

AttachedCluster errors.

etag

public etag: string;

AttachedCluster etag.

fleet

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

AttachedCluster fleet.

kubernetesVersion

public kubernetesVersion: string;

AttachedCluster kubernetesVersion.

loggingConfig

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

AttachedCluster loggingConfig.

monitoringConfig

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

AttachedCluster monitoringConfig.

name

public name: string;

AttachedCluster name.

oidcConfig

public oidcConfig?: (google.cloud.gkemulticloud.v1.IAttachedOidcConfig|null);

AttachedCluster oidcConfig.

platformVersion

public platformVersion: string;

AttachedCluster platformVersion.

proxyConfig

public proxyConfig?: (google.cloud.gkemulticloud.v1.IAttachedProxyConfig|null);

AttachedCluster proxyConfig.

reconciling

public reconciling: boolean;

AttachedCluster reconciling.

state

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

AttachedCluster state.

uid

public uid: string;

AttachedCluster uid.

updateTime

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

AttachedCluster updateTime.

workloadIdentityConfig

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

AttachedCluster workloadIdentityConfig.

Methods

create(properties)

public static create(properties?: google.cloud.gkemulticloud.v1.IAttachedCluster): google.cloud.gkemulticloud.v1.AttachedCluster;

Creates a new AttachedCluster instance using the specified properties.

Parameter
NameDescription
properties IAttachedCluster

Properties to set

Returns
TypeDescription
AttachedCluster

AttachedCluster instance

decode(reader, length)

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

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

AttachedCluster

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
AttachedCluster

AttachedCluster

encode(message, writer)

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

Encodes the specified AttachedCluster message. Does not implicitly messages.

Parameters
NameDescription
message IAttachedCluster

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

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

Parameters
NameDescription
message IAttachedCluster

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

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

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

Plain object

Returns
TypeDescription
AttachedCluster

AttachedCluster

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AttachedCluster

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message AttachedCluster

AttachedCluster

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an AttachedCluster 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