Show / Hide Table of Contents

Namespace Google.Apis.Container.v1beta1.Data

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.

AnonymousAuthenticationConfig

AnonymousAuthenticationConfig defines the settings needed to limit endpoints that allow anonymous authentication.

AuthenticatorGroupsConfig

Configuration for returning group information from authenticators.

AutoMonitoringConfig

AutoMonitoringConfig defines the configuration for GKE Workload Auto-Monitoring.

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.

AutopilotCompatibilityIssue

AutopilotCompatibilityIssue contains information about a specific compatibility issue with Autopilot mode.

AutopilotConfig

AutopilotConfig contains configuration of autopilot feature for this nodepool.

AutopilotConversionStatus

AutopilotConversionStatus represents conversion status.

AutoprovisioningNodePoolDefaults

AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.

AutoscaledRolloutPolicy

Autoscaled rollout policy uses cluster autoscaler during blue-green upgrades to scale both the green and blue pools.

AvailableVersion

Deprecated.

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.

CertificateAuthorityDomainConfig

CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate.

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 all network bandwidth tiers

ClusterTelemetry

Telemetry integration for the cluster.

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.

ClusterUpgradeInfo

ClusterUpgradeInfo contains the upgrade information of a cluster.

CompleteIPRotationRequest

CompleteIPRotationRequest moves the cluster master back into single-IP mode.

CompleteNodePoolUpgradeRequest

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

CompliancePostureConfig

CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture.

ComplianceStandard

Defines the details of a compliance standard.

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.

ContainerdConfig

ContainerdConfig contains configuration to customize containerd.

ControlPlaneEndpointsConfig

Configuration for all of the cluster's control plane endpoints.

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.

DNSEndpointConfig

Describes the configuration of a DNS endpoint.

DailyMaintenanceWindow

Time window specified for daily maintenance operations.

DatabaseEncryption

Configuration of etcd encryption.

Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp

DefaultSnatStatus

DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster.

DesiredEnterpriseConfig

DesiredEnterpriseConfig is a wrapper used for updating enterprise_config.

DnsCacheConfig

Configuration for NodeLocal DNSCache

Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

EnterpriseConfig

EnterpriseConfig is the cluster enterprise configuration.

EphemeralStorageConfig

EphemeralStorageConfig contains configuration for the ephemeral storage filesystem.

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

Fleet

Fleet is the fleet configuration for the cluster.

GCPSecretManagerCertificateConfig

GCPSecretManagerCertificateConfig configures a secret from Google Secret Manager.

GPUDriverInstallationConfig

GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed.

GPUSharingConfig

GPUSharingConfig represents the GPU sharing configuration for Hardware Accelerators.

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.

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 specified in rfc 7517

GetOpenIDConfigResponse

GetOpenIDConfigResponse is an OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.

GkeBackupAgentConfig

Configuration for the Backup for GKE Agent.

HighScaleCheckpointingConfig

Configuration for the High Scale Checkpointing.

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.

HostMaintenancePolicy

HostMaintenancePolicy contains the maintenance policy for the hosts on which the GKE VMs run on.

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.

HugepagesConfig

Hugepages amount in both 2m and 1g size

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.

IPEndpointsConfig

IP endpoints configuration.

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.

IstioConfig

Configuration options for Istio addon.

Jwk

Jwk is a JSON Web Key as specified in RFC 7517

K8sBetaAPIConfig

Kubernetes open source beta apis enabled on the cluster.

KalmConfig

Configuration options for the KALM addon.

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.

ListLocationsResponse

ListLocationsResponse returns the list of all GKE locations and their recommendation state.

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

Location

Location returns the location name, and if the location is recommended for GKE cluster scheduling.

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.

Master

Master is the configuration for components on master.

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.

MaxPodsConstraint

Constraints applied to pods.

MemoryManager

The option enables the Kubernetes NUMA-aware Memory Manager feature. Detailed description about the feature can be found here.

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. 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. (See tags field in NodeConfig).

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. GKE Autopilot clusters do not recognize parameters in NodeConfig. Use 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.

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.

NodePoolUpgradeInfo

NodePoolUpgradeInfo contains the upgrade information of a nodepool.

NodeTaint

Kubernetes taint is composed 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.

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. All fields are output only.

OperationError

OperationError records errors seen from CloudKMS keys encountered during updates to DatabaseEncryption configuration.

OperationProgress

Information about operation (or operation stage) progress.

OpportunisticMaintenanceStrategy

Strategy that will trigger maintenance on behalf of the customer.

ParallelstoreCsiDriverConfig

Configuration for the Cloud Storage Parallelstore CSI driver.

ParentProductConfig

ParentProductConfig is the configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of a GKE cluster and take the ownership of the cluster.

PlacementPolicy

PlacementPolicy defines the placement policy used by the node pool.

PodAutoscaling

PodAutoscaling is used for configuration of parameters for workload autoscaling.

PodCIDROverprovisionConfig

[PRIVATE FIELD] Config for pod CIDR size overprovisioning.

PodSecurityPolicyConfig

Configuration for the PodSecurityPolicy feature.

PolicyBinding

Binauthz policy that applies to this cluster.

PrivateClusterConfig

Configuration options for private clusters.

PrivateClusterMasterGlobalAccessConfig

Configuration for controlling master global access settings.

PrivateRegistryAccessConfig

PrivateRegistryAccessConfig contains access configuration for private container registries.

ProtectConfig

ProtectConfig defines the flags needed to enable/disable features for the Protect API.

PubSub

Pub/Sub specific notification config.

QueuedProvisioning

QueuedProvisioning defines the queued provisioning used by the node pool.

RBACBindingConfig

RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.

RangeInfo

RangeInfo contains the range name and the range utilization by this cluster.

RayClusterLoggingConfig

RayClusterLoggingConfig specifies logging configuration for Ray clusters.

RayClusterMonitoringConfig

RayClusterMonitoringConfig specifies monitoring configuration for Ray clusters.

RayOperatorConfig

Configuration options for the Ray Operator add-on.

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.

ReleaseChannelConfig

ReleaseChannelConfig exposes configuration for a release channel.

ReservationAffinity

ReservationAffinity is the configuration of desired reservation which instances could take capacity from.

ResourceLabels

Collection of GCP labels.

ResourceLimit

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

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. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values.

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.

RotationConfig

RotationConfig is config for secret manager auto rotation.

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.

SecondaryBootDiskUpdateStrategy

SecondaryBootDiskUpdateStrategy is a placeholder which will be extended in the future to define different options for updating secondary boot disks.

SecretManagerConfig

SecretManagerConfig is config for secret manager enablement.

SecurityBulletinEvent

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

SecurityPostureConfig

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

ServerConfig

Kubernetes Engine service configuration.

ServiceExternalIPsConfig

Config to block services with externalIPs field.

SetAddonsConfigRequest

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

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

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.

TopologyManager

TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/

TpuConfig

Configuration for Cloud TPU. This message is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.

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

SetNodePoolVersionRequest updates the version of a node pool.

UpgradeAvailableEvent

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

UpgradeDetails

UpgradeDetails contains detailed information of each individual upgrade operation.

UpgradeEvent

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

UpgradeInfoEvent

UpgradeInfoEvent is a notification sent to customers about the upgrade information of a resource.

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 SURGE, 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.

UsableSubnetwork

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

UsableSubnetworkSecondaryRange

Secondary IP range of a usable subnetwork.

UserManagedKeysConfig

UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster.

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.

WindowsVersion

Windows server version.

WindowsVersions

Windows server versions.

WorkloadALTSConfig

Configuration for direct-path (via ALTS) with workload identity.

WorkloadCertificates

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

WorkloadConfig

WorkloadConfig defines the flags to enable or disable the workload configurations for the cluster.

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 related to GCW workload policy

In this article
Back to top Generated by DocFX