- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.52.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.1
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.4
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.2
- 2.11.2
- 2.10.8
- 2.9.0
- 2.8.1
- 2.7.1
- 2.6.1
- 2.5.0
- 2.4.1
- 2.3.1
- 2.2.0
- 2.1.0
- 2.0.1
- 1.0.3
- 0.5.0
- 0.4.0
- 0.3.0
API documentation for container_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
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AuthenticatorGroupsConfig
Configuration for returning group information from authenticators.
AutoUpgradeOptions
AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed.
Autopilot
Autopilot is the configuration for Autopilot settings on the cluster.
AutoprovisioningNodePoolDefaults
AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
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.
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 information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs.
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
DNSConfig
DNSConfig contains the desired set of options for configuring clusterDNS.
DailyMaintenanceWindow
Time window specified for daily maintenance operations.
DatabaseEncryption
Configuration of etcd encryption.
DatapathProvider
The datapath provider selects the implementation of the Kubernetes networking model for service resolution and network policy 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 the GKE Dataplane V2
documentation <https://cloud.google.com/kubernetes-engine/docs/how-to/dataplane-v2>
__
for more.
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
EphemeralStorageLocalSsdConfig
EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSD.
FastSocket
Configuration of Fast Socket feature.
GPUSharingConfig
GPUSharingConfig represents the GPU sharing configuration for Hardware Accelerators.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
GatewayAPIConfig
GatewayAPIConfig contains the desired config of Gateway API on this cluster.
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.
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.
ILBSubsettingConfig
ILBSubsettingConfig contains the desired config of L4 Internal LoadBalancer subsetting on this cluster.
IPAllocationPolicy
Configuration for controlling how IPs are allocated in the cluster.
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 Service which allows customers to use external identity providers with the K8S API
IntraNodeVisibilityConfig
IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this 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.
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.
LocalNvmeSsdBlockConfig
LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSD.
LoggingComponentConfig
LoggingComponentConfig is cluster logging component configuration.
LoggingConfig
LoggingConfig is cluster logging configuration.
LoggingVariantConfig
LoggingVariantConfig specifies the behaviour of the logging component.
MaintenanceExclusionOptions
Represents the Maintenance exclusion option.
MaintenancePolicy
MaintenancePolicy defines the maintenance policy to be used for the cluster.
MaintenanceWindow
MaintenanceWindow defines the maintenance window to be used for the cluster.
This message has oneof
_ 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 other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
.. _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 to Kubernetes pods.
MonitoringComponentConfig
MonitoringComponentConfig is cluster monitoring component configuration.
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/
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.
.. _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.
NodeLabels
Collection of node-level Kubernetes
labels <https://kubernetes.io/docs/concepts/overview/working-with-objects/labels>
__.
NodeManagement
NodeManagement defines the set of node management services turned 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'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.
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.
NodePoolDefaults
Subset of Nodepool message that has defaults.
NodePoolLoggingConfig
NodePoolLoggingConfig specifies logging configuration for nodepools.
NodePoolUpdateStrategy
Strategy used for node pool update.
Values: NODE_POOL_UPDATE_STRATEGY_UNSPECIFIED (0): Default value. 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 comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.
See
here <https://kubernetes.io/docs/concepts/configuration/taint-and-toleration>
__
for more information, including usage and the valid values.
NodeTaints
Collection of Kubernetes node
taints <https://kubernetes.io/docs/concepts/configuration/taint-and-toleration>
__.
NotificationConfig
NotificationConfig is the configuration of notifications.
Operation
This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
OperationProgress
Information about operation (or operation stage) progress.
PrivateClusterConfig
Configuration options for private clusters.
PrivateClusterMasterGlobalAccessConfig
Configuration for controlling master global access settings.
PrivateIPv6GoogleAccess
PrivateIPv6GoogleAccess controls whether and how the pods can communicate 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 priate IPv6 access to and from Google Services
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.
ReservationAffinity
ReservationAffinity <https://cloud.google.com/compute/docs/instances/reserving-zonal-resources>
__
is the configuration of desired reservation which instances could
take capacity from.
ResourceLabels
Collection of GCP
labels <https://cloud.google.com/resource-manager/docs/creating-managing-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.
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.
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.
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.
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.
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 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).
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/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.
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, its associated network and the primary CIDR range.
UsableSubnetworkSecondaryRange
Secondary IP range of a usable subnetwork.
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.
WindowsNodeConfig
Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings
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.