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

(static) Status :number

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 :google.container.v1.IAddonsConfig|null|undefined

Cluster addonsConfig.

authenticatorGroupsConfig :google.container.v1.IAuthenticatorGroupsConfig|null|undefined

Cluster authenticatorGroupsConfig.

autoscaling :google.container.v1.IClusterAutoscaling|null|undefined

Cluster autoscaling.

binaryAuthorization :google.container.v1.IBinaryAuthorization|null|undefined

Cluster binaryAuthorization.

clusterIpv4Cidr :string

Cluster clusterIpv4Cidr.

conditions :Array.<google.container.v1.IStatusCondition>

Cluster conditions.

createTime :string

Cluster createTime.

currentMasterVersion :string

Cluster currentMasterVersion.

currentNodeCount :number

Cluster currentNodeCount.

currentNodeVersion :string

Cluster currentNodeVersion.

databaseEncryption :google.container.v1.IDatabaseEncryption|null|undefined

Cluster databaseEncryption.

defaultMaxPodsConstraint :google.container.v1.IMaxPodsConstraint|null|undefined

Cluster defaultMaxPodsConstraint.

description :string

Cluster description.

enableKubernetesAlpha :boolean

Cluster enableKubernetesAlpha.

enableTpu :boolean

Cluster enableTpu.

endpoint :string

Cluster endpoint.

expireTime :string

Cluster expireTime.

initialClusterVersion :string

Cluster initialClusterVersion.

initialNodeCount :number

Cluster initialNodeCount.

instanceGroupUrls :Array.<string>

Cluster instanceGroupUrls.

ipAllocationPolicy :google.container.v1.IIPAllocationPolicy|null|undefined

Cluster ipAllocationPolicy.

labelFingerprint :string

Cluster labelFingerprint.

legacyAbac :google.container.v1.ILegacyAbac|null|undefined

Cluster legacyAbac.

location :string

Cluster location.

locations :Array.<string>

Cluster locations.

loggingService :string

Cluster loggingService.

maintenancePolicy :google.container.v1.IMaintenancePolicy|null|undefined

Cluster maintenancePolicy.

masterAuth :google.container.v1.IMasterAuth|null|undefined

Cluster masterAuth.

masterAuthorizedNetworksConfig :google.container.v1.IMasterAuthorizedNetworksConfig|null|undefined

Cluster masterAuthorizedNetworksConfig.

monitoringService :string

Cluster monitoringService.

name :string

Cluster name.

network :string

Cluster network.

networkConfig :google.container.v1.INetworkConfig|null|undefined

Cluster networkConfig.

networkPolicy :google.container.v1.INetworkPolicy|null|undefined

Cluster networkPolicy.

nodeConfig :google.container.v1.INodeConfig|null|undefined

Cluster nodeConfig.

nodeIpv4CidrSize :number

Cluster nodeIpv4CidrSize.

nodePools :Array.<google.container.v1.INodePool>

Cluster nodePools.

privateClusterConfig :google.container.v1.IPrivateClusterConfig|null|undefined

Cluster privateClusterConfig.

resourceLabels :Object.<string, string>

Cluster resourceLabels.

resourceUsageExportConfig :google.container.v1.IResourceUsageExportConfig|null|undefined

Cluster resourceUsageExportConfig.

Cluster selfLink.

servicesIpv4Cidr :string

Cluster servicesIpv4Cidr.

status :google.container.v1.Cluster.Status

Cluster status.

statusMessage :string

Cluster statusMessage.

subnetwork :string

Cluster subnetwork.

tpuIpv4CidrBlock :string

Cluster tpuIpv4CidrBlock.

verticalPodAutoscaling :google.container.v1.IVerticalPodAutoscaling|null|undefined

Cluster verticalPodAutoscaling.

zone :string

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

(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

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

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

(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

(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

(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

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

Verifies a Cluster message.

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

Plain object to verify

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

Converts this Cluster to JSON.