Class protos.google.container.v1.Cluster (2.3.2)

Represents a Cluster.

Package

@google-cloud/container!

Constructors

(constructor)(properties)

constructor(properties?: google.container.v1.ICluster);

Constructs a new Cluster.

Parameter
Name Description
properties ICluster

Properties to set

Properties

addonsConfig

public addonsConfig?: (google.container.v1.IAddonsConfig|null);

Cluster addonsConfig.

Property Value
Type Description
(google.container.v1.IAddonsConfig|null)

authenticatorGroupsConfig

public authenticatorGroupsConfig?: (google.container.v1.IAuthenticatorGroupsConfig|null);

Cluster authenticatorGroupsConfig.

Property Value
Type Description
(google.container.v1.IAuthenticatorGroupsConfig|null)

autoscaling

public autoscaling?: (google.container.v1.IClusterAutoscaling|null);

Cluster autoscaling.

Property Value
Type Description
(google.container.v1.IClusterAutoscaling|null)

binaryAuthorization

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

Cluster binaryAuthorization.

Property Value
Type Description
(google.container.v1.IBinaryAuthorization|null)

clusterIpv4Cidr

public clusterIpv4Cidr: string;

Cluster clusterIpv4Cidr.

Property Value
Type Description
string

conditions

public conditions: google.container.v1.IStatusCondition[];

Cluster conditions.

Property Value
Type Description
google.container.v1.IStatusCondition[]

createTime

public createTime: string;

Cluster createTime.

Property Value
Type Description
string

currentMasterVersion

public currentMasterVersion: string;

Cluster currentMasterVersion.

Property Value
Type Description
string

currentNodeCount

public currentNodeCount: number;

Cluster currentNodeCount.

Property Value
Type Description
number

currentNodeVersion

public currentNodeVersion: string;

Cluster currentNodeVersion.

Property Value
Type Description
string

databaseEncryption

public databaseEncryption?: (google.container.v1.IDatabaseEncryption|null);

Cluster databaseEncryption.

Property Value
Type Description
(google.container.v1.IDatabaseEncryption|null)

defaultMaxPodsConstraint

public defaultMaxPodsConstraint?: (google.container.v1.IMaxPodsConstraint|null);

Cluster defaultMaxPodsConstraint.

Property Value
Type Description
(google.container.v1.IMaxPodsConstraint|null)

description

public description: string;

Cluster description.

Property Value
Type Description
string

enableKubernetesAlpha

public enableKubernetesAlpha: boolean;

Cluster enableKubernetesAlpha.

Property Value
Type Description
boolean

enableTpu

public enableTpu: boolean;

Cluster enableTpu.

Property Value
Type Description
boolean

endpoint

public endpoint: string;

Cluster endpoint.

Property Value
Type Description
string

expireTime

public expireTime: string;

Cluster expireTime.

Property Value
Type Description
string

initialClusterVersion

public initialClusterVersion: string;

Cluster initialClusterVersion.

Property Value
Type Description
string

initialNodeCount

public initialNodeCount: number;

Cluster initialNodeCount.

Property Value
Type Description
number

instanceGroupUrls

public instanceGroupUrls: string[];

Cluster instanceGroupUrls.

Property Value
Type Description
string[]

ipAllocationPolicy

public ipAllocationPolicy?: (google.container.v1.IIPAllocationPolicy|null);

Cluster ipAllocationPolicy.

Property Value
Type Description
(google.container.v1.IIPAllocationPolicy|null)

labelFingerprint

public labelFingerprint: string;

Cluster labelFingerprint.

Property Value
Type Description
string

legacyAbac

public legacyAbac?: (google.container.v1.ILegacyAbac|null);

Cluster legacyAbac.

Property Value
Type Description
(google.container.v1.ILegacyAbac|null)

location

public location: string;

Cluster location.

Property Value
Type Description
string

locations

public locations: string[];

Cluster locations.

Property Value
Type Description
string[]

loggingService

public loggingService: string;

Cluster loggingService.

Property Value
Type Description
string

maintenancePolicy

public maintenancePolicy?: (google.container.v1.IMaintenancePolicy|null);

Cluster maintenancePolicy.

Property Value
Type Description
(google.container.v1.IMaintenancePolicy|null)

masterAuth

public masterAuth?: (google.container.v1.IMasterAuth|null);

Cluster masterAuth.

Property Value
Type Description
(google.container.v1.IMasterAuth|null)

masterAuthorizedNetworksConfig

public masterAuthorizedNetworksConfig?: (google.container.v1.IMasterAuthorizedNetworksConfig|null);

Cluster masterAuthorizedNetworksConfig.

Property Value
Type Description
(google.container.v1.IMasterAuthorizedNetworksConfig|null)

monitoringService

public monitoringService: string;

Cluster monitoringService.

Property Value
Type Description
string

name

public name: string;

Cluster name.

Property Value
Type Description
string

network

public network: string;

Cluster network.

Property Value
Type Description
string

networkConfig

public networkConfig?: (google.container.v1.INetworkConfig|null);

Cluster networkConfig.

Property Value
Type Description
(google.container.v1.INetworkConfig|null)

networkPolicy

public networkPolicy?: (google.container.v1.INetworkPolicy|null);

Cluster networkPolicy.

Property Value
Type Description
(google.container.v1.INetworkPolicy|null)

nodeConfig

public nodeConfig?: (google.container.v1.INodeConfig|null);

Cluster nodeConfig.

Property Value
Type Description
(google.container.v1.INodeConfig|null)

nodeIpv4CidrSize

public nodeIpv4CidrSize: number;

Cluster nodeIpv4CidrSize.

Property Value
Type Description
number

nodePools

public nodePools: google.container.v1.INodePool[];

Cluster nodePools.

Property Value
Type Description
google.container.v1.INodePool[]

privateClusterConfig

public privateClusterConfig?: (google.container.v1.IPrivateClusterConfig|null);

Cluster privateClusterConfig.

Property Value
Type Description
(google.container.v1.IPrivateClusterConfig|null)

releaseChannel

public releaseChannel?: (google.container.v1.IReleaseChannel|null);

Cluster releaseChannel.

Property Value
Type Description
(google.container.v1.IReleaseChannel|null)

resourceLabels

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

Cluster resourceLabels.

Property Value
Type Description
{ [k: string]: string }

resourceUsageExportConfig

public resourceUsageExportConfig?: (google.container.v1.IResourceUsageExportConfig|null);

Cluster resourceUsageExportConfig.

Property Value
Type Description
(google.container.v1.IResourceUsageExportConfig|null)

selfLink

public selfLink: string;

Cluster selfLink.

Property Value
Type Description
string

servicesIpv4Cidr

public servicesIpv4Cidr: string;

Cluster servicesIpv4Cidr.

Property Value
Type Description
string

shieldedNodes

public shieldedNodes?: (google.container.v1.IShieldedNodes|null);

Cluster shieldedNodes.

Property Value
Type Description
(google.container.v1.IShieldedNodes|null)

status

public status: (google.container.v1.Cluster.Status|keyof typeof google.container.v1.Cluster.Status);

Cluster status.

Property Value
Type Description
(google.container.v1.Cluster.Status|keyof typeof google.container.v1.Cluster.Status)

statusMessage

public statusMessage: string;

Cluster statusMessage.

Property Value
Type Description
string

subnetwork

public subnetwork: string;

Cluster subnetwork.

Property Value
Type Description
string

tpuIpv4CidrBlock

public tpuIpv4CidrBlock: string;

Cluster tpuIpv4CidrBlock.

Property Value
Type Description
string

verticalPodAutoscaling

public verticalPodAutoscaling?: (google.container.v1.IVerticalPodAutoscaling|null);

Cluster verticalPodAutoscaling.

Property Value
Type Description
(google.container.v1.IVerticalPodAutoscaling|null)

workloadIdentityConfig

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

Cluster workloadIdentityConfig.

Property Value
Type Description
(google.container.v1.IWorkloadIdentityConfig|null)

zone

public zone: string;

Cluster zone.

Property Value
Type Description
string

Methods

create(properties)

public static create(properties?: google.container.v1.ICluster): google.container.v1.Cluster;

Creates a new Cluster instance using the specified properties.

Parameter
Name Description
properties ICluster

Properties to set
Returns
Type Description
google.container.v1.Cluster

Cluster instance

decode(reader, length)

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

Decodes a Cluster message from the specified reader or buffer.

Parameters
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
google.container.v1.Cluster

Cluster

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.container.v1.Cluster;

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

Parameter
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
google.container.v1.Cluster

Cluster

encode(message, writer)

public static encode(message: google.container.v1.ICluster, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Cluster message. Does not implicitly messages.

Parameters
Name Description
message ICluster

Cluster 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.container.v1.ICluster, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ICluster

Cluster 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.container.v1.Cluster;

Creates a Cluster 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
google.container.v1.Cluster

Cluster

toJSON()

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

Converts this Cluster to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.container.v1.Cluster

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