Package types (2.41.0)

API documentation forcontainer_v1.types package.

Classes

AcceleratorConfig

AcceleratorConfig represents a Hardware Accelerator request.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AdditionalNodeNetworkConfig

AdditionalNodeNetworkConfig is the configuration foradditional node networks within the NodeNetworkConfig message

AdditionalPodNetworkConfig

AdditionalPodNetworkConfig is the configuration foradditional pod networks within the NodeNetworkConfig message

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AdditionalPodRangesConfig

AdditionalPodRangesConfig is the configuration for additionalpod secondary ranges supporting the ClusterUpdate message.

AddonsConfig

Configuration for the addons that can be automatically spunup in the cluster, enabling additional functionality.

AdvancedDatapathObservabilityConfig

AdvancedDatapathObservabilityConfig specifies configurationof observability features of advanced datapath.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AdvancedMachineFeatures

Specifies options for controlling advanced machine features.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AuthenticatorGroupsConfig

Configuration for returning group information fromauthenticators.

AutoUpgradeOptions

AutoUpgradeOptions defines the set of options for the user tocontrol how the Auto Upgrades will proceed.

Autopilot

Autopilot is the configuration for Autopilot settings on thecluster.

AutopilotCompatibilityIssue

AutopilotCompatibilityIssue contains information about aspecific compatibility issue with Autopilot mode.

AutoprovisioningNodePoolDefaults

AutoprovisioningNodePoolDefaults contains defaults for a nodepool created by NAP.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BestEffortProvisioning

Best effort provisioning.

BinaryAuthorization

Configuration for Binary Authorization.

BlueGreenSettings

Settings for blue-green upgrade.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CancelOperationRequest

CancelOperationRequest cancels a single operation.

CheckAutopilotCompatibilityRequest

CheckAutopilotCompatibilityRequest requests getting theblockers for the given operation in the cluster.

CheckAutopilotCompatibilityResponse

CheckAutopilotCompatibilityResponse has a list ofcompatibility issues.

ClientCertificateConfig

Configuration for client certificates on the cluster.

CloudRunConfig

Configuration options for the Cloud Run feature.

Cluster

A Google Kubernetes Engine cluster.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ClusterAutoscaling

ClusterAutoscaling contains global, per-cluster informationrequired by Cluster Autoscaler to automatically adjust the sizeof the cluster and create/deletenode pools based on the current needs.

ClusterUpdate

ClusterUpdate describes an update to the cluster. Exactly oneupdate can be applied to a cluster with each request, so at mostone field can be provided.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CompleteIPRotationRequest

CompleteIPRotationRequest moves the cluster master back intosingle-IP mode.

CompleteNodePoolUpgradeRequest

CompleteNodePoolUpgradeRequest sets the name of target nodepool to complete upgrade.

ConfidentialNodes

ConfidentialNodes is configuration for the confidential nodesfeature, 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.

DNSConfig

DNSConfig contains the desired set of options for configuringclusterDNS.

DailyMaintenanceWindow

Time window specified for daily maintenance operations.

DatabaseEncryption

Configuration of etcd encryption.

DatapathProvider

The datapath provider selects the implementation of theKubernetes networking model for service resolution and networkpolicy enforcement.

Values: DATAPATH_PROVIDER_UNSPECIFIED (0): Default value. LEGACY_DATAPATH (1): Use the IPTables implementation based on kube-proxy. ADVANCED_DATAPATH (2): Use the eBPF based GKE Dataplane V2 with additional features. See theGKE Dataplane V2 documentation <https://cloud.google.com/kubernetes-engine/docs/how-to/dataplane-v2>__ for more.

DefaultSnatStatus

DefaultSnatStatus contains the desired state of whetherdefault 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

EnterpriseConfig

EnterpriseConfig is the cluster enterprise configuration.

EphemeralStorageLocalSsdConfig

EphemeralStorageLocalSsdConfig contains configuration for thenode ephemeral storage using Local SSDs.

FastSocket

Configuration of Fast Socket feature.

Fleet

Fleet is the fleet configuration for the cluster.

GPUDriverInstallationConfig

GPUDriverInstallationConfig specifies the version of GPUdriver to be auto installed.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GPUSharingConfig

GPUSharingConfig represents the GPU sharing configuration forHardware Accelerators.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GatewayAPIConfig

GatewayAPIConfig contains the desired config of Gateway APIon this cluster.

GcePersistentDiskCsiDriverConfig

Configuration for the Compute Engine PD CSI driver.

GcfsConfig

GcfsConfig contains configurations of Google Container FileSystem (image streaming).

GcpFilestoreCsiDriverConfig

Configuration for the GCP Filestore CSI driver.

GcsFuseCsiDriverConfig

Configuration for the Cloud Storage Fuse CSI driver.

GetClusterRequest

GetClusterRequest gets the settings of a cluster.

GetJSONWebKeysRequest

GetJSONWebKeysRequest gets the public component of the keys used bythe cluster to sign token requests. This will be the jwks_uri forthe discover document returned by getOpenIDConfig. See the OpenIDConnect Discovery 1.0 specification for details.

GetJSONWebKeysResponse

GetJSONWebKeysResponse is a valid JSON Web Key Set asspecififed in rfc 7517

GetNodePoolRequest

GetNodePoolRequest retrieves a node pool for a cluster.

GetOpenIDConfigRequest

GetOpenIDConfigRequest gets the OIDC discovery document forthe cluster. See the OpenID Connect Discovery 1.0 specificationfor details.

GetOpenIDConfigResponse

GetOpenIDConfigResponse is an OIDC discovery document for thecluster. See the OpenID Connect Discovery 1.0 specification fordetails.

GetOperationRequest

GetOperationRequest gets a single operation.

GetServerConfigRequest

Gets the current Kubernetes Engine service configuration.

GkeBackupAgentConfig

Configuration for the Backup for GKE Agent.

HorizontalPodAutoscaling

Configuration options for the horizontal pod autoscalingfeature, which increases or decreases the number of replica podsa replication controller has based on the resource usage of theexisting pods.

HttpLoadBalancing

Configuration options for the HTTP (L7) load balancingcontroller addon, which makes it easy to set up HTTP loadbalancers for services in a cluster.

ILBSubsettingConfig

ILBSubsettingConfig contains the desired config of L4Internal LoadBalancer subsetting on this cluster.

IPAllocationPolicy

Configuration for controlling how IPs are allocated in thecluster.

IPv6AccessType

Possible values for IPv6 access type

Values: IPV6_ACCESS_TYPE_UNSPECIFIED (0): Default value, will be defaulted as type external. INTERNAL (1): Access type internal (all v6 addresses are internal IPs) EXTERNAL (2): Access type external (all v6 addresses are external IPs)

IdentityServiceConfig

IdentityServiceConfig is configuration for Identity Servicewhich allows customers to use external identity providers withthe K8S API

InTransitEncryptionConfig

Options for in-transit encryption.

Values: IN_TRANSIT_ENCRYPTION_CONFIG_UNSPECIFIED (0): Unspecified, will be inferred as default - IN_TRANSIT_ENCRYPTION_UNSPECIFIED. IN_TRANSIT_ENCRYPTION_DISABLED (1): In-transit encryption is disabled. IN_TRANSIT_ENCRYPTION_INTER_NODE_TRANSPARENT (2): Data in-transit is encrypted using inter-node transparent encryption.

IntraNodeVisibilityConfig

IntraNodeVisibilityConfig contains the desired config of theintra-node visibility on this cluster.

Jwk

Jwk is a JSON Web Key as specified in RFC 7517

K8sBetaAPIConfig

K8sBetaAPIConfig , configuration for beta APIs

KubernetesDashboard

Configuration for the Kubernetes Dashboard.

LegacyAbac

Configuration for the legacy Attribute Based Access Controlauthorization mode.

LinuxNodeConfig

Parameters that can be configured on Linux nodes.

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

ListUsableSubnetworksRequest

ListUsableSubnetworksRequest requests the list of usablesubnetworks available to a user for creating clusters.

ListUsableSubnetworksResponse

ListUsableSubnetworksResponse is the response ofListUsableSubnetworksRequest.

LocalNvmeSsdBlockConfig

LocalNvmeSsdBlockConfig contains configuration for usingraw-block local NVMe SSDs

LoggingComponentConfig

LoggingComponentConfig is cluster logging componentconfiguration.

LoggingConfig

LoggingConfig is cluster logging configuration.

LoggingVariantConfig

LoggingVariantConfig specifies the behaviour of the loggingcomponent.

MaintenanceExclusionOptions

Represents the Maintenance exclusion option.

MaintenancePolicy

MaintenancePolicy defines the maintenance policy to be usedfor the cluster.

MaintenanceWindow

MaintenanceWindow defines the maintenance window to be usedfor the cluster.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ManagedPrometheusConfig

ManagedPrometheusConfig defines the configuration forGoogle Cloud Managed Service for Prometheus.

MasterAuth

The authentication information for accessing the masterendpoint. Authentication can be done using HTTP basic auth orusing client certificates.

MasterAuthorizedNetworksConfig

Configuration options for the master authorized networksfeature. Enabled master authorized networks will disallow allexternal traffic to access Kubernetes master through HTTPSexcept traffic from the given CIDR blocks, Google Compute EnginePublic IPs and Google Prod IPs.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

MaxPodsConstraint

Constraints applied to pods.

MeshCertificates

Configuration for issuance of mTLS keys and certificates toKubernetes pods.

MonitoringComponentConfig

MonitoringComponentConfig is cluster monitoring componentconfiguration.

MonitoringConfig

MonitoringConfig is cluster monitoring configuration.

NetworkConfig

NetworkConfig reports the relative names of network &subnetwork.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

NetworkPolicy

Configuration options for the NetworkPolicy feature.https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

NetworkPolicyConfig

Configuration for NetworkPolicy. This only tracks whether theaddon is enabled or not on the Master, it does not track whethernetwork policy is enabled for the nodes.

NetworkTags

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

NodeConfig

Parameters that describe the nodes in a cluster.

GKE Autopilot clusters do not recognize parameters inNodeConfig. UseAutoprovisioningNodePoolDefaults][google.container.v1.AutoprovisioningNodePoolDefaults]instead.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

NodeConfigDefaults

Subset of NodeConfig message that has defaults.

NodeKubeletConfig

Node kubelet configs.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

NodeLabels

Collection of node-levelKuberneteslabels <https://kubernetes.io/docs/concepts/overview/working-with-objects/labels>__.

NodeManagement

NodeManagement defines the set of node management servicesturned on for the node pool.

NodeNetworkConfig

Parameters for node pool-level network config.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

NodePool

NodePool contains the name and configuration for a cluster'snode pool. Node pools are a set of nodes (i.e. VM's), with acommon configuration and specification, under the control of thecluster master. They may have a set of Kubernetes labels appliedto them, which may be used to reference them during podscheduling. They may also be resized up or down, to accommodatethe workload.

NodePoolAutoConfig

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

NodePoolAutoscaling

NodePoolAutoscaling contains information required by clusterautoscaler to adjust the size of the node pool to the currentcluster usage.

NodePoolDefaults

Subset of Nodepool message that has defaults.

NodePoolLoggingConfig

NodePoolLoggingConfig specifies logging configuration fornodepools.

NodePoolUpdateStrategy

Strategy used for node pool update.

Values: NODE_POOL_UPDATE_STRATEGY_UNSPECIFIED (0): Default value if unset. GKE internally defaults the update strategy to SURGE for unspecified strategies. BLUE_GREEN (2): blue-green upgrade. SURGE (3): SURGE is the traditional way of upgrade a node pool. max_surge and max_unavailable determines the level of upgrade parallelism.

NodeTaint

Kubernetes taint is composed of three fields: key, value, andeffect. Effect can only be one of three types: NoSchedule,PreferNoSchedule or NoExecute.

Seehere <https://kubernetes.io/docs/concepts/configuration/taint-and-toleration>__for more information, including usage and the valid values.

NodeTaints

Collection of Kubernetesnodetaints <https://kubernetes.io/docs/concepts/configuration/taint-and-toleration>__.

NotificationConfig

NotificationConfig is the configuration of notifications.

Operation

This operation resource represents operations that may havehappened or are happening on the cluster. All fields are outputonly.

OperationProgress

Information about operation (or operation stage) progress.

PodCIDROverprovisionConfig

[PRIVATE FIELD] Config for pod CIDR size overprovisioning.

PrivateClusterConfig

Configuration options for private clusters.

PrivateClusterMasterGlobalAccessConfig

Configuration for controlling master global access settings.

PrivateIPv6GoogleAccess

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

Values: PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED (0): Default value. Same as DISABLED PRIVATE_IPV6_GOOGLE_ACCESS_DISABLED (1): No private access to or from Google Services PRIVATE_IPV6_GOOGLE_ACCESS_TO_GOOGLE (2): Enables private IPv6 access to Google Services from GKE PRIVATE_IPV6_GOOGLE_ACCESS_BIDIRECTIONAL (3): Enables private IPv6 access to and from Google Services

RangeInfo

RangeInfo contains the range name and the range utilizationby this cluster.

RecurringTimeWindow

Represents an arbitrary window of time that recurs.

ReleaseChannel

ReleaseChannel indicates which release channel a cluster issubscribed to. Release channels are arranged in order of risk.

When a cluster is subscribed to a release channel, Googlemaintains both the master version and the node version. Nodeauto-upgrade defaults to true and cannot be disabled.

ReservationAffinity

ReservationAffinity <https://cloud.google.com/compute/docs/instances/reserving-zonal-resources>__is the configuration of desired reservation which instances couldtake capacity from.

ResourceLabels

Collection ofGCPlabels <https://cloud.google.com/resource-manager/docs/creating-managing-labels>__.

ResourceLimit

Contains information about amount of some resource in thecluster. For memory, value should be in GB.

ResourceManagerTags

A map of resource manager tag keys and values to be attachedto the nodes for managing Compute Engine firewalls using NetworkFirewall Policies. Tags must be according to specifications inhttps://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications.A maximum of 5 tag key-value pairs can be specified. Existingtags will be replaced with new values.

ResourceUsageExportConfig

Configuration for exporting cluster resource usages.

RollbackNodePoolUpgradeRequest

RollbackNodePoolUpgradeRequest rollbacks the previouslyAborted or Failed NodePool upgrade. This will be an no-op if thelast upgrade successfully completed.

SandboxConfig

SandboxConfig contains configurations of the sandbox to usefor the node.

SecurityBulletinEvent

SecurityBulletinEvent is a notification sent to customerswhen a security bulletin has been posted that they arevulnerable to.

SecurityPostureConfig

SecurityPostureConfig defines the flags needed toenable/disable features for the Security Posture API.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ServerConfig

Kubernetes Engine service configuration.

ServiceExternalIPsConfig

Config to block services with externalIPs field.

SetAddonsConfigRequest

SetAddonsConfigRequest sets the addons associated with thecluster.

SetLabelsRequest

SetLabelsRequest sets the Google Cloud Platform labels on aGoogle Container Engine cluster, which will in turn set them forGoogle Compute Engine resources used by that cluster

SetLegacyAbacRequest

SetLegacyAbacRequest enables or disables the ABACauthorization mechanism for a cluster.

SetLocationsRequest

SetLocationsRequest sets the locations of the cluster.

SetLoggingServiceRequest

SetLoggingServiceRequest sets the logging service of acluster.

SetMaintenancePolicyRequest

SetMaintenancePolicyRequest sets the maintenance policy for acluster.

SetMasterAuthRequest

SetMasterAuthRequest updates the admin password of a cluster.

SetMonitoringServiceRequest

SetMonitoringServiceRequest sets the monitoring service of acluster.

SetNetworkPolicyRequest

SetNetworkPolicyRequest enables/disables network policy for acluster.

SetNodePoolAutoscalingRequest

SetNodePoolAutoscalingRequest sets the autoscaler settings ofa node pool.

SetNodePoolManagementRequest

SetNodePoolManagementRequest sets the node managementproperties 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.

SoleTenantConfig

SoleTenantConfig contains the NodeAffinities to specify whatshared sole tenant node groups should back the node pool.

StackType

Possible values for IP stack type

Values: STACK_TYPE_UNSPECIFIED (0): Default value, will be defaulted as IPV4 only IPV4 (1): Cluster is IPV4 only IPV4_IPV6 (2): Cluster can use both IPv4 and IPv6

StartIPRotationRequest

StartIPRotationRequest creates a new IP for the cluster andthen performs a node upgrade on each node pool to point to thenew IP.

StatefulHAConfig

Configuration for the Stateful HA add-on.

StatusCondition

StatusCondition describes why a cluster or a node pool has acertain status (e.g., ERROR or DEGRADED).

TimeWindow

Represents an arbitrary window of time.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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/orversion.

UpgradeAvailableEvent

UpgradeAvailableEvent is a notification sent to customerswhen a new available version is released.

UpgradeEvent

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

UpgradeResourceType

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

Values: UPGRADE_RESOURCE_TYPE_UNSPECIFIED (0): Default value. This shouldn't be used. MASTER (1): Master / control plane NODE_POOL (2): Node pool

UsableSubnetwork

UsableSubnetwork resource returns the subnetwork name, itsassociated network and the primary CIDR range.

UsableSubnetworkSecondaryRange

Secondary IP range of a usable subnetwork.

VerticalPodAutoscaling

VerticalPodAutoscaling contains global, per-clusterinformation required by Vertical Pod Autoscaler to automaticallyadjust the resources of pods controlled by it.

VirtualNIC

Configuration of gVNIC feature.

WindowsNodeConfig

Parameters that can be configured on Windows nodes.Windows Node Config that define the parameters that will be usedto configure the Windows node pool settings

WorkloadIdentityConfig

Configuration for the use of Kubernetes Service Accounts inGCP IAM policies.

WorkloadMetadataConfig

WorkloadMetadataConfig defines the metadata configuration toexpose to workloads on the node pool.

WorkloadPolicyConfig

WorkloadPolicyConfig is the configuration of workload policyfor autopilot clusters.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-01-10 UTC.