Classes
AcceleratorConfig
AcceleratorConfig represents a Hardware Accelerator request.
AddonsConfig
Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality.
AuthenticatorGroupsConfig
Configuration for returning group information from authenticators.
AutoprovisioningNodePoolDefaults
AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
AutoUpgradeOptions
AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed.
BinaryAuthorization
Configuration for Binary Authorization.
CancelOperationRequest
CancelOperationRequest cancels a single operation.
ClientCertificateConfig
Configuration for client certificates on the cluster.
CloudRunConfig
Configuration options for the Cloud Run feature.
CloudRunConfig.Types
Container for nested types declared in the CloudRunConfig message type.
Cluster
A Google Kubernetes Engine cluster.
Cluster.Types
Container for nested types declared in the Cluster message type.
ClusterAutoscaling
ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs.
ClusterManager
Google Kubernetes Engine Cluster Manager v1
ClusterManager.ClusterManagerBase
Base class for server-side implementations of ClusterManager
ClusterManager.ClusterManagerClient
Client for ClusterManager
ClusterManagerClient
ClusterManager client wrapper, for convenient use.
ClusterManagerClientBuilder
Builder class for ClusterManagerClient to provide simple configuration of credentials, endpoint etc.
ClusterManagerClientImpl
ClusterManager client wrapper implementation, for convenient use.
ClusterManagerSettings
Settings for ClusterManagerClient instances.
ClusterUpdate
ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided.
CompleteIPRotationRequest
CompleteIPRotationRequest moves the cluster master back into single-IP mode.
ConfigConnectorConfig
Configuration options for the Config Connector add-on.
CreateClusterRequest
CreateClusterRequest creates a cluster.
CreateNodePoolRequest
CreateNodePoolRequest creates a node pool for a cluster.
DailyMaintenanceWindow
Time window specified for daily maintenance operations.
DatabaseEncryption
Configuration of etcd encryption.
DatabaseEncryption.Types
Container for nested types declared in the DatabaseEncryption message type.
DefaultSnatStatus
DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster.
DeleteClusterRequest
DeleteClusterRequest deletes a cluster.
DeleteNodePoolRequest
DeleteNodePoolRequest deletes a node pool for a cluster.
DnsCacheConfig
Configuration for NodeLocal DNSCache
GetClusterRequest
GetClusterRequest gets the settings of a cluster.
GetJSONWebKeysRequest
GetJSONWebKeysRequest gets the public component of the keys used by the cluster to sign token requests. This will be the jwks_uri for the discover document returned by getOpenIDConfig. See the OpenID Connect Discovery 1.0 specification for details.
GetJSONWebKeysResponse
GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517
GetNodePoolRequest
GetNodePoolRequest retrieves a node pool for a cluster.
GetOpenIDConfigRequest
GetOpenIDConfigRequest gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.
GetOpenIDConfigResponse
GetOpenIDConfigResponse is an OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.
GetOperationRequest
GetOperationRequest gets a single operation.
GetServerConfigRequest
Gets the current Kubernetes Engine service configuration.
HorizontalPodAutoscaling
Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.
HttpLoadBalancing
Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
IntraNodeVisibilityConfig
IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster.
IPAllocationPolicy
Configuration for controlling how IPs are allocated in the cluster.
Jwk
Jwk is a JSON Web Key as specified in RFC 7517
KubernetesDashboard
Configuration for the Kubernetes Dashboard.
LegacyAbac
Configuration for the legacy Attribute Based Access Control authorization mode.
ListClustersRequest
ListClustersRequest lists clusters.
ListClustersResponse
ListClustersResponse is the result of ListClustersRequest.
ListNodePoolsRequest
ListNodePoolsRequest lists the node pool(s) for a cluster.
ListNodePoolsResponse
ListNodePoolsResponse is the result of ListNodePoolsRequest.
ListOperationsRequest
ListOperationsRequest lists operations.
ListOperationsResponse
ListOperationsResponse is the result of ListOperationsRequest.
ListUsableSubnetworksRequest
ListUsableSubnetworksRequest requests the list of usable subnetworks available to a user for creating clusters.
ListUsableSubnetworksResponse
ListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest.
MaintenancePolicy
MaintenancePolicy defines the maintenance policy to be used for the cluster.
MaintenanceWindow
MaintenanceWindow defines the maintenance window to be used for the cluster.
MasterAuth
The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates.
MasterAuthorizedNetworksConfig
Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs.
MasterAuthorizedNetworksConfig.Types
Container for nested types declared in the MasterAuthorizedNetworksConfig message type.
MasterAuthorizedNetworksConfig.Types.CidrBlock
CidrBlock contains an optional name and one CIDR block.
MaxPodsConstraint
Constraints applied to pods.
NetworkConfig
NetworkConfig reports the relative names of network & subnetwork.
NetworkPolicy
Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/
NetworkPolicy.Types
Container for nested types declared in the NetworkPolicy message type.
NetworkPolicyConfig
Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.
NodeConfig
Parameters that describe the nodes in a cluster.
NodeManagement
NodeManagement defines the set of node management services turned on for the node pool.
NodePool
NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.
NodePool.Types
Container for nested types declared in the NodePool message type.
NodePool.Types.UpgradeSettings
These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade.
maxUnavailable controls the number of nodes that can be simultaneously unavailable.
maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes.
(maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time).
Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.)
Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available.
NodePoolAutoscaling
NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage.
NodeTaint
Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.
See here for more information, including usage and the valid values.
NodeTaint.Types
Container for nested types declared in the NodeTaint message type.
Operation
This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Operation.Types
Container for nested types declared in the Operation message type.
OperationProgress
Information about operation (or operation stage) progress.
OperationProgress.Types
Container for nested types declared in the OperationProgress message type.
OperationProgress.Types.Metric
Progress metric is (string, int|float|string) pair.
PrivateClusterConfig
Configuration options for private clusters.
PrivateClusterMasterGlobalAccessConfig
Configuration for controlling master global access settings.
RecurringTimeWindow
Represents an arbitrary window of time that recurs.
ReleaseChannel
ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk.
When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled.
ReleaseChannel.Types
Container for nested types declared in the ReleaseChannel message type.
ReservationAffinity
ReservationAffinity is the configuration of desired reservation which instances could take capacity from.
ReservationAffinity.Types
Container for nested types declared in the ReservationAffinity message type.
ResourceLimit
Contains information about amount of some resource in the cluster. For memory, value should be in GB.
ResourceUsageExportConfig
Configuration for exporting cluster resource usages.
ResourceUsageExportConfig.Types
Container for nested types declared in the ResourceUsageExportConfig message type.
ResourceUsageExportConfig.Types.BigQueryDestination
Parameters for using BigQuery as the destination of resource usage export.
ResourceUsageExportConfig.Types.ConsumptionMeteringConfig
Parameters for controlling consumption metering.
RollbackNodePoolUpgradeRequest
RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.
SandboxConfig
SandboxConfig contains configurations of the sandbox to use for the node.
SandboxConfig.Types
Container for nested types declared in the SandboxConfig message type.
ServerConfig
Kubernetes Engine service configuration.
ServerConfig.Types
Container for nested types declared in the ServerConfig message type.
ServerConfig.Types.ReleaseChannelConfig
ReleaseChannelConfig exposes configuration for a release channel.
SetAddonsConfigRequest
SetAddonsConfigRequest sets the addons associated with the cluster.
SetLabelsRequest
SetLabelsRequest sets the Google Cloud Platform labels on a Google Container Engine cluster, which will in turn set them for Google Compute Engine resources used by that cluster
SetLegacyAbacRequest
SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.
SetLocationsRequest
SetLocationsRequest sets the locations of the cluster.
SetLoggingServiceRequest
SetLoggingServiceRequest sets the logging service of a cluster.
SetMaintenancePolicyRequest
SetMaintenancePolicyRequest sets the maintenance policy for a cluster.
SetMasterAuthRequest
SetMasterAuthRequest updates the admin password of a cluster.
SetMasterAuthRequest.Types
Container for nested types declared in the SetMasterAuthRequest message type.
SetMonitoringServiceRequest
SetMonitoringServiceRequest sets the monitoring service of a cluster.
SetNetworkPolicyRequest
SetNetworkPolicyRequest enables/disables network policy for a cluster.
SetNodePoolAutoscalingRequest
SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.
SetNodePoolManagementRequest
SetNodePoolManagementRequest sets the node management properties of a node pool.
SetNodePoolSizeRequest
SetNodePoolSizeRequest sets the size a node pool.
ShieldedInstanceConfig
A set of Shielded Instance options.
ShieldedNodes
Configuration of Shielded Nodes feature.
StartIPRotationRequest
StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP.
StatusCondition
StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
StatusCondition.Types
Container for nested types declared in the StatusCondition message type.
TimeWindow
Represents an arbitrary window of time.
UpdateClusterRequest
UpdateClusterRequest updates the settings of a cluster.
UpdateMasterRequest
UpdateMasterRequest updates the master of the cluster.
UpdateNodePoolRequest
UpdateNodePoolRequests update a node pool's image and/or version.
UsableSubnetwork
UsableSubnetwork resource returns the subnetwork name, its associated network and the primary CIDR range.
UsableSubnetworkSecondaryRange
Secondary IP range of a usable subnetwork.
UsableSubnetworkSecondaryRange.Types
Container for nested types declared in the UsableSubnetworkSecondaryRange message type.
VerticalPodAutoscaling
VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it.
WorkloadIdentityConfig
Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
WorkloadMetadataConfig
WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool.
WorkloadMetadataConfig.Types
Container for nested types declared in the WorkloadMetadataConfig message type.
Enums
CloudRunConfig.Types.LoadBalancerType
Load balancer type of ingress service of Cloud Run.
Cluster.Types.Status
The current status of the cluster.
DatabaseEncryption.Types.State
State of etcd encryption.
MaintenanceWindow.PolicyOneofCase
Enum of possible cases for the "policy" oneof.
NetworkPolicy.Types.Provider
Allowed Network Policy providers.
NodePool.Types.Status
The current status of the node pool instance.
NodeTaint.Types.Effect
Possible values for Effect in taint.
Operation.Types.Status
Current status of the operation.
Operation.Types.Type
Operation type.
OperationProgress.Types.Metric.ValueOneofCase
Enum of possible cases for the "value" oneof.
ReleaseChannel.Types.Channel
Possible values for 'channel'.
ReservationAffinity.Types.Type
Indicates whether to consume capacity from a reservation or not.
SandboxConfig.Types.Type
Possible types of sandboxes.
SetMasterAuthRequest.Types.Action
Operation type: what type update to perform.
StatusCondition.Types.Code
Code for each condition
UsableSubnetworkSecondaryRange.Types.Status
Status shows the current usage of a secondary IP range.
WorkloadMetadataConfig.Types.Mode
Mode is the configuration for how to expose metadata to workloads running on the node.