Represents a Cluster.
Package
@google-cloud/containerConstructors
(constructor)(properties)
constructor(properties?: google.container.v1beta1.ICluster);Constructs a new Cluster.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICluster
Properties to set |
Properties
_nodePoolDefaults
public _nodePoolDefaults?: "nodePoolDefaults";Cluster _nodePoolDefaults.
_protectConfig
public _protectConfig?: "protectConfig";Cluster _protectConfig.
addonsConfig
public addonsConfig?: (google.container.v1beta1.IAddonsConfig|null);Cluster addonsConfig.
authenticatorGroupsConfig
public authenticatorGroupsConfig?: (google.container.v1beta1.IAuthenticatorGroupsConfig|null);Cluster authenticatorGroupsConfig.
autopilot
public autopilot?: (google.container.v1beta1.IAutopilot|null);Cluster autopilot.
autoscaling
public autoscaling?: (google.container.v1beta1.IClusterAutoscaling|null);Cluster autoscaling.
binaryAuthorization
public binaryAuthorization?: (google.container.v1beta1.IBinaryAuthorization|null);Cluster binaryAuthorization.
clusterIpv4Cidr
public clusterIpv4Cidr: string;Cluster clusterIpv4Cidr.
clusterTelemetry
public clusterTelemetry?: (google.container.v1beta1.IClusterTelemetry|null);Cluster clusterTelemetry.
conditions
public conditions: google.container.v1beta1.IStatusCondition[];Cluster conditions.
confidentialNodes
public confidentialNodes?: (google.container.v1beta1.IConfidentialNodes|null);Cluster confidentialNodes.
costManagementConfig
public costManagementConfig?: (google.container.v1beta1.ICostManagementConfig|null);Cluster costManagementConfig.
createTime
public createTime: string;Cluster createTime.
currentMasterVersion
public currentMasterVersion: string;Cluster currentMasterVersion.
currentNodeCount
public currentNodeCount: number;Cluster currentNodeCount.
currentNodeVersion
public currentNodeVersion: string;Cluster currentNodeVersion.
databaseEncryption
public databaseEncryption?: (google.container.v1beta1.IDatabaseEncryption|null);Cluster databaseEncryption.
defaultMaxPodsConstraint
public defaultMaxPodsConstraint?: (google.container.v1beta1.IMaxPodsConstraint|null);Cluster defaultMaxPodsConstraint.
description
public description: string;Cluster description.
enableKubernetesAlpha
public enableKubernetesAlpha: boolean;Cluster enableKubernetesAlpha.
enableTpu
public enableTpu: boolean;Cluster enableTpu.
endpoint
public endpoint: string;Cluster endpoint.
etag
public etag: string;Cluster etag.
expireTime
public expireTime: string;Cluster expireTime.
fleet
public fleet?: (google.container.v1beta1.IFleet|null);Cluster fleet.
id
public id: string;Cluster id.
identityServiceConfig
public identityServiceConfig?: (google.container.v1beta1.IIdentityServiceConfig|null);Cluster identityServiceConfig.
initialClusterVersion
public initialClusterVersion: string;Cluster initialClusterVersion.
initialNodeCount
public initialNodeCount: number;Cluster initialNodeCount.
instanceGroupUrls
public instanceGroupUrls: string[];Cluster instanceGroupUrls.
ipAllocationPolicy
public ipAllocationPolicy?: (google.container.v1beta1.IIPAllocationPolicy|null);Cluster ipAllocationPolicy.
labelFingerprint
public labelFingerprint: string;Cluster labelFingerprint.
legacyAbac
public legacyAbac?: (google.container.v1beta1.ILegacyAbac|null);Cluster legacyAbac.
location
public location: string;Cluster location.
locations
public locations: string[];Cluster locations.
loggingConfig
public loggingConfig?: (google.container.v1beta1.ILoggingConfig|null);Cluster loggingConfig.
loggingService
public loggingService: string;Cluster loggingService.
maintenancePolicy
public maintenancePolicy?: (google.container.v1beta1.IMaintenancePolicy|null);Cluster maintenancePolicy.
master
public master?: (google.container.v1beta1.IMaster|null);Cluster master.
masterAuth
public masterAuth?: (google.container.v1beta1.IMasterAuth|null);Cluster masterAuth.
masterAuthorizedNetworksConfig
public masterAuthorizedNetworksConfig?: (google.container.v1beta1.IMasterAuthorizedNetworksConfig|null);Cluster masterAuthorizedNetworksConfig.
masterIpv4CidrBlock
public masterIpv4CidrBlock: string;Cluster masterIpv4CidrBlock.
meshCertificates
public meshCertificates?: (google.container.v1beta1.IMeshCertificates|null);Cluster meshCertificates.
monitoringConfig
public monitoringConfig?: (google.container.v1beta1.IMonitoringConfig|null);Cluster monitoringConfig.
monitoringService
public monitoringService: string;Cluster monitoringService.
name
public name: string;Cluster name.
network
public network: string;Cluster network.
networkConfig
public networkConfig?: (google.container.v1beta1.INetworkConfig|null);Cluster networkConfig.
networkPolicy
public networkPolicy?: (google.container.v1beta1.INetworkPolicy|null);Cluster networkPolicy.
nodeConfig
public nodeConfig?: (google.container.v1beta1.INodeConfig|null);Cluster nodeConfig.
nodeIpv4CidrSize
public nodeIpv4CidrSize: number;Cluster nodeIpv4CidrSize.
nodePoolAutoConfig
public nodePoolAutoConfig?: (google.container.v1beta1.INodePoolAutoConfig|null);Cluster nodePoolAutoConfig.
nodePoolDefaults
public nodePoolDefaults?: (google.container.v1beta1.INodePoolDefaults|null);Cluster nodePoolDefaults.
nodePools
public nodePools: google.container.v1beta1.INodePool[];Cluster nodePools.
notificationConfig
public notificationConfig?: (google.container.v1beta1.INotificationConfig|null);Cluster notificationConfig.
podSecurityPolicyConfig
public podSecurityPolicyConfig?: (google.container.v1beta1.IPodSecurityPolicyConfig|null);Cluster podSecurityPolicyConfig.
privateCluster
public privateCluster: boolean;Cluster privateCluster.
privateClusterConfig
public privateClusterConfig?: (google.container.v1beta1.IPrivateClusterConfig|null);Cluster privateClusterConfig.
protectConfig
public protectConfig?: (google.container.v1beta1.IProtectConfig|null);Cluster protectConfig.
releaseChannel
public releaseChannel?: (google.container.v1beta1.IReleaseChannel|null);Cluster releaseChannel.
resourceLabels
public resourceLabels: { [k: string]: string };Cluster resourceLabels.
resourceUsageExportConfig
public resourceUsageExportConfig?: (google.container.v1beta1.IResourceUsageExportConfig|null);Cluster resourceUsageExportConfig.
selfLink
public selfLink: string;Cluster selfLink.
servicesIpv4Cidr
public servicesIpv4Cidr: string;Cluster servicesIpv4Cidr.
shieldedNodes
public shieldedNodes?: (google.container.v1beta1.IShieldedNodes|null);Cluster shieldedNodes.
status
public status: (google.container.v1beta1.Cluster.Status|keyof typeof google.container.v1beta1.Cluster.Status);Cluster status.
statusMessage
public statusMessage: string;Cluster statusMessage.
subnetwork
public subnetwork: string;Cluster subnetwork.
tpuConfig
public tpuConfig?: (google.container.v1beta1.ITpuConfig|null);Cluster tpuConfig.
tpuIpv4CidrBlock
public tpuIpv4CidrBlock: string;Cluster tpuIpv4CidrBlock.
verticalPodAutoscaling
public verticalPodAutoscaling?: (google.container.v1beta1.IVerticalPodAutoscaling|null);Cluster verticalPodAutoscaling.
workloadAltsConfig
public workloadAltsConfig?: (google.container.v1beta1.IWorkloadALTSConfig|null);Cluster workloadAltsConfig.
workloadCertificates
public workloadCertificates?: (google.container.v1beta1.IWorkloadCertificates|null);Cluster workloadCertificates.
workloadIdentityConfig
public workloadIdentityConfig?: (google.container.v1beta1.IWorkloadIdentityConfig|null);Cluster workloadIdentityConfig.
zone
public zone: string;Cluster zone.
Methods
create(properties)
public static create(properties?: google.container.v1beta1.ICluster): google.container.v1beta1.Cluster;Creates a new Cluster instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICluster
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.container.v1beta1.Cluster | Cluster instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.container.v1beta1.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.v1beta1.Cluster | Cluster |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.container.v1beta1.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.v1beta1.Cluster | Cluster |
encode(message, writer)
public static encode(message: google.container.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.Cluster | Cluster |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Cluster
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
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.v1beta1.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.v1beta1.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) |
|