Module types (1.0.2)

API documentation for container_v1.types module.

Classes

AcceleratorConfig

AcceleratorConfig represents a Hardware Accelerator request. .. attribute:: accelerator_count

The number of the accelerator cards exposed to an instance.

AddonsConfig

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

Configuration 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 the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes- engine/docs/concepts/dashboards

Configuration for the Cloud Run addon, which allows the user to use a managed Knative service.

AuthenticatorGroupsConfig

Configuration for returning group information from authenticators. .. attribute:: enabled

Whether this cluster should return group membership lookups during authentication using a group of security groups.

AutoUpgradeOptions

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

[Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in RFC3339 <https://www.ietf.org/rfc/rfc3339.txt>__ text format.

AutoprovisioningNodePoolDefaults

AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. .. attribute:: oauth_scopes

Scopes that are used by NAP when creating node pools. If oauth_scopes are specified, service_account should be empty.

BinaryAuthorization

Configuration for Binary Authorization. .. attribute:: enabled

Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Binary Authorization.

CancelOperationRequest

CancelOperationRequest cancels a single operation. .. attribute:: project_id

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field.

Deprecated. The server-assigned name of the operation. This field has been deprecated and replaced by the name field.

ClientCertificateConfig

Configuration for client certificates on the cluster. .. attribute:: issue_client_certificate

Issue a client certificate.

CloudRunConfig

Configuration options for the Cloud Run feature. .. attribute:: disabled

Whether Cloud Run addon is enabled for this cluster.

Cluster

A Google Kubernetes Engine cluster. .. attribute:: name

The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: - Lowercase letters, numbers, and hyphens only. - Must start with a letter. - Must end with a number or a letter.

The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.

The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, username will be set to "admin", a random password will be generated, and a client certificate will be issued.

The monitoring service the cluster should use to write metrics. Currently available options: - monitoring.googleapis.com - the Google Cloud Monitoring service. - none - no metrics will be exported from the cluster. - if left as an empty string, monitoring.googleapis.com will be used.

The IP address range of the container pods in this cluster, in CIDR <http://en.wikipedia.org/wiki/Classless_Inter- Domain_Routing>__ notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8.

The name of the Google Compute Engine subnetwork <https://cloud.google.com/compute/docs/subnetworks>__ to which the cluster is connected.

The list of Google Compute Engine zones <https://cloud.google.com/compute/docs/zones#available>__ in which the cluster's nodes should be located.

The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

Configuration for the legacy ABAC authorization mode.

Configuration for cluster IP allocation.

Configure the maintenance policy for this cluster.

Cluster-level autoscaling configuration.

The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.

Configuration controlling RBAC group membership information.

Configuration of etcd encryption.

[Output only] Server-defined URL for the resource.

[Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at https://username:password@endpoint/. See the masterAuth property of this resource for username and password information.

[Output only] The current software version of the master endpoint.

[Output only] The time the cluster was created, in RFC3339 <https://www.ietf.org/rfc/rfc3339.txt>__ text format.

[Output only] Additional information about the current status of this cluster, if available.

[Output only] The IP address range of the Kubernetes services in this cluster, in CIDR <http://en.wikipedia.org/wiki/Classless_Inter- Domain_Routing>__ notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.

[Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.

[Output only] The name of the Google Compute Engine zone <https://cloud.google.com/compute/docs/regions-zones/regions- zones#available> or region <https://cloud.google.com/compute/docs/regions-zones/regions- zones#available> in which the cluster resides.

[Output only] The IP address range of the Cloud TPUs in this cluster, in CIDR <http://en.wikipedia.org/wiki/Classless_Inter- Domain_Routing>__ notation (e.g. 1.2.3.4/29).

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. .. attribute:: enable_node_autoprovisioning

Enables automatic node pool creation and deletion.

AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.

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. .. attribute:: desired_node_version

The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version

Configurations for the various addons available to run in the cluster.

The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.

Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool.

The desired configuration options for master authorized networks feature.

The desired configuration options for the Binary Authorization feature.

The desired configuration for exporting resource usage.

The desired config of Intra-node visibility.

CompleteIPRotationRequest

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

Deprecated. The Google Developers Console project ID or project number <https://developers.google.com/console/help/new /#projectnumber>__. This field has been deprecated and replaced by the name field.

Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

CreateClusterRequest

CreateClusterRequest creates a cluster. .. attribute:: project_id

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the parent field.

Required. A cluster resource <https://cloud.google.com/container- engine/reference/rest/v1/projects.zones.clusters>__

CreateNodePoolRequest

CreateNodePoolRequest creates a node pool for a cluster. .. attribute:: project_id

Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.

The parent (project, location, cluster id) where the node pool will be created. Specified in the format projects/*/locations/*/clusters/*.

DailyMaintenanceWindow

Time window specified for daily maintenance operations. .. attribute:: start_time

Time within the maintenance window to start the maintenance operations. Time format should be in RFC3339 <https://www.ietf.org/rfc/rfc3339.txt>__ format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

DatabaseEncryption

Configuration of etcd encryption. .. attribute:: state

Denotes the state of etcd encryption.

DeleteClusterRequest

DeleteClusterRequest deletes a cluster. .. attribute:: project_id

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field.

Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field.

DeleteNodePoolRequest

DeleteNodePoolRequest deletes a node pool for a cluster. .. attribute:: project_id

Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format projects/*/locations/*/clusters/*/nodePools/*.

Empty

API documentation for container_v1.types.Empty class.

GetClusterRequest

GetClusterRequest gets the settings of a cluster. .. attribute:: project_id

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field.

Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field.

GetNodePoolRequest

GetNodePoolRequest retrieves a node pool for a cluster. .. attribute:: project_id

Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format projects/*/locations/*/clusters/*/nodePools/*.

GetOperationRequest

GetOperationRequest gets a single operation. .. attribute:: project_id

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field.

Deprecated. The server-assigned name of the operation. This field has been deprecated and replaced by the name field.

GetServerConfigRequest

Gets the current Kubernetes Engine service configuration. .. attribute:: project_id

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field.

The name (project and location) of the server config to get, specified in the format projects/*/locations/*.

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. .. attribute:: disabled

Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that a Heapster pod is running in the cluster, which is also used by the Cloud Monitoring service.

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. .. attribute:: disabled

Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.

IPAllocationPolicy

Configuration for controlling how IPs are allocated in the cluster. .. attribute:: use_ip_aliases

Whether alias IPs will be used for pod IPs in the cluster.

A custom subnetwork name to be used if create_subnetwork is true. If this field is empty, then an automatic name will be chosen for the new subnetwork.

This field is deprecated, use node_ipv4_cidr_block.

The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.

The IP address range for the cluster pod IPs. If this field is set, then cluster.cluster_ipv4_cidr must be left blank. This field is only applicable when use_ip_aliases is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. /14) to have a range chosen with a specific netmask. Set to a CIDR <http://en.wikipedia.org/wiki/Classless_Inter- Domain_Routing>__ notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when use_ip_aliases is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. /14) to have a range chosen with a specific netmask. Set to a CIDR <http://en.wikipedia.org/wiki/Classless_Inter- Domain_Routing>__ notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

IntraNodeVisibilityConfig

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

Enables intra node visibility for this cluster.

KubernetesDashboard

Configuration for the Kubernetes Dashboard. .. attribute:: disabled

Whether the Kubernetes Dashboard is enabled for this cluster.

LegacyAbac

Configuration for the legacy Attribute Based Access Control authorization mode. .. attribute:: enabled

Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.

ListClustersRequest

ListClustersRequest lists clusters. .. attribute:: project_id

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the parent field.

The parent (project and location) where the clusters will be listed. Specified in the format projects/*/locations/*. Location "-" matches all zones and all regions.

ListClustersResponse

ListClustersResponse is the result of ListClustersRequest. .. attribute:: clusters

A list of clusters in the project in the specified zone, or across all ones.

ListNodePoolsRequest

ListNodePoolsRequest lists the node pool(s) for a cluster. .. attribute:: project_id

Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.

ListNodePoolsResponse

ListNodePoolsResponse is the result of ListNodePoolsRequest. .. attribute:: node_pools

A list of node pools for a cluster.

ListOperationsRequest

ListOperationsRequest lists operations. .. attribute:: project_id

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the parent field.

The parent (project and location) where the operations will be listed. Specified in the format projects/*/locations/*. Location "-" matches all zones and all regions.

ListOperationsResponse

ListOperationsResponse is the result of ListOperationsRequest. .. attribute:: operations

A list of operations in the project in the specified zone.

ListUsableSubnetworksRequest

ListUsableSubnetworksRequest requests the list of usable subnetworks available to a user for creating clusters. .. attribute:: parent

The parent project where subnetworks are usable. Specified in the format projects/*.

The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

ListUsableSubnetworksResponse

ListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest. .. attribute:: subnetworks

A list of usable subnetworks in the specified network project.

MaintenancePolicy

MaintenancePolicy defines the maintenance policy to be used for the cluster. .. attribute:: window

Specifies the maintenance window in which maintenance may be performed.

MaintenanceWindow

MaintenanceWindow defines the maintenance window to be used for the cluster. .. attribute:: daily_maintenance_window

DailyMaintenanceWindow specifies a daily maintenance operation window.

Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.

MasterAuth

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

The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string).

Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.

[Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.

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. .. attribute:: enabled

Whether or not master authorized networks is enabled.

MaxPodsConstraint

Constraints applied to pods. .. attribute:: max_pods_per_node

Constraint enforced on the max num of pods per node.

NetworkConfig

NetworkConfig reports the relative names of network & subnetwork. .. attribute:: network

Output only. The relative name of the Google Compute Engine [n etwork][google.container.v1.NetworkConfig.network](https://clo ud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my- project/global/networks/my-network

Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network.

NetworkPolicy

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

The selected network policy provider.

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. .. attribute:: disabled

Whether NetworkPolicy is enabled for this cluster.

NodeConfig

Parameters that describe the nodes in a cluster. .. attribute:: machine_type

The name of a Google Compute Engine machine type <https://cloud.google.com/compute/docs/machine-types>__ (e.g. n1-standard-1). If unspecified, the default machine type is n1-standard-1.

The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: - https://www.googleapis.com/auth/compute is required for mounting persistent storage on your nodes. - https://www.googleapis.com/auth/devstorage.read_only is required for communicating with gcr.io (the Google Container Registry <https://cloud.google.com/container- registry/>__). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.

The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: "cluster- location" "cluster-name" "cluster-uid" "configure-sh" "containerd-configure-sh" "enable-os-login" "gci-update- strategy" "gci-ensure-gke-docker" "instance-template" "kube- env" "startup-script" "user-data" "disable-address-manager" "windows-startup-script-ps1" "common-psm1" "k8s-node-setup- psm1" "install-ssh-psm1" "user-profile-psm1" "serial-port- logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.

The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with- objects/labels/

The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.

A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.

Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read how to specify min CPU platform <https://cloud.google.com/compute/docs/instances/specify-min- cpu-platform>__

Shielded Instance options.

NodeManagement

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

A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.

Specifies the Auto Upgrade knobs for the node pool.

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. .. attribute:: name

The name of the node pool.

The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.

The version of the Kubernetes of this node.

[Output only] The status of the nodes in this pool instance.

Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.

The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.

[Output only] The pod CIDR block size per node in this node pool.

NodePoolAutoscaling

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

Is autoscaling enabled for this node pool.

Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster.

NodeTaint

Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint- and-toleration/ .. attribute:: key

Key for taint.

Effect for taint.

Operation

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

The server-assigned ID for the operation.

The operation type.

Detailed operation progress, if available.

Server-defined URL for the resource.

[Output only] The time the operation completed, in RFC3339 <https://www.ietf.org/rfc/rfc3339.txt>__ text format.

Which conditions caused the current node pool state.

PrivateClusterConfig

Configuration options for private clusters. .. attribute:: enable_private_nodes

Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking.

The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster's network.

Output only. The external IP address of this cluster's master endpoint.

RecurringTimeWindow

Represents an arbitrary window of time that recurs. .. attribute:: window

The window of the first recurrence.

ResourceLimit

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

Resource name "cpu", "memory" or gpu-specific string.

Maximum amount of the resource in the cluster.

ResourceUsageExportConfig

Configuration for exporting cluster resource usages. .. attribute:: bigquery_destination

Configuration to use BigQuery as usage export destination.

Configuration to enable resource consumption metering.

RollbackNodePoolUpgradeRequest

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

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field.

Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.

The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format projects/*/locations/*/clusters/*/nodePools/*.

ServerConfig

Kubernetes Engine service configuration. .. attribute:: default_cluster_version

Version of Kubernetes the service deploys by default.

Default image type.

List of valid master versions.

SetAddonsConfigRequest

SetAddonsConfigRequest sets the addons associated with the cluster. .. attribute:: project_id

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field.

Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

The name (project, location, cluster) of the cluster to set addons. Specified in the format projects/*/locations/*/clusters/*.

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 .. attribute:: project_id

Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint.

SetLegacyAbacRequest

SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster. .. attribute:: project_id

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field.

Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.

The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format projects/*/locations/*/clusters/*.

SetLocationsRequest

SetLocationsRequest sets the locations of the cluster. .. attribute:: project_id

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field.

Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

The name (project, location, cluster) of the cluster to set locations. Specified in the format projects/*/locations/*/clusters/*.

SetLoggingServiceRequest

SetLoggingServiceRequest sets the logging service of a cluster. .. attribute:: project_id

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field.

Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

The name (project, location, cluster) of the cluster to set logging. Specified in the format projects/*/locations/*/clusters/*.

SetMaintenancePolicyRequest

SetMaintenancePolicyRequest sets the maintenance policy for a cluster. .. attribute:: project_id

Required. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__.

Required. The name of the cluster to update.

The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format projects/*/locations/*/clusters/*.

SetMasterAuthRequest

SetMasterAuthRequest updates the admin password of a cluster. .. attribute:: project_id

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field.

Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

Required. A description of the update.

SetMonitoringServiceRequest

SetMonitoringServiceRequest sets the monitoring service of a cluster. .. attribute:: project_id

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field.

Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

The name (project, location, cluster) of the cluster to set monitoring. Specified in the format projects/*/locations/*/clusters/*.

SetNetworkPolicyRequest

SetNetworkPolicyRequest enables/disables network policy for a cluster. .. attribute:: project_id

Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format projects/*/locations/*/clusters/*.

SetNodePoolAutoscalingRequest

SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool. .. attribute:: project_id

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field.

Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

Required. Autoscaling configuration for the node pool.

SetNodePoolManagementRequest

SetNodePoolManagementRequest sets the node management properties of a node pool. .. attribute:: project_id

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field.

Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.

Required. NodeManagement configuration for the node pool.

SetNodePoolSizeRequest

SetNodePoolSizeRequest sets the size a node pool. .. attribute:: project_id

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field.

Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.

Required. The desired node count for the pool.

ShieldedInstanceConfig

A set of Shielded Instance options. .. attribute:: enable_secure_boot

Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.

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. .. attribute:: project_id

Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

Whether to rotate credentials during IP rotation.

StatusCondition

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). .. attribute:: code

Machine-friendly representation of the condition

TimeWindow

Represents an arbitrary window of time. .. attribute:: start_time

The time that the window first starts.

Timestamp

API documentation for container_v1.types.Timestamp class.

UpdateClusterRequest

UpdateClusterRequest updates the settings of a cluster. .. attribute:: project_id

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field.

Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

The name (project, location, cluster) of the cluster to update. Specified in the format projects/*/locations/*/clusters/*.

UpdateMasterRequest

UpdateMasterRequest updates the master of the cluster. .. attribute:: project_id

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field.

Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

The name (project, location, cluster) of the cluster to update. Specified in the format projects/*/locations/*/clusters/*.

UpdateNodePoolRequest

UpdateNodePoolRequests update a node pool's image and/or version. .. attribute:: project_id

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field.

Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version

The name (project, location, cluster, node pool) of the node pool to update. Specified in the format projects/*/locations/*/clusters/*/nodePools/*.

UsableSubnetwork

Network Name. Example: projects/my-project/global/networks/my-network .. attribute:: subnetwork

Subnetwork Name. Example: projects/my-project/regions/us- central1/subnetworks/my-subnet

Secondary IP ranges.

UsableSubnetworkSecondaryRange

Secondary IP range of a usable subnetwork. .. attribute:: range_name

The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance.

This field is to determine the status of the secondary range programmably.

VerticalPodAutoscaling

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

Enables vertical pod autoscaling.