container/v1 library

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:

ProjectsResource

Classes

AcceleratorConfig: AcceleratorConfig represents a Hardware Accelerator request.
AdditionalNodeNetworkConfig: AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message
AdditionalPodNetworkConfig: AdditionalPodNetworkConfig is the configuration for additional pod networks within the NodeNetworkConfig message
AdditionalPodRangesConfig: AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message.
AddonsConfig: Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality.
AdvancedDatapathObservabilityConfig: AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath.
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.
AutopilotCompatibilityIssue: AutopilotCompatibilityIssue contains information about a specific compatibility issue with Autopilot mode.
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.
BestEffortProvisioning: Best effort provisioning.
BigQueryDestination: Parameters for using BigQuery as the destination of resource usage export.
BinaryAuthorization: Configuration for Binary Authorization.
BlueGreenInfo: Information relevant to blue-green upgrade.
BlueGreenSettings: Settings for blue-green upgrade.
CancelOperationRequest: CancelOperationRequest cancels a single operation.
CheckAutopilotCompatibilityResponse: CheckAutopilotCompatibilityResponse has a list of compatibility issues.
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.
ClusterNetworkPerformanceConfig: Configuration of network bandwidth tiers
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.
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.
DefaultSnatStatus: DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster.
DnsCacheConfig: Configuration for NodeLocal DNSCache
DNSConfig: DNSConfig contains the desired set of options for configuring clusterDNS.
EnterpriseConfig: EnterpriseConfig is the cluster enterprise configuration.
EphemeralStorageLocalSsdConfig: EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs.
FastSocket: Configuration of Fast Socket feature.
Filter: Allows filtering to one or more specific event types.
Fleet: Fleet is the fleet configuration for the cluster.
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.
GcsFuseCsiDriverConfig: Configuration for the Cloud Storage Fuse 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.
GkeBackupAgentConfig: Configuration for the Backup for GKE Agent.
GPUDriverInstallationConfig: GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed.
GPUSharingConfig: GPUSharingConfig represents the GPU sharing configuration for Hardware Accelerators.
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.
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
K8sBetaAPIConfig: K8sBetaAPIConfig , configuration for beta APIs
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.
LocalNvmeSsdBlockConfig: LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs
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.
ManagedPrometheusConfig: ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus.
MasterAuth: The authentication information for accessing the master endpoint.
MasterAuthorizedNetworksConfig: Configuration options for the master authorized networks feature.
MaxPodsConstraint: Constraints applied to pods.
MeshCertificates: Configuration for issuance of mTLS keys and certificates to Kubernetes 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.
NetworkPerformanceConfig: Configuration of all network bandwidth tiers
NetworkPolicy: Configuration options for the NetworkPolicy feature.
NetworkPolicyConfig: Configuration for NetworkPolicy.
NetworkTags: Collection of Compute Engine network tags that can be applied to a node's underlying VM instance.
NodeAffinity: Specifies the NodeAffinity key, values, and affinity operator according to shared sole tenant node group affinities.
NodeConfig: Parameters that describe the nodes in a cluster.
NodeConfigDefaults: Subset of NodeConfig message that has defaults.
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.
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.
NodeTaint: Kubernetes taint is composed of three fields: key, value, and effect.
NodeTaints: Collection of Kubernetes node taints.
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.
ParentProductConfig: ParentProductConfig is the configuration of the parent product of the cluster.
PlacementPolicy: PlacementPolicy defines the placement policy used by the node pool.
PodCIDROverprovisionConfig: [PRIVATE FIELD] Config for pod CIDR size overprovisioning.
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.
QueuedProvisioning: QueuedProvisioning defines the queued provisioning used by the node pool.
RangeInfo: RangeInfo contains the range name and the range utilization by this cluster.
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.
ResourceManagerTags: A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
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.
SecondaryBootDisk: SecondaryBootDisk represents a persistent disk attached to a node with special configurations based on its mode.
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.
SoleTenantConfig: SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool.
StandardRolloutPolicy: Standard rollout policy is the default policy for blue-green.
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.
StatefulHAConfig: Configuration for the Stateful HA add-on.
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.
UpdateInfo: UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade.
UpdateMasterRequest: UpdateMasterRequest updates the master of the cluster.
UpdateNodePoolRequest: UpdateNodePoolRequests update a node pool's image and/or version.
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.
WindowsNodeConfig: Parameters that can be configured on Windows nodes.
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.
WorkloadPolicyConfig: WorkloadPolicyConfig is the configuration of workload policy for autopilot clusters.

Typedefs

CompleteNodePoolUpgradeRequest = $Empty: CompleteNodePoolUpgradeRequest sets the name of target node pool to complete upgrade.
Empty = $Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
NodeLabels = $Labels: Collection of node-level Kubernetes labels.
ResourceLabels = $Labels: Collection of GCP labels.
SecurityPostureConfig = $SecurityPostureConfig: SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API.
Status = $Status: The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.

Exceptions / Errors

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

container/v1 library

Classes

Typedefs

Exceptions / Errors

googleapis package

v1 library