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

Represents an AzureControlPlane.

Package

@google-cloud/gkemulticloud

Constructors

(constructor)(properties)

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

Constructs a new AzureControlPlane.

Parameter
NameDescription
properties IAzureControlPlane

Properties to set

Properties

configEncryption

public configEncryption?: (google.cloud.gkemulticloud.v1.IAzureConfigEncryption|null);

AzureControlPlane configEncryption.

databaseEncryption

public databaseEncryption?: (google.cloud.gkemulticloud.v1.IAzureDatabaseEncryption|null);

AzureControlPlane databaseEncryption.

endpointSubnetId

public endpointSubnetId: string;

AzureControlPlane endpointSubnetId.

mainVolume

public mainVolume?: (google.cloud.gkemulticloud.v1.IAzureDiskTemplate|null);

AzureControlPlane mainVolume.

proxyConfig

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

AzureControlPlane proxyConfig.

replicaPlacements

public replicaPlacements: google.cloud.gkemulticloud.v1.IReplicaPlacement[];

AzureControlPlane replicaPlacements.

rootVolume

public rootVolume?: (google.cloud.gkemulticloud.v1.IAzureDiskTemplate|null);

AzureControlPlane rootVolume.

sshConfig

public sshConfig?: (google.cloud.gkemulticloud.v1.IAzureSshConfig|null);

AzureControlPlane sshConfig.

subnetId

public subnetId: string;

AzureControlPlane subnetId.

tags

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

AzureControlPlane tags.

version

public version: string;

AzureControlPlane version.

vmSize

public vmSize: string;

AzureControlPlane vmSize.

Methods

create(properties)

public static create(properties?: google.cloud.gkemulticloud.v1.IAzureControlPlane): google.cloud.gkemulticloud.v1.AzureControlPlane;

Creates a new AzureControlPlane instance using the specified properties.

Parameter
NameDescription
properties IAzureControlPlane

Properties to set

Returns
TypeDescription
AzureControlPlane

AzureControlPlane instance

decode(reader, length)

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

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

AzureControlPlane

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
AzureControlPlane

AzureControlPlane

encode(message, writer)

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

Encodes the specified AzureControlPlane message. Does not implicitly messages.

Parameters
NameDescription
message IAzureControlPlane

AzureControlPlane 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.IAzureControlPlane, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IAzureControlPlane

AzureControlPlane 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.AzureControlPlane;

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

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

Plain object

Returns
TypeDescription
AzureControlPlane

AzureControlPlane

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AzureControlPlane

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message AzureControlPlane

AzureControlPlane

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 AzureControlPlane 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