Class protos.google.cloud.gaming.v1.KubernetesClusterState (3.1.2)

Stay organized with collections Save and categorize content based on your preferences.

Represents a KubernetesClusterState.

Package

@google-cloud/game-servers

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.gaming.v1.IKubernetesClusterState);

Constructs a new KubernetesClusterState.

Parameter
NameDescription
properties IKubernetesClusterState

Properties to set

Properties

agonesVersionInstalled

public agonesVersionInstalled: string;

KubernetesClusterState agonesVersionInstalled.

agonesVersionTargeted

public agonesVersionTargeted: string;

KubernetesClusterState agonesVersionTargeted.

installationState

public installationState: (google.cloud.gaming.v1.KubernetesClusterState.InstallationState|keyof typeof google.cloud.gaming.v1.KubernetesClusterState.InstallationState);

KubernetesClusterState installationState.

kubernetesVersionInstalled

public kubernetesVersionInstalled: string;

KubernetesClusterState kubernetesVersionInstalled.

provider

public provider: string;

KubernetesClusterState provider.

versionInstalledErrorMessage

public versionInstalledErrorMessage: string;

KubernetesClusterState versionInstalledErrorMessage.

Methods

create(properties)

public static create(properties?: google.cloud.gaming.v1.IKubernetesClusterState): google.cloud.gaming.v1.KubernetesClusterState;

Creates a new KubernetesClusterState instance using the specified properties.

Parameter
NameDescription
properties IKubernetesClusterState

Properties to set

Returns
TypeDescription
google.cloud.gaming.v1.KubernetesClusterState

KubernetesClusterState instance

decode(reader, length)

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

Decodes a KubernetesClusterState message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.gaming.v1.KubernetesClusterState

KubernetesClusterState

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.gaming.v1.KubernetesClusterState

KubernetesClusterState

encode(message, writer)

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

Encodes the specified KubernetesClusterState message. Does not implicitly messages.

Parameters
NameDescription
message IKubernetesClusterState

KubernetesClusterState 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.gaming.v1.IKubernetesClusterState, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IKubernetesClusterState

KubernetesClusterState 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.gaming.v1.KubernetesClusterState;

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

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

Plain object

Returns
TypeDescription
google.cloud.gaming.v1.KubernetesClusterState

KubernetesClusterState

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for KubernetesClusterState

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.gaming.v1.KubernetesClusterState

KubernetesClusterState

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