Module google_container1::api[][src]

Structs

AcceleratorConfig represents a Hardware Accelerator request.

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

Configuration for returning group information from authenticators.

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

Autopilot is the configuration for Autopilot settings on the cluster.

AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.

Parameters for using BigQuery as the destination of resource usage export.

Configuration for Binary Authorization.

CancelOperationRequest cancels a single operation.

CidrBlock contains an optional name and one CIDR block.

Configuration for client certificates on the cluster.

Configuration options for the Cloud Run feature.

A Google Kubernetes Engine cluster.

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

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

Configuration options for the Config Connector add-on.

Parameters for controlling consumption metering.

Central instance to access all Container related resource activities

CreateClusterRequest creates a cluster.

CreateNodePoolRequest creates a node pool for a cluster.

Time window specified for daily maintenance operations.

Configuration of etcd encryption.

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

Configuration for NodeLocal DNSCache

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); } The JSON representation for Empty is empty JSON object {}.

Configuration for the Compute Engine PD CSI driver.

GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517

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

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.

RFC-2616: cache control support

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.

Configuration for controlling how IPs are allocated in the cluster.

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

Jwk is a JSON Web Key as specified in RFC 7517

Configuration for the Kubernetes Dashboard.

Configuration for the legacy Attribute Based Access Control authorization mode.

Parameters that can be configured on Linux nodes.

ListClustersResponse is the result of ListClustersRequest.

ListNodePoolsResponse is the result of ListNodePoolsRequest.

ListOperationsResponse is the result of ListOperationsRequest.

ListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest.

MaintenancePolicy defines the maintenance policy to be used for the cluster.

MaintenanceWindow defines the maintenance window to be used for the cluster.

The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates.

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.

Constraints applied to pods.

Progress metric is (string, int|float|string) pair.

NetworkConfig reports the relative names of network & subnetwork.

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

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.

Parameters that describe the nodes in a cluster.

Node kubelet configs.

NodeManagement defines the set of node management services turned on for the node pool.

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.

NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage.

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 for more information, including usage and the valid values.

NotificationConfig is the configuration of notifications.

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Information about operation (or operation stage) progress.

Configuration options for private clusters.

Configuration for controlling master global access settings.

Lists subnetworks that are usable for creating clusters in a project.

Completes master IP rotation.

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project’s default network. One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project’s global metadata indicating which CIDR range the cluster is using.

Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren’t present when the cluster was initially created.

Gets the details of a specific cluster.

Gets the public component of the cluster signing keys in JSON Web Key format. This API is not yet intended for general use, and is not available for all clusters.

Lists all clusters owned by a project in either the specified zone or all zones.

Creates a node pool for a cluster.

Deletes a node pool from a cluster.

Retrieves the requested node pool.

Lists the node pools for a cluster.

Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.

Sets the autoscaling settings for the specified node pool.

Sets the NodeManagement options for a node pool.

Sets the size for a specific node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations.

Updates the version and/or image type for the specified node pool.

Sets the addons for a specific cluster.

Enables or disables the ABAC authorization mechanism on a cluster.

Sets the locations for a specific cluster. Deprecated. Use projects.locations.clusters.update instead.

Sets the logging service for a specific cluster.

Sets the maintenance policy for a cluster.

Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.

Sets the monitoring service for a specific cluster.

Enables or disables Network Policy for a cluster.

Sets labels on a cluster.

Starts master IP rotation.

Updates the settings of a specific cluster.

Updates the master for a specific cluster.

Gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details. This API is not yet intended for general use, and is not available for all clusters.

Returns configuration info about the Google Kubernetes Engine service.

Cancels the specified operation.

Gets the specified operation.

Lists all operations in a project in a specific zone or all zones.

A builder providing access to all methods supported on project resources. It is not used directly, but through the Container hub.

Sets the addons for a specific cluster.

Completes master IP rotation.

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project’s default network. One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project’s global metadata indicating which CIDR range the cluster is using.

Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren’t present when the cluster was initially created.

Gets the details of a specific cluster.

Enables or disables the ABAC authorization mechanism on a cluster.

Lists all clusters owned by a project in either the specified zone or all zones.

Sets the locations for a specific cluster. Deprecated. Use projects.locations.clusters.update instead.

Sets the logging service for a specific cluster.

Updates the master for a specific cluster.

Sets the monitoring service for a specific cluster.

Sets the autoscaling settings for the specified node pool.

Creates a node pool for a cluster.

Deletes a node pool from a cluster.

Retrieves the requested node pool.

Lists the node pools for a cluster.

Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.

Sets the NodeManagement options for a node pool.

Sets the size for a specific node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations.

Updates the version and/or image type for the specified node pool.

Sets labels on a cluster.

Sets the maintenance policy for a cluster.

Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.

Enables or disables Network Policy for a cluster.

Starts master IP rotation.

Updates the settings of a specific cluster.

Returns configuration info about the Google Kubernetes Engine service.

Cancels the specified operation.

Gets the specified operation.

Lists all operations in a project in a specific zone or all zones.

Pub/Sub specific notification config.

Represents an arbitrary window of time that recurs.

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 exposes configuration for a release channel.

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

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

Configuration for exporting cluster resource usages.

RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.

SandboxConfig contains configurations of the sandbox to use for the node.

Kubernetes Engine service configuration.

SetAddonsConfigRequest sets the addons associated with the cluster.

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 enables or disables the ABAC authorization mechanism for a cluster.

SetLocationsRequest sets the locations of the cluster.

SetLoggingServiceRequest sets the logging service of a cluster.

SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

SetMasterAuthRequest updates the admin password of a cluster.

SetMonitoringServiceRequest sets the monitoring service of a cluster.

SetNetworkPolicyRequest enables/disables network policy for a cluster.

SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.

SetNodePoolManagementRequest sets the node management properties of a node pool.

SetNodePoolSizeRequest sets the size of a node pool.

A set of Shielded Instance options.

Configuration of Shielded Nodes feature.

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

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 describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Represents an arbitrary window of time.

UpdateClusterRequest updates the settings of a cluster.

UpdateMasterRequest updates the master of the cluster.

UpdateNodePoolRequests update a node pool’s image and/or version.

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.

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

Secondary IP range of a usable subnetwork.

VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it.

Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.

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

Enums

Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.