Represents a Cluster.
Package
@google-cloud/container!Constructors
(constructor)(properties)
constructor(properties?: google.container.v1.ICluster);Constructs a new Cluster.
| Name | Description |
| properties |
ICluster
Properties to set |
Properties
addonsConfig
public addonsConfig?: (google.container.v1.IAddonsConfig|null);Cluster addonsConfig.
| Type | Description |
| (google.container.v1.IAddonsConfig|null) |
authenticatorGroupsConfig
public authenticatorGroupsConfig?: (google.container.v1.IAuthenticatorGroupsConfig|null);Cluster authenticatorGroupsConfig.
| Type | Description |
| (google.container.v1.IAuthenticatorGroupsConfig|null) |
autoscaling
public autoscaling?: (google.container.v1.IClusterAutoscaling|null);Cluster autoscaling.
| Type | Description |
| (google.container.v1.IClusterAutoscaling|null) |
binaryAuthorization
public binaryAuthorization?: (google.container.v1.IBinaryAuthorization|null);Cluster binaryAuthorization.
| Type | Description |
| (google.container.v1.IBinaryAuthorization|null) |
clusterIpv4Cidr
public clusterIpv4Cidr: string;Cluster clusterIpv4Cidr.
| Type | Description |
| string |
conditions
public conditions: google.container.v1.IStatusCondition[];Cluster conditions.
| Type | Description |
| google.container.v1.IStatusCondition[] |
createTime
public createTime: string;Cluster createTime.
| Type | Description |
| string |
currentMasterVersion
public currentMasterVersion: string;Cluster currentMasterVersion.
| Type | Description |
| string |
currentNodeCount
public currentNodeCount: number;Cluster currentNodeCount.
| Type | Description |
| number |
currentNodeVersion
public currentNodeVersion: string;Cluster currentNodeVersion.
| Type | Description |
| string |
databaseEncryption
public databaseEncryption?: (google.container.v1.IDatabaseEncryption|null);Cluster databaseEncryption.
| Type | Description |
| (google.container.v1.IDatabaseEncryption|null) |
defaultMaxPodsConstraint
public defaultMaxPodsConstraint?: (google.container.v1.IMaxPodsConstraint|null);Cluster defaultMaxPodsConstraint.
| Type | Description |
| (google.container.v1.IMaxPodsConstraint|null) |
description
public description: string;Cluster description.
| Type | Description |
| string |
enableKubernetesAlpha
public enableKubernetesAlpha: boolean;Cluster enableKubernetesAlpha.
| Type | Description |
| boolean |
enableTpu
public enableTpu: boolean;Cluster enableTpu.
| Type | Description |
| boolean |
endpoint
public endpoint: string;Cluster endpoint.
| Type | Description |
| string |
expireTime
public expireTime: string;Cluster expireTime.
| Type | Description |
| string |
initialClusterVersion
public initialClusterVersion: string;Cluster initialClusterVersion.
| Type | Description |
| string |
initialNodeCount
public initialNodeCount: number;Cluster initialNodeCount.
| Type | Description |
| number |
instanceGroupUrls
public instanceGroupUrls: string[];Cluster instanceGroupUrls.
| Type | Description |
| string[] |
ipAllocationPolicy
public ipAllocationPolicy?: (google.container.v1.IIPAllocationPolicy|null);Cluster ipAllocationPolicy.
| Type | Description |
| (google.container.v1.IIPAllocationPolicy|null) |
labelFingerprint
public labelFingerprint: string;Cluster labelFingerprint.
| Type | Description |
| string |
legacyAbac
public legacyAbac?: (google.container.v1.ILegacyAbac|null);Cluster legacyAbac.
| Type | Description |
| (google.container.v1.ILegacyAbac|null) |
location
public location: string;Cluster location.
| Type | Description |
| string |
locations
public locations: string[];Cluster locations.
| Type | Description |
| string[] |
loggingService
public loggingService: string;Cluster loggingService.
| Type | Description |
| string |
maintenancePolicy
public maintenancePolicy?: (google.container.v1.IMaintenancePolicy|null);Cluster maintenancePolicy.
| Type | Description |
| (google.container.v1.IMaintenancePolicy|null) |
masterAuth
public masterAuth?: (google.container.v1.IMasterAuth|null);Cluster masterAuth.
| Type | Description |
| (google.container.v1.IMasterAuth|null) |
masterAuthorizedNetworksConfig
public masterAuthorizedNetworksConfig?: (google.container.v1.IMasterAuthorizedNetworksConfig|null);Cluster masterAuthorizedNetworksConfig.
| Type | Description |
| (google.container.v1.IMasterAuthorizedNetworksConfig|null) |
monitoringService
public monitoringService: string;Cluster monitoringService.
| Type | Description |
| string |
name
public name: string;Cluster name.
| Type | Description |
| string |
network
public network: string;Cluster network.
| Type | Description |
| string |
networkConfig
public networkConfig?: (google.container.v1.INetworkConfig|null);Cluster networkConfig.
| Type | Description |
| (google.container.v1.INetworkConfig|null) |
networkPolicy
public networkPolicy?: (google.container.v1.INetworkPolicy|null);Cluster networkPolicy.
| Type | Description |
| (google.container.v1.INetworkPolicy|null) |
nodeConfig
public nodeConfig?: (google.container.v1.INodeConfig|null);Cluster nodeConfig.
| Type | Description |
| (google.container.v1.INodeConfig|null) |
nodeIpv4CidrSize
public nodeIpv4CidrSize: number;Cluster nodeIpv4CidrSize.
| Type | Description |
| number |
nodePools
public nodePools: google.container.v1.INodePool[];Cluster nodePools.
| Type | Description |
| google.container.v1.INodePool[] |
privateClusterConfig
public privateClusterConfig?: (google.container.v1.IPrivateClusterConfig|null);Cluster privateClusterConfig.
| Type | Description |
| (google.container.v1.IPrivateClusterConfig|null) |
releaseChannel
public releaseChannel?: (google.container.v1.IReleaseChannel|null);Cluster releaseChannel.
| Type | Description |
| (google.container.v1.IReleaseChannel|null) |
resourceLabels
public resourceLabels: { [k: string]: string };Cluster resourceLabels.
| Type | Description |
| { [k: string]: string } |
resourceUsageExportConfig
public resourceUsageExportConfig?: (google.container.v1.IResourceUsageExportConfig|null);Cluster resourceUsageExportConfig.
| Type | Description |
| (google.container.v1.IResourceUsageExportConfig|null) |
selfLink
public selfLink: string;Cluster selfLink.
| Type | Description |
| string |
servicesIpv4Cidr
public servicesIpv4Cidr: string;Cluster servicesIpv4Cidr.
| Type | Description |
| string |
shieldedNodes
public shieldedNodes?: (google.container.v1.IShieldedNodes|null);Cluster shieldedNodes.
| Type | Description |
| (google.container.v1.IShieldedNodes|null) |
status
public status: (google.container.v1.Cluster.Status|keyof typeof google.container.v1.Cluster.Status);Cluster status.
| Type | Description |
| (google.container.v1.Cluster.Status|keyof typeof google.container.v1.Cluster.Status) |
statusMessage
public statusMessage: string;Cluster statusMessage.
| Type | Description |
| string |
subnetwork
public subnetwork: string;Cluster subnetwork.
| Type | Description |
| string |
tpuIpv4CidrBlock
public tpuIpv4CidrBlock: string;Cluster tpuIpv4CidrBlock.
| Type | Description |
| string |
verticalPodAutoscaling
public verticalPodAutoscaling?: (google.container.v1.IVerticalPodAutoscaling|null);Cluster verticalPodAutoscaling.
| Type | Description |
| (google.container.v1.IVerticalPodAutoscaling|null) |
workloadIdentityConfig
public workloadIdentityConfig?: (google.container.v1.IWorkloadIdentityConfig|null);Cluster workloadIdentityConfig.
| Type | Description |
| (google.container.v1.IWorkloadIdentityConfig|null) |
zone
public zone: string;Cluster zone.
| 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.
| Name | Description |
| properties |
ICluster
Properties to set |
| 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.
| Name | Description |
| reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| length |
number
Message length if known beforehand |
| 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.
| Name | Description |
| reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| 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.
| Name | Description |
| message |
ICluster
Cluster message or plain object to encode |
| writer |
$protobuf.Writer
Writer to encode to |
| 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.
| Name | Description |
| message |
ICluster
Cluster message or plain object to encode |
| writer |
$protobuf.Writer
Writer to encode to |
| 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.
| Name | Description |
| object |
{ [k: string]: any }
Plain object |
| Type | Description |
| google.container.v1.Cluster | Cluster |
toJSON()
public toJSON(): { [k: string]: any };Converts this Cluster to JSON.
| 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.
| Name | Description |
| message |
google.container.v1.Cluster
Cluster |
| options |
$protobuf.IConversionOptions
Conversion options |
| Type | Description |
| { [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Cluster message.
| Name | Description |
| message |
{ [k: string]: any }
Plain object to verify |
| Type | Description |
| (string|null) |
|