Cluster

google.container.v1. Cluster

Represents a Cluster.

Constructor

new Cluster(propertiesopt)

Constructs a new Cluster.

Parameters:
Name Type Attributes Description
properties google.container.v1.ICluster <optional>

Properties to set
Implements:
  • ICluster

Members

Status

Status enum.

Properties:
Name Type Description
STATUS_UNSPECIFIED number

STATUS_UNSPECIFIED value
PROVISIONING number

PROVISIONING value
RUNNING number

RUNNING value
RECONCILING number

RECONCILING value
STOPPING number

STOPPING value
ERROR number

ERROR value
DEGRADED number

DEGRADED value

addonsConfig

Cluster addonsConfig.

authenticatorGroupsConfig

Cluster authenticatorGroupsConfig.

autoscaling

Cluster autoscaling.

binaryAuthorization

Cluster binaryAuthorization.

clusterIpv4Cidr

Cluster clusterIpv4Cidr.

conditions

Cluster conditions.

createTime

Cluster createTime.

currentMasterVersion

Cluster currentMasterVersion.

currentNodeCount

Cluster currentNodeCount.

currentNodeVersion

Cluster currentNodeVersion.

databaseEncryption

Cluster databaseEncryption.

defaultMaxPodsConstraint

Cluster defaultMaxPodsConstraint.

description

Cluster description.

enableKubernetesAlpha

Cluster enableKubernetesAlpha.

enableTpu

Cluster enableTpu.

endpoint

Cluster endpoint.

expireTime

Cluster expireTime.

initialClusterVersion

Cluster initialClusterVersion.

initialNodeCount

Cluster initialNodeCount.

instanceGroupUrls

Cluster instanceGroupUrls.

ipAllocationPolicy

Cluster ipAllocationPolicy.

labelFingerprint

Cluster labelFingerprint.

legacyAbac

Cluster legacyAbac.

location

Cluster location.

locations

Cluster locations.

loggingService

Cluster loggingService.

maintenancePolicy

Cluster maintenancePolicy.

masterAuth

Cluster masterAuth.

masterAuthorizedNetworksConfig

Cluster masterAuthorizedNetworksConfig.

monitoringService

Cluster monitoringService.

name

Cluster name.

network

Cluster network.

networkConfig

Cluster networkConfig.

networkPolicy

Cluster networkPolicy.

nodeConfig

Cluster nodeConfig.

nodeIpv4CidrSize

Cluster nodeIpv4CidrSize.

nodePools

Cluster nodePools.

privateClusterConfig

Cluster privateClusterConfig.

releaseChannel

Cluster releaseChannel.

resourceLabels

Cluster resourceLabels.

resourceUsageExportConfig

Cluster resourceUsageExportConfig.

Cluster selfLink.

servicesIpv4Cidr

Cluster servicesIpv4Cidr.

shieldedNodes

Cluster shieldedNodes.

status

Cluster status.

statusMessage

Cluster statusMessage.

subnetwork

Cluster subnetwork.

tpuIpv4CidrBlock

Cluster tpuIpv4CidrBlock.

verticalPodAutoscaling

Cluster verticalPodAutoscaling.

workloadIdentityConfig

Cluster workloadIdentityConfig.

zone

Cluster zone.

Methods

(static) create(propertiesopt) → {google.container.v1.Cluster}

Creates a new Cluster instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.container.v1.ICluster <optional>

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

Cluster instance

(static) decode(reader, lengthopt) → {google.container.v1.Cluster}

Decodes a Cluster message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
length number <optional>

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

Cluster
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.container.v1.Cluster}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

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

Cluster
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Cluster message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.container.v1.ICluster

Cluster message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.container.v1.ICluster

Cluster message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.container.v1.Cluster}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object
Returns:
Type Description
google.container.v1.Cluster

Cluster

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.container.v1.Cluster

Cluster
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Cluster message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify
Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this Cluster to JSON.

Returns:
Type Description
Object.<string, *>

JSON object