container.v1 library Null safety

Kubernetes Engine API - v1

Builds and manages container-based applications, powered by the open source Kubernetes technology.

For more information, see cloud.google.com/container-engine/

Create an instance of ContainerApi to access these resources:

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.
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.
BigQueryDestination
Parameters for using BigQuery as the destination of resource usage export.
BinaryAuthorization
Configuration for Binary Authorization.
CancelOperationRequest
CancelOperationRequest cancels a single operation.
CidrBlock
CidrBlock contains an optional name and one CIDR block.
ClientCertificateConfig
Configuration for client certificates on the cluster.
CloudRunConfig
Configuration options for the Cloud Run feature.
Cluster
A Google Kubernetes Engine cluster.
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. [...]
CompleteIPRotationRequest
CompleteIPRotationRequest moves the cluster master back into single-IP mode.
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.
ConsumptionMeteringConfig
Parameters for controlling consumption metering.
ContainerApi
Builds and manages container-based applications, powered by the open source Kubernetes technology.
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.
DefaultSnatStatus
DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster.
DnsCacheConfig
Configuration for NodeLocal DNSCache
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. [...]
GcePersistentDiskCsiDriverConfig
Configuration for the Compute Engine PD CSI driver.
GcpFilestoreCsiDriverConfig
Configuration for the GCP Filestore CSI driver.
GetJSONWebKeysResponse
GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517
GetOpenIDConfigResponse
GetOpenIDConfigResponse is an OIDC discovery document for the cluster. [...]
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.
HttpCacheControlResponseHeader
RFC-2616: cache control support
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.
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.
ListClustersResponse
ListClustersResponse is the result of ListClustersRequest.
ListNodePoolsResponse
ListNodePoolsResponse is the result of ListNodePoolsRequest.
ListOperationsResponse
ListOperationsResponse is the result of ListOperationsRequest.
ListUsableSubnetworksResponse
ListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest.
LoggingComponentConfig
LoggingComponentConfig is cluster logging component configuration.
LoggingConfig
LoggingConfig is cluster logging configuration.
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. [...]
MasterAuthorizedNetworksConfig
Configuration options for the master authorized networks feature. [...]
MaxPodsConstraint
Constraints applied to pods.
Metric
Progress metric is (string, int|float|string) pair.
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. [...]
NetworkPolicyConfig
Configuration for NetworkPolicy. [...]
NodeConfig
Parameters that describe the nodes in a cluster.
NodeKubeletConfig
Node kubelet configs.
NodeManagement
NodeManagement defines the set of node management services turned on for the node pool.
NodeNetworkConfig
Parameters for node pool-level network config.
NodePool
NodePool contains the name and configuration for a cluster's node pool. [...]
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. [...]
NotificationConfig
NotificationConfig is the configuration of notifications.
Operation
This operation resource represents operations that may have happened or are happening on the cluster. [...]
OperationProgress
Information about operation (or operation stage) progress.
PrivateClusterConfig
Configuration options for private clusters.
PrivateClusterMasterGlobalAccessConfig
Configuration for controlling master global access settings.
ProjectsAggregatedResource
ProjectsAggregatedUsableSubnetworksResource
ProjectsLocationsClustersNodePoolsResource
ProjectsLocationsClustersResource
ProjectsLocationsClustersWellKnownResource
ProjectsLocationsOperationsResource
ProjectsLocationsResource
ProjectsResource
ProjectsZonesClustersNodePoolsResource
ProjectsZonesClustersResource
ProjectsZonesOperationsResource
ProjectsZonesResource
PubSub
Pub/Sub specific notification config.
RecurringTimeWindow
Represents an arbitrary window of time that recurs.
ReleaseChannel
ReleaseChannel indicates which release channel a cluster is subscribed to. [...]
ReleaseChannelConfig
ReleaseChannelConfig exposes configuration for a release channel.
ReservationAffinity
ReservationAffinity is the configuration of desired reservation which instances could take capacity from.
ResourceLimit
Contains information about amount of some resource in the cluster. [...]
ResourceUsageExportConfig
Configuration for exporting cluster resource usages.
RollbackNodePoolUpgradeRequest
RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. [...]
SandboxConfig
SandboxConfig contains configurations of the sandbox to use for the node.
ServerConfig
Kubernetes Engine service configuration.
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.
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.
Status
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. [...]
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.
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.
UpgradeSettings
These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. [...]
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.
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.

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.