Google Kubernetes Engine v1 API - Namespace Google.Cloud.Container.V1 (3.5.0)

Stay organized with collections Save and categorize content based on your preferences.

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.

AdvancedMachineFeatures

Specifies options for controlling advanced machine features.

AuthenticatorGroupsConfig

Configuration for returning group information from authenticators.

Autopilot

Autopilot is the configuration for Autopilot settings on the cluster.

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.

BinaryAuthorization.Types

Container for nested types declared in the BinaryAuthorization message type.

BlueGreenSettings

Settings for blue-green upgrade.

BlueGreenSettings.Types

Container for nested types declared in the BlueGreenSettings message type.

BlueGreenSettings.Types.StandardRolloutPolicy

Standard rollout policy is the default policy for blue-green.

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.

ClusterAutoscaling.Types

Container for nested types declared in the ClusterAutoscaling message type.

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.

CompleteNodePoolUpgradeRequest

CompleteNodePoolUpgradeRequest sets the name of target node pool to complete upgrade.

ConfidentialNodes

ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs.

ConfigConnectorConfig

Configuration options for the Config Connector add-on.

CostManagementConfig

Configuration for fine-grained cost management feature.

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

DNSConfig

DNSConfig contains the desired set of options for configuring clusterDNS.

DNSConfig.Types

Container for nested types declared in the DNSConfig message type.

GatewayAPIConfig

GatewayAPIConfig contains the desired config of Gateway API on this cluster.

GatewayAPIConfig.Types

Container for nested types declared in the GatewayAPIConfig message type.

GcePersistentDiskCsiDriverConfig

Configuration for the Compute Engine PD CSI driver.

GcfsConfig

GcfsConfig contains configurations of Google Container File System (image streaming).

GcpFilestoreCsiDriverConfig

Configuration for the GCP Filestore CSI driver.

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.

GkeBackupAgentConfig

Configuration for the Backup for GKE Agent.

GPUSharingConfig

GPUSharingConfig represents the GPU sharing configuration for Hardware Accelerators.

GPUSharingConfig.Types

Container for nested types declared in the GPUSharingConfig message type.

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.

IdentityServiceConfig

IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API

ILBSubsettingConfig

ILBSubsettingConfig contains the desired config of L4 Internal LoadBalancer subsetting on this 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.

LinuxNodeConfig

Parameters that can be configured on Linux nodes.

LinuxNodeConfig.Types

Container for nested types declared in the LinuxNodeConfig message type.

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.

LoggingComponentConfig

LoggingComponentConfig is cluster logging component configuration.

LoggingComponentConfig.Types

Container for nested types declared in the LoggingComponentConfig message type.

LoggingConfig

LoggingConfig is cluster logging configuration.

LoggingVariantConfig

LoggingVariantConfig specifies the behaviour of the logging component.

LoggingVariantConfig.Types

Container for nested types declared in the LoggingVariantConfig message type.

MaintenanceExclusionOptions

Represents the Maintenance exclusion option.

MaintenanceExclusionOptions.Types

Container for nested types declared in the MaintenanceExclusionOptions message type.

MaintenancePolicy

MaintenancePolicy defines the maintenance policy to be used for the cluster.

MaintenanceWindow

MaintenanceWindow defines the maintenance window to be used for the cluster.

ManagedPrometheusConfig

ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus.

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.

MeshCertificates

Configuration for issuance of mTLS keys and certificates to Kubernetes pods.

MonitoringComponentConfig

MonitoringComponentConfig is cluster monitoring component configuration.

MonitoringComponentConfig.Types

Container for nested types declared in the MonitoringComponentConfig message type.

MonitoringConfig

MonitoringConfig is cluster monitoring configuration.

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.

NetworkTags

Collection of Compute Engine network tags that can be applied to a node's underlying VM instance.

NodeConfig

Parameters that describe the nodes in a cluster.

GKE Autopilot clusters do not recognize parameters in NodeConfig. Use [AutoprovisioningNodePoolDefaults][google.container.v1.AutoprovisioningNodePoolDefaults] instead.

NodeConfigDefaults

Subset of NodeConfig message that has defaults.

NodeKubeletConfig

Node kubelet configs.

NodeLabels

Collection of node-level Kubernetes labels.

NodeManagement

NodeManagement defines the set of node management services turned on for the node pool.

NodeNetworkConfig

Parameters for node pool-level network config.

NodeNetworkConfig.Types

Container for nested types declared in the NodeNetworkConfig message type.

NodeNetworkConfig.Types.NetworkPerformanceConfig

Configuration of all network bandwidth tiers

NodeNetworkConfig.Types.NetworkPerformanceConfig.Types

Container for nested types declared in the NetworkPerformanceConfig message type.

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.UpdateInfo

UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade.

NodePool.Types.UpdateInfo.Types

Container for nested types declared in the UpdateInfo message type.

NodePool.Types.UpdateInfo.Types.BlueGreenInfo

Information relevant to blue-green upgrade.

NodePool.Types.UpdateInfo.Types.BlueGreenInfo.Types

Container for nested types declared in the BlueGreenInfo 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.

These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool.

If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade.

  1. 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.
  2. maxUnavailable controls the number of nodes that can be simultaneously unavailable.
  3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time).

If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings.

  1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained.
  2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted.

NodePoolAutoConfig

Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

NodePoolAutoscaling

NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage.

NodePoolAutoscaling.Types

Container for nested types declared in the NodePoolAutoscaling message type.

NodePoolDefaults

Subset of Nodepool message that has defaults.

NodePoolLoggingConfig

NodePoolLoggingConfig specifies logging configuration for nodepools.

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.

NodeTaints

Collection of Kubernetes node taints.

NotificationConfig

NotificationConfig is the configuration of notifications.

NotificationConfig.Types

Container for nested types declared in the NotificationConfig message type.

NotificationConfig.Types.Filter

Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent

NotificationConfig.Types.PubSub

Pub/Sub specific notification config.

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.

ResourceLabels

Collection of GCP labels.

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.

SecurityBulletinEvent

SecurityBulletinEvent is a notification sent to customers when a security bulletin has been posted that they are vulnerable to.

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.

ServiceExternalIPsConfig

Config to block services with externalIPs field.

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 of 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.

TopicName

Resource name for the Topic resource.

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.

UpgradeAvailableEvent

UpgradeAvailableEvent is a notification sent to customers when a new available version is released.

UpgradeEvent

UpgradeEvent is a notification sent to customers by the cluster server when a resource is upgrading.

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.

VirtualNIC

Configuration of gVNIC feature.

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

BinaryAuthorization.Types.EvaluationMode

Binary Authorization mode of operation.

BlueGreenSettings.RolloutPolicyOneofCase

Enum of possible cases for the "rollout_policy" oneof.

BlueGreenSettings.Types.StandardRolloutPolicy.UpdateBatchSizeOneofCase

Enum of possible cases for the "update_batch_size" oneof.

CloudRunConfig.Types.LoadBalancerType

Load balancer type of ingress service of Cloud Run.

Cluster.Types.Status

The current status of the cluster.

ClusterAutoscaling.Types.AutoscalingProfile

Defines possible options for autoscaling_profile field.

DatabaseEncryption.Types.State

State of etcd encryption.

DatapathProvider

The datapath provider selects the implementation of the Kubernetes networking model for service resolution and network policy enforcement.

DNSConfig.Types.DNSScope

DNSScope lists the various scopes of access to cluster DNS records.

DNSConfig.Types.Provider

Provider lists the various in-cluster DNS providers.

GatewayAPIConfig.Types.Channel

Channel describes if/how Gateway API should be installed and implemented in a cluster.

GPUSharingConfig.Types.GPUSharingStrategy

The type of GPU sharing strategy currently provided.

IPv6AccessType

Possible values for IPv6 access type

LinuxNodeConfig.Types.CgroupMode

Possible cgroup modes that can be used.

LoggingComponentConfig.Types.Component

GKE components exposing logs

LoggingVariantConfig.Types.Variant

Logging component variants.

MaintenanceExclusionOptions.Types.Scope

Scope of exclusion.

MaintenanceWindow.PolicyOneofCase

Enum of possible cases for the "policy" oneof.

MonitoringComponentConfig.Types.Component

GKE components exposing metrics

NetworkPolicy.Types.Provider

Allowed Network Policy providers.

NodeNetworkConfig.Types.NetworkPerformanceConfig.Types.Tier

Node network tier

NodePool.Types.Status

The current status of the node pool instance.

NodePool.Types.UpdateInfo.Types.BlueGreenInfo.Types.Phase

Phase represents the different stages blue-green upgrade is running in.

NodePoolAutoscaling.Types.LocationPolicy

Location policy specifies how zones are picked when scaling up the nodepool.

NodePoolUpdateStrategy

Strategy used for node pool update.

NodeTaint.Types.Effect

Possible values for Effect in taint.

NotificationConfig.Types.EventType

Types of notifications currently supported. Can be used to filter what notifications are sent.

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.

PrivateIPv6GoogleAccess

PrivateIPv6GoogleAccess controls whether and how the pods can communicate with Google Services through gRPC over IPv6.

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.

StackType

Possible values for IP stack type

StatusCondition.Types.Code

Code for each condition

TimeWindow.OptionsOneofCase

Enum of possible cases for the "options" oneof.

TopicName.ResourceNameType

The possible contents of TopicName.

UpgradeResourceType

UpgradeResourceType is the resource type that is upgrading. It is used in upgrade notifications.

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.