Types for Google Container Engine API Client#

class google.cloud.container_v1.types.AcceleratorConfig#

AcceleratorConfig represents a Hardware Accelerator request.

accelerator_count#

The number of the accelerator cards exposed to an instance.

accelerator_type#

The accelerator type resource name. List of supported accelerators here

accelerator_count

Field google.container.v1.AcceleratorConfig.accelerator_count

accelerator_type

Field google.container.v1.AcceleratorConfig.accelerator_type

class google.cloud.container_v1.types.AddonsConfig#

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

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.

horizontal_pod_autoscaling#

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

kubernetes_dashboard#

Configuration for the Kubernetes Dashboard.

network_policy_config#

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.

horizontal_pod_autoscaling

Field google.container.v1.AddonsConfig.horizontal_pod_autoscaling

http_load_balancing

Field google.container.v1.AddonsConfig.http_load_balancing

kubernetes_dashboard

Field google.container.v1.AddonsConfig.kubernetes_dashboard

network_policy_config

Field google.container.v1.AddonsConfig.network_policy_config

class google.cloud.container_v1.types.AutoUpgradeOptions#

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

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

description#

[Output only] This field is set when upgrades are about to commence with the description of the upgrade.

auto_upgrade_start_time

Field google.container.v1.AutoUpgradeOptions.auto_upgrade_start_time

description

Field google.container.v1.AutoUpgradeOptions.description

class google.cloud.container_v1.types.CancelOperationRequest#

CancelOperationRequest cancels a single operation.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the operation resides. This field has been deprecated and replaced by the name field.

operation_id#

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

name#

The name (project, location, operation id) of the operation to cancel. Specified in the format ‘projects//locations//operations/*’.

name

Field google.container.v1.CancelOperationRequest.name

operation_id

Field google.container.v1.CancelOperationRequest.operation_id

project_id

Field google.container.v1.CancelOperationRequest.project_id

zone

Field google.container.v1.CancelOperationRequest.zone

class google.cloud.container_v1.types.ClientCertificateConfig#

Configuration for client certificates on the cluster.

issue_client_certificate#

Issue a client certificate.

issue_client_certificate

Field google.container.v1.ClientCertificateConfig.issue_client_certificate

class google.cloud.container_v1.types.Cluster#

A Google Kubernetes Engine cluster.

name#

The name of this cluster. The name must be unique within this project and zone, 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.

description#

An optional description of this cluster.

initial_node_count#

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.

node_config#

Parameters used in creating the cluster’s nodes. See nodeConfig for the description of its properties. For requests, this field should only be used in lieu of a “node_pool” object, since this configuration (along with the “initial_node_count”) 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. For responses, this field will be populated with the node configuration of the first node pool. If unspecified, the defaults are used.

master_auth#

The authentication information for accessing the master endpoint.

logging_service#

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

monitoring_service#

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.

network#

The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.

cluster_ipv4_cidr#

The IP address range of the container pods in this cluster, in CIDR 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.

addons_config#

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

subnetwork#

The name of the Google Compute Engine subnetwork to which the cluster is connected.

node_pools#

The node pools associated with this cluster. This field should not be set if “node_config” or “initial_node_count” are specified.

locations#

The list of Google Compute Engine locations in which the cluster’s nodes should be located.

enable_kubernetes_alpha#

Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.

resource_labels#

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

label_fingerprint#

The fingerprint of the set of labels for this cluster.

legacy_abac#

Configuration for the legacy ABAC authorization mode.

network_policy#

Configuration options for the NetworkPolicy feature.

ip_allocation_policy#

Configuration for cluster IP allocation.

master_authorized_networks_config#

The configuration options for master authorized networks feature.

maintenance_policy#

Configure the maintenance policy for this cluster.

network_config#

Configuration for cluster networking.

private_cluster_config#

Configuration for private cluster.

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

zone#

[Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.

endpoint#

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

initial_cluster_version#

The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. 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 default Kubernetes version

current_master_version#

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

current_node_version#

[Output only] Deprecated, use NodePool.version instead. The current version of the node software components. If they are currently at multiple versions because they’re in the process of being upgraded, this reflects the minimum version of all nodes.

create_time#

[Output only] The time the cluster was created, in RFC3339 text format.

status#

[Output only] The current status of this cluster.

status_message#

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

node_ipv4_cidr_size#

[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range.

services_ipv4_cidr#

[Output only] The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.

instance_group_urls#

Deprecated. Use node_pools.instance_group_urls.

current_node_count#

[Output only] The number of nodes currently in the cluster.

expire_time#

[Output only] The time the cluster will be automatically deleted in RFC3339 text format.

location#

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.

class ResourceLabelsEntry#
key#

Field google.container.v1.Cluster.ResourceLabelsEntry.key

value#

Field google.container.v1.Cluster.ResourceLabelsEntry.value

addons_config

Field google.container.v1.Cluster.addons_config

cluster_ipv4_cidr

Field google.container.v1.Cluster.cluster_ipv4_cidr

create_time

Field google.container.v1.Cluster.create_time

current_master_version

Field google.container.v1.Cluster.current_master_version

current_node_count

Field google.container.v1.Cluster.current_node_count

current_node_version

Field google.container.v1.Cluster.current_node_version

description

Field google.container.v1.Cluster.description

enable_kubernetes_alpha

Field google.container.v1.Cluster.enable_kubernetes_alpha

endpoint

Field google.container.v1.Cluster.endpoint

expire_time

Field google.container.v1.Cluster.expire_time

initial_cluster_version

Field google.container.v1.Cluster.initial_cluster_version

initial_node_count

Field google.container.v1.Cluster.initial_node_count

instance_group_urls

Field google.container.v1.Cluster.instance_group_urls

ip_allocation_policy

Field google.container.v1.Cluster.ip_allocation_policy

label_fingerprint

Field google.container.v1.Cluster.label_fingerprint

legacy_abac

Field google.container.v1.Cluster.legacy_abac

location

Field google.container.v1.Cluster.location

locations

Field google.container.v1.Cluster.locations

logging_service

Field google.container.v1.Cluster.logging_service

maintenance_policy

Field google.container.v1.Cluster.maintenance_policy

master_auth

Field google.container.v1.Cluster.master_auth

master_authorized_networks_config

Field google.container.v1.Cluster.master_authorized_networks_config

monitoring_service

Field google.container.v1.Cluster.monitoring_service

name

Field google.container.v1.Cluster.name

network

Field google.container.v1.Cluster.network

network_config

Field google.container.v1.Cluster.network_config

network_policy

Field google.container.v1.Cluster.network_policy

node_config

Field google.container.v1.Cluster.node_config

node_ipv4_cidr_size

Field google.container.v1.Cluster.node_ipv4_cidr_size

node_pools

Field google.container.v1.Cluster.node_pools

private_cluster_config

Field google.container.v1.Cluster.private_cluster_config

resource_labels

Field google.container.v1.Cluster.resource_labels

self_link

Field google.container.v1.Cluster.self_link

services_ipv4_cidr

Field google.container.v1.Cluster.services_ipv4_cidr

status

Field google.container.v1.Cluster.status

status_message

Field google.container.v1.Cluster.status_message

subnetwork

Field google.container.v1.Cluster.subnetwork

zone

Field google.container.v1.Cluster.zone

class google.cloud.container_v1.types.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.

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

desired_monitoring_service#

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

desired_addons_config#

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

desired_node_pool_id#

The node pool to be upgraded. This field is mandatory if “desired_node_version”, “desired_image_family” or “desired_node_pool_autoscaling” is specified and there is more than one node pool on the cluster.

desired_image_type#

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

desired_node_pool_autoscaling#

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.

desired_locations#

The desired list of Google Compute Engine locations in which the cluster’s nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster’s primary zone.

desired_master_authorized_networks_config#

The desired configuration options for master authorized networks feature.

desired_master_version#

The Kubernetes version to change the master to. 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 default Kubernetes version

desired_addons_config

Field google.container.v1.ClusterUpdate.desired_addons_config

desired_image_type

Field google.container.v1.ClusterUpdate.desired_image_type

desired_locations

Field google.container.v1.ClusterUpdate.desired_locations

desired_master_authorized_networks_config

Field google.container.v1.ClusterUpdate.desired_master_authorized_networks_config

desired_master_version

Field google.container.v1.ClusterUpdate.desired_master_version

desired_monitoring_service

Field google.container.v1.ClusterUpdate.desired_monitoring_service

desired_node_pool_autoscaling

Field google.container.v1.ClusterUpdate.desired_node_pool_autoscaling

desired_node_pool_id

Field google.container.v1.ClusterUpdate.desired_node_pool_id

desired_node_version

Field google.container.v1.ClusterUpdate.desired_node_version

class google.cloud.container_v1.types.CompleteIPRotationRequest#

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

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

cluster_id#

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

name#

The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format ‘projects//locations//clusters/*’.

cluster_id

Field google.container.v1.CompleteIPRotationRequest.cluster_id

name

Field google.container.v1.CompleteIPRotationRequest.name

project_id

Field google.container.v1.CompleteIPRotationRequest.project_id

zone

Field google.container.v1.CompleteIPRotationRequest.zone

class google.cloud.container_v1.types.CreateClusterRequest#

CreateClusterRequest creates a cluster.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.

cluster#

A cluster resource

parent#

The parent (project and location) where the cluster will be created. Specified in the format ‘projects//locations/’.

cluster

Field google.container.v1.CreateClusterRequest.cluster

parent

Field google.container.v1.CreateClusterRequest.parent

project_id

Field google.container.v1.CreateClusterRequest.project_id

zone

Field google.container.v1.CreateClusterRequest.zone

class google.cloud.container_v1.types.CreateNodePoolRequest#

CreateNodePoolRequest creates a node pool for a cluster.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.

cluster_id#

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

node_pool#

The node pool to create.

parent#

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

cluster_id

Field google.container.v1.CreateNodePoolRequest.cluster_id

node_pool

Field google.container.v1.CreateNodePoolRequest.node_pool

parent

Field google.container.v1.CreateNodePoolRequest.parent

project_id

Field google.container.v1.CreateNodePoolRequest.project_id

zone

Field google.container.v1.CreateNodePoolRequest.zone

class google.cloud.container_v1.types.DailyMaintenanceWindow#

Time window specified for daily maintenance operations.

start_time#

Time within the maintenance window to start the maintenance operations. Time format should be in RFC3339 format “HH:MM”, where HH : [00-23] and MM : [00-59] GMT.

duration#

[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in RFC3339 format “PTnHnMnS”.

duration

Field google.container.v1.DailyMaintenanceWindow.duration

start_time

Field google.container.v1.DailyMaintenanceWindow.start_time

class google.cloud.container_v1.types.DeleteClusterRequest#

DeleteClusterRequest deletes a cluster.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

cluster_id#

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

name#

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

cluster_id

Field google.container.v1.DeleteClusterRequest.cluster_id

name

Field google.container.v1.DeleteClusterRequest.name

project_id

Field google.container.v1.DeleteClusterRequest.project_id

zone

Field google.container.v1.DeleteClusterRequest.zone

class google.cloud.container_v1.types.DeleteNodePoolRequest#

DeleteNodePoolRequest deletes a node pool for a cluster.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

cluster_id#

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

node_pool_id#

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

name#

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

cluster_id

Field google.container.v1.DeleteNodePoolRequest.cluster_id

name

Field google.container.v1.DeleteNodePoolRequest.name

node_pool_id

Field google.container.v1.DeleteNodePoolRequest.node_pool_id

project_id

Field google.container.v1.DeleteNodePoolRequest.project_id

zone

Field google.container.v1.DeleteNodePoolRequest.zone

class google.cloud.container_v1.types.Empty#
class google.cloud.container_v1.types.GetClusterRequest#

GetClusterRequest gets the settings of a cluster.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

cluster_id#

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

name#

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

cluster_id

Field google.container.v1.GetClusterRequest.cluster_id

name

Field google.container.v1.GetClusterRequest.name

project_id

Field google.container.v1.GetClusterRequest.project_id

zone

Field google.container.v1.GetClusterRequest.zone

class google.cloud.container_v1.types.GetNodePoolRequest#

GetNodePoolRequest retrieves a node pool for a cluster.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

cluster_id#

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

node_pool_id#

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

name#

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

cluster_id

Field google.container.v1.GetNodePoolRequest.cluster_id

name

Field google.container.v1.GetNodePoolRequest.name

node_pool_id

Field google.container.v1.GetNodePoolRequest.node_pool_id

project_id

Field google.container.v1.GetNodePoolRequest.project_id

zone

Field google.container.v1.GetNodePoolRequest.zone

class google.cloud.container_v1.types.GetOperationRequest#

GetOperationRequest gets a single operation.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

operation_id#

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

name#

The name (project, location, operation id) of the operation to get. Specified in the format ‘projects//locations//operations/*’.

name

Field google.container.v1.GetOperationRequest.name

operation_id

Field google.container.v1.GetOperationRequest.operation_id

project_id

Field google.container.v1.GetOperationRequest.project_id

zone

Field google.container.v1.GetOperationRequest.zone

class google.cloud.container_v1.types.GetServerConfigRequest#

Gets the current Kubernetes Engine service configuration.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone to return operations for. This field has been deprecated and replaced by the name field.

name#

The name (project and location) of the server config to get Specified in the format ‘projects//locations/’.

name

Field google.container.v1.GetServerConfigRequest.name

project_id

Field google.container.v1.GetServerConfigRequest.project_id

zone

Field google.container.v1.GetServerConfigRequest.zone

class google.cloud.container_v1.types.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.

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.

disabled

Field google.container.v1.HorizontalPodAutoscaling.disabled

class google.cloud.container_v1.types.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.

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.

disabled

Field google.container.v1.HttpLoadBalancing.disabled

class google.cloud.container_v1.types.IPAllocationPolicy#

Configuration for controlling how IPs are allocated in the cluster.

use_ip_aliases#

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

create_subnetwork#

Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when use_ip_aliases is true.

subnetwork_name#

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.

cluster_ipv4_cidr#

This field is deprecated, use cluster_ipv4_cidr_block.

node_ipv4_cidr#

This field is deprecated, use node_ipv4_cidr_block.

services_ipv4_cidr#

This field is deprecated, use services_ipv4_cidr_block.

cluster_secondary_range_name#

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.

services_secondary_range_name#

The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. 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.

cluster_ipv4_cidr_block#

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

node_ipv4_cidr_block#

The IP address range of the instance IPs in this cluster. This is applicable only if create_subnetwork 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 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.

services_ipv4_cidr_block#

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

cluster_ipv4_cidr

Field google.container.v1.IPAllocationPolicy.cluster_ipv4_cidr

cluster_ipv4_cidr_block

Field google.container.v1.IPAllocationPolicy.cluster_ipv4_cidr_block

cluster_secondary_range_name

Field google.container.v1.IPAllocationPolicy.cluster_secondary_range_name

create_subnetwork

Field google.container.v1.IPAllocationPolicy.create_subnetwork

node_ipv4_cidr

Field google.container.v1.IPAllocationPolicy.node_ipv4_cidr

node_ipv4_cidr_block

Field google.container.v1.IPAllocationPolicy.node_ipv4_cidr_block

services_ipv4_cidr

Field google.container.v1.IPAllocationPolicy.services_ipv4_cidr

services_ipv4_cidr_block

Field google.container.v1.IPAllocationPolicy.services_ipv4_cidr_block

services_secondary_range_name

Field google.container.v1.IPAllocationPolicy.services_secondary_range_name

subnetwork_name

Field google.container.v1.IPAllocationPolicy.subnetwork_name

use_ip_aliases

Field google.container.v1.IPAllocationPolicy.use_ip_aliases

class google.cloud.container_v1.types.KubernetesDashboard#

Configuration for the Kubernetes Dashboard.

disabled#

Whether the Kubernetes Dashboard is enabled for this cluster.

disabled

Field google.container.v1.KubernetesDashboard.disabled

class google.cloud.container_v1.types.LegacyAbac#

Configuration for the legacy Attribute Based Access Control authorization mode.

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.

enabled

Field google.container.v1.LegacyAbac.enabled

class google.cloud.container_v1.types.ListClustersRequest#

ListClustersRequest lists clusters.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides, or “-” for all zones. This field has been deprecated and replaced by the parent field.

parent#

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

parent

Field google.container.v1.ListClustersRequest.parent

project_id

Field google.container.v1.ListClustersRequest.project_id

zone

Field google.container.v1.ListClustersRequest.zone

class google.cloud.container_v1.types.ListClustersResponse#

ListClustersResponse is the result of ListClustersRequest.

clusters#

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

missing_zones#

If any zones are listed here, the list of clusters returned may be missing those zones.

clusters

Field google.container.v1.ListClustersResponse.clusters

missing_zones

Field google.container.v1.ListClustersResponse.missing_zones

class google.cloud.container_v1.types.ListNodePoolsRequest#

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

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.

cluster_id#

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

parent#

The parent (project, location, cluster id) where the node pools will be listed. Specified in the format ‘projects//locations//clusters/*’.

cluster_id

Field google.container.v1.ListNodePoolsRequest.cluster_id

parent

Field google.container.v1.ListNodePoolsRequest.parent

project_id

Field google.container.v1.ListNodePoolsRequest.project_id

zone

Field google.container.v1.ListNodePoolsRequest.zone

class google.cloud.container_v1.types.ListNodePoolsResponse#

ListNodePoolsResponse is the result of ListNodePoolsRequest.

node_pools#

A list of node pools for a cluster.

node_pools

Field google.container.v1.ListNodePoolsResponse.node_pools

class google.cloud.container_v1.types.ListOperationsRequest#

ListOperationsRequest lists operations.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

zone#

Deprecated. The name of the Google Compute Engine zone to return operations for, or - for all zones. This field has been deprecated and replaced by the parent field.

parent#

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

parent

Field google.container.v1.ListOperationsRequest.parent

project_id

Field google.container.v1.ListOperationsRequest.project_id

zone

Field google.container.v1.ListOperationsRequest.zone

class google.cloud.container_v1.types.ListOperationsResponse#

ListOperationsResponse is the result of ListOperationsRequest.

operations#

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

missing_zones#

If any zones are listed here, the list of operations returned may be missing the operations from those zones.

missing_zones

Field google.container.v1.ListOperationsResponse.missing_zones

operations

Field google.container.v1.ListOperationsResponse.operations

class google.cloud.container_v1.types.MaintenancePolicy#

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

window#

Specifies the maintenance window in which maintenance may be performed.

window

Field google.container.v1.MaintenancePolicy.window

class google.cloud.container_v1.types.MaintenanceWindow#

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

daily_maintenance_window#

DailyMaintenanceWindow specifies a daily maintenance operation window.

daily_maintenance_window

Field google.container.v1.MaintenanceWindow.daily_maintenance_window

class google.cloud.container_v1.types.MasterAuth#

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

username#

The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, you can disable basic authentication by providing an empty username.

password#

The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty.

client_certificate_config#

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

cluster_ca_certificate#

[Output only] Base64-encoded public certificate that is the root of trust for the cluster.

client_certificate#

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

client_key#

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

client_certificate

Field google.container.v1.MasterAuth.client_certificate

client_certificate_config

Field google.container.v1.MasterAuth.client_certificate_config

client_key

Field google.container.v1.MasterAuth.client_key

cluster_ca_certificate

Field google.container.v1.MasterAuth.cluster_ca_certificate

password

Field google.container.v1.MasterAuth.password

username

Field google.container.v1.MasterAuth.username

class google.cloud.container_v1.types.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.

enabled#

Whether or not master authorized networks is enabled.

cidr_blocks#

cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.

class CidrBlock#

CidrBlock contains an optional name and one CIDR block.

display_name#

display_name is an optional field for users to identify CIDR blocks.

cidr_block#

cidr_block must be specified in CIDR notation.

cidr_block

Field google.container.v1.MasterAuthorizedNetworksConfig.CidrBlock.cidr_block

display_name

Field google.container.v1.MasterAuthorizedNetworksConfig.CidrBlock.display_name

cidr_blocks

Field google.container.v1.MasterAuthorizedNetworksConfig.cidr_blocks

enabled

Field google.container.v1.MasterAuthorizedNetworksConfig.enabled

class google.cloud.container_v1.types.NetworkConfig#

NetworkConfig reports the relative names of network & subnetwork.

network#

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

subnetwork#

Output only. The relative name of the Google Compute Engine subnetwork to which the cluster is connected. Example: projects/my-project/regions/us- central1/subnetworks/my-subnet

network

Field google.container.v1.NetworkConfig.network

subnetwork

Field google.container.v1.NetworkConfig.subnetwork

class google.cloud.container_v1.types.NetworkPolicy#

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

provider#

The selected network policy provider.

enabled#

Whether network policy is enabled on the cluster.

enabled

Field google.container.v1.NetworkPolicy.enabled

provider

Field google.container.v1.NetworkPolicy.provider

class google.cloud.container_v1.types.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.

disabled#

Whether NetworkPolicy is enabled for this cluster.

disabled

Field google.container.v1.NetworkPolicyConfig.disabled

class google.cloud.container_v1.types.NodeConfig#

Parameters that describe the nodes in a cluster.

machine_type#

The name of a Google Compute Engine machine type (e.g. n1-standard-1). If unspecified, the default machine type is n1-standard-1.

disk_size_gb#

Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.

oauth_scopes#

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). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.

service_account#

The Google Cloud Platform Service Account to be used by the node VMs. If no Service Account is specified, the “default” service account is used.

metadata#

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” “enable- os-login” “gci-update-strategy” “gci-ensure-gke-docker” “instance-template” “kube-env” “startup-script” “user-data” 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.

image_type#

The image type to use for this node. Note that for a given image type, the latest version of it will be used.

labels#

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/

local_ssd_count#

The number of local SSD disks to be attached to the node. The limit for this value is dependant upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local- ssd#local_ssd_limits for more information.

tags#

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.

preemptible#

Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.

accelerators#

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.

disk_type#

Type of the disk attached to each node (e.g. ‘pd-standard’ or ‘pd-ssd’) If unspecified, the default disk type is ‘pd- standard’

min_cpu_platform#

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

class LabelsEntry#
key#

Field google.container.v1.NodeConfig.LabelsEntry.key

value#

Field google.container.v1.NodeConfig.LabelsEntry.value

class MetadataEntry#
key#

Field google.container.v1.NodeConfig.MetadataEntry.key

value#

Field google.container.v1.NodeConfig.MetadataEntry.value

accelerators

Field google.container.v1.NodeConfig.accelerators

disk_size_gb

Field google.container.v1.NodeConfig.disk_size_gb

disk_type

Field google.container.v1.NodeConfig.disk_type

image_type

Field google.container.v1.NodeConfig.image_type

labels

Field google.container.v1.NodeConfig.labels

local_ssd_count

Field google.container.v1.NodeConfig.local_ssd_count

machine_type

Field google.container.v1.NodeConfig.machine_type

metadata

Field google.container.v1.NodeConfig.metadata

min_cpu_platform

Field google.container.v1.NodeConfig.min_cpu_platform

oauth_scopes

Field google.container.v1.NodeConfig.oauth_scopes

preemptible

Field google.container.v1.NodeConfig.preemptible

service_account

Field google.container.v1.NodeConfig.service_account

tags

Field google.container.v1.NodeConfig.tags

class google.cloud.container_v1.types.NodeManagement#

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

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.

auto_repair#

A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.

upgrade_options#

Specifies the Auto Upgrade knobs for the node pool.

auto_repair

Field google.container.v1.NodeManagement.auto_repair

auto_upgrade

Field google.container.v1.NodeManagement.auto_upgrade

upgrade_options

Field google.container.v1.NodeManagement.upgrade_options

class google.cloud.container_v1.types.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.

name#

The name of the node pool.

config#

The node configuration of the pool.

initial_node_count#

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.

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

version#

The version of the Kubernetes of this node.

instance_group_urls#

[Output only] The resource URLs of the managed instance groups associated with this node pool.

status#

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

status_message#

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

autoscaling#

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

management#

NodeManagement configuration for this NodePool.

autoscaling

Field google.container.v1.NodePool.autoscaling

config

Field google.container.v1.NodePool.config

initial_node_count

Field google.container.v1.NodePool.initial_node_count

instance_group_urls

Field google.container.v1.NodePool.instance_group_urls

management

Field google.container.v1.NodePool.management

name

Field google.container.v1.NodePool.name

self_link

Field google.container.v1.NodePool.self_link

status

Field google.container.v1.NodePool.status

status_message

Field google.container.v1.NodePool.status_message

version

Field google.container.v1.NodePool.version

class google.cloud.container_v1.types.NodePoolAutoscaling#

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

enabled#

Is autoscaling enabled for this node pool.

min_node_count#

Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count.

max_node_count#

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

enabled

Field google.container.v1.NodePoolAutoscaling.enabled

max_node_count

Field google.container.v1.NodePoolAutoscaling.max_node_count

min_node_count

Field google.container.v1.NodePoolAutoscaling.min_node_count

class google.cloud.container_v1.types.Operation#

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

name#

The server-assigned ID for the operation.

zone#

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.

operation_type#

The operation type.

status#

The current status of the operation.

detail#

Detailed operation progress, if available.

status_message#

If an error has occurred, a textual description of the error.

Server-defined URL for the resource.

Server-defined URL for the target of the operation.

location#

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.

start_time#

[Output only] The time the operation started, in RFC3339 text format.

end_time#

[Output only] The time the operation completed, in RFC3339 text format.

detail

Field google.container.v1.Operation.detail

end_time

Field google.container.v1.Operation.end_time

location

Field google.container.v1.Operation.location

name

Field google.container.v1.Operation.name

operation_type

Field google.container.v1.Operation.operation_type

self_link

Field google.container.v1.Operation.self_link

start_time

Field google.container.v1.Operation.start_time

status

Field google.container.v1.Operation.status

status_message

Field google.container.v1.Operation.status_message

target_link

Field google.container.v1.Operation.target_link

zone

Field google.container.v1.Operation.zone

class google.cloud.container_v1.types.PrivateClusterConfig#

Configuration options for private clusters.

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.

enable_private_endpoint#

Whether the master’s internal IP address is used as the cluster endpoint.

master_ipv4_cidr_block#

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.

private_endpoint#

Output only. The internal IP address of this cluster’s master endpoint.

public_endpoint#

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

enable_private_endpoint

Field google.container.v1.PrivateClusterConfig.enable_private_endpoint

enable_private_nodes

Field google.container.v1.PrivateClusterConfig.enable_private_nodes

master_ipv4_cidr_block

Field google.container.v1.PrivateClusterConfig.master_ipv4_cidr_block

private_endpoint

Field google.container.v1.PrivateClusterConfig.private_endpoint

public_endpoint

Field google.container.v1.PrivateClusterConfig.public_endpoint

class google.cloud.container_v1.types.RollbackNodePoolUpgradeRequest#

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

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

cluster_id#

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

node_pool_id#

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

name#

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

cluster_id

Field google.container.v1.RollbackNodePoolUpgradeRequest.cluster_id

name

Field google.container.v1.RollbackNodePoolUpgradeRequest.name

node_pool_id

Field google.container.v1.RollbackNodePoolUpgradeRequest.node_pool_id

project_id

Field google.container.v1.RollbackNodePoolUpgradeRequest.project_id

zone

Field google.container.v1.RollbackNodePoolUpgradeRequest.zone

class google.cloud.container_v1.types.ServerConfig#

Kubernetes Engine service configuration.

default_cluster_version#

Version of Kubernetes the service deploys by default.

valid_node_versions#

List of valid node upgrade target versions.

default_image_type#

Default image type.

valid_image_types#

List of valid image types.

valid_master_versions#

List of valid master versions.

default_cluster_version

Field google.container.v1.ServerConfig.default_cluster_version

default_image_type

Field google.container.v1.ServerConfig.default_image_type

valid_image_types

Field google.container.v1.ServerConfig.valid_image_types

valid_master_versions

Field google.container.v1.ServerConfig.valid_master_versions

valid_node_versions

Field google.container.v1.ServerConfig.valid_node_versions

class google.cloud.container_v1.types.SetAddonsConfigRequest#

SetAddonsConfigRequest sets the addons associated with the cluster.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

cluster_id#

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

addons_config#

The desired configurations for the various addons available to run in the cluster.

name#

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

addons_config

Field google.container.v1.SetAddonsConfigRequest.addons_config

cluster_id

Field google.container.v1.SetAddonsConfigRequest.cluster_id

name

Field google.container.v1.SetAddonsConfigRequest.name

project_id

Field google.container.v1.SetAddonsConfigRequest.project_id

zone

Field google.container.v1.SetAddonsConfigRequest.zone

class google.cloud.container_v1.types.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

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

cluster_id#

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

resource_labels#

The labels to set for that cluster.

label_fingerprint#

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.

name#

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

class ResourceLabelsEntry#
key#

Field google.container.v1.SetLabelsRequest.ResourceLabelsEntry.key

value#

Field google.container.v1.SetLabelsRequest.ResourceLabelsEntry.value

cluster_id

Field google.container.v1.SetLabelsRequest.cluster_id

label_fingerprint

Field google.container.v1.SetLabelsRequest.label_fingerprint

name

Field google.container.v1.SetLabelsRequest.name

project_id

Field google.container.v1.SetLabelsRequest.project_id

resource_labels

Field google.container.v1.SetLabelsRequest.resource_labels

zone

Field google.container.v1.SetLabelsRequest.zone

class google.cloud.container_v1.types.SetLegacyAbacRequest#

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

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

cluster_id#

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

enabled#

Whether ABAC authorization will be enabled in the cluster.

name#

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

cluster_id

Field google.container.v1.SetLegacyAbacRequest.cluster_id

enabled

Field google.container.v1.SetLegacyAbacRequest.enabled

name

Field google.container.v1.SetLegacyAbacRequest.name

project_id

Field google.container.v1.SetLegacyAbacRequest.project_id

zone

Field google.container.v1.SetLegacyAbacRequest.zone

class google.cloud.container_v1.types.SetLocationsRequest#

SetLocationsRequest sets the locations of the cluster.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

cluster_id#

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

locations#

The desired list of Google Compute Engine locations in which the cluster’s nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster’s primary zone.

name#

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

cluster_id

Field google.container.v1.SetLocationsRequest.cluster_id

locations

Field google.container.v1.SetLocationsRequest.locations

name

Field google.container.v1.SetLocationsRequest.name

project_id

Field google.container.v1.SetLocationsRequest.project_id

zone

Field google.container.v1.SetLocationsRequest.zone

class google.cloud.container_v1.types.SetLoggingServiceRequest#

SetLoggingServiceRequest sets the logging service of a cluster.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

cluster_id#

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

logging_service#

The logging service the cluster should use to write metrics. Currently available options: - “logging.googleapis.com” - the Google Cloud Logging service - “none” - no metrics will be exported from the cluster

name#

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

cluster_id

Field google.container.v1.SetLoggingServiceRequest.cluster_id

logging_service

Field google.container.v1.SetLoggingServiceRequest.logging_service

name

Field google.container.v1.SetLoggingServiceRequest.name

project_id

Field google.container.v1.SetLoggingServiceRequest.project_id

zone

Field google.container.v1.SetLoggingServiceRequest.zone

class google.cloud.container_v1.types.SetMaintenancePolicyRequest#

SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

project_id#

The Google Developers Console project ID or project number.

zone#

The name of the Google Compute Engine zone in which the cluster resides.

cluster_id#

The name of the cluster to update.

maintenance_policy#

The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.

name#

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

cluster_id

Field google.container.v1.SetMaintenancePolicyRequest.cluster_id

maintenance_policy

Field google.container.v1.SetMaintenancePolicyRequest.maintenance_policy

name

Field google.container.v1.SetMaintenancePolicyRequest.name

project_id

Field google.container.v1.SetMaintenancePolicyRequest.project_id

zone

Field google.container.v1.SetMaintenancePolicyRequest.zone

class google.cloud.container_v1.types.SetMasterAuthRequest#

SetMasterAuthRequest updates the admin password of a cluster.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

cluster_id#

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

action#

The exact form of action to be taken on the master auth.

update#

A description of the update.

name#

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

action

Field google.container.v1.SetMasterAuthRequest.action

cluster_id

Field google.container.v1.SetMasterAuthRequest.cluster_id

name

Field google.container.v1.SetMasterAuthRequest.name

project_id

Field google.container.v1.SetMasterAuthRequest.project_id

update

Field google.container.v1.SetMasterAuthRequest.update

zone

Field google.container.v1.SetMasterAuthRequest.zone

class google.cloud.container_v1.types.SetMonitoringServiceRequest#

SetMonitoringServiceRequest sets the monitoring service of a cluster.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

cluster_id#

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

monitoring_service#

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

name#

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

cluster_id

Field google.container.v1.SetMonitoringServiceRequest.cluster_id

monitoring_service

Field google.container.v1.SetMonitoringServiceRequest.monitoring_service

name

Field google.container.v1.SetMonitoringServiceRequest.name

project_id

Field google.container.v1.SetMonitoringServiceRequest.project_id

zone

Field google.container.v1.SetMonitoringServiceRequest.zone

class google.cloud.container_v1.types.SetNetworkPolicyRequest#

SetNetworkPolicyRequest enables/disables network policy for a cluster.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

cluster_id#

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

network_policy#

Configuration options for the NetworkPolicy feature.

name#

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

cluster_id

Field google.container.v1.SetNetworkPolicyRequest.cluster_id

name

Field google.container.v1.SetNetworkPolicyRequest.name

network_policy

Field google.container.v1.SetNetworkPolicyRequest.network_policy

project_id

Field google.container.v1.SetNetworkPolicyRequest.project_id

zone

Field google.container.v1.SetNetworkPolicyRequest.zone

class google.cloud.container_v1.types.SetNodePoolAutoscalingRequest#

SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

cluster_id#

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

node_pool_id#

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

autoscaling#

Autoscaling configuration for the node pool.

name#

The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format ‘projects//locations//clusters//nodePools/’.

autoscaling

Field google.container.v1.SetNodePoolAutoscalingRequest.autoscaling

cluster_id

Field google.container.v1.SetNodePoolAutoscalingRequest.cluster_id

name

Field google.container.v1.SetNodePoolAutoscalingRequest.name

node_pool_id

Field google.container.v1.SetNodePoolAutoscalingRequest.node_pool_id

project_id

Field google.container.v1.SetNodePoolAutoscalingRequest.project_id

zone

Field google.container.v1.SetNodePoolAutoscalingRequest.zone

class google.cloud.container_v1.types.SetNodePoolManagementRequest#

SetNodePoolManagementRequest sets the node management properties of a node pool.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

cluster_id#

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

node_pool_id#

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

management#

NodeManagement configuration for the node pool.

name#

The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format ‘projects//locations//clusters//nodePools/’.

cluster_id

Field google.container.v1.SetNodePoolManagementRequest.cluster_id

management

Field google.container.v1.SetNodePoolManagementRequest.management

name

Field google.container.v1.SetNodePoolManagementRequest.name

node_pool_id

Field google.container.v1.SetNodePoolManagementRequest.node_pool_id

project_id

Field google.container.v1.SetNodePoolManagementRequest.project_id

zone

Field google.container.v1.SetNodePoolManagementRequest.zone

class google.cloud.container_v1.types.SetNodePoolSizeRequest#

SetNodePoolSizeRequest sets the size a node pool.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

cluster_id#

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

node_pool_id#

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

node_count#

The desired node count for the pool.

name#

The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format ‘projects//locations//clusters//nodePools/’.

cluster_id

Field google.container.v1.SetNodePoolSizeRequest.cluster_id

name

Field google.container.v1.SetNodePoolSizeRequest.name

node_count

Field google.container.v1.SetNodePoolSizeRequest.node_count

node_pool_id

Field google.container.v1.SetNodePoolSizeRequest.node_pool_id

project_id

Field google.container.v1.SetNodePoolSizeRequest.project_id

zone

Field google.container.v1.SetNodePoolSizeRequest.zone

class google.cloud.container_v1.types.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.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

cluster_id#

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

name#

The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format ‘projects//locations//clusters/*’.

rotate_credentials#

Whether to rotate credentials during IP rotation.

cluster_id

Field google.container.v1.StartIPRotationRequest.cluster_id

name

Field google.container.v1.StartIPRotationRequest.name

project_id

Field google.container.v1.StartIPRotationRequest.project_id

rotate_credentials

Field google.container.v1.StartIPRotationRequest.rotate_credentials

zone

Field google.container.v1.StartIPRotationRequest.zone

class google.cloud.container_v1.types.UpdateClusterRequest#

UpdateClusterRequest updates the settings of a cluster.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

cluster_id#

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

update#

A description of the update.

name#

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

cluster_id

Field google.container.v1.UpdateClusterRequest.cluster_id

name

Field google.container.v1.UpdateClusterRequest.name

project_id

Field google.container.v1.UpdateClusterRequest.project_id

update

Field google.container.v1.UpdateClusterRequest.update

zone

Field google.container.v1.UpdateClusterRequest.zone

class google.cloud.container_v1.types.UpdateMasterRequest#

UpdateMasterRequest updates the master of the cluster.

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

cluster_id#

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

master_version#

The Kubernetes version to change the master to. 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 default Kubernetes version

name#

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

cluster_id

Field google.container.v1.UpdateMasterRequest.cluster_id

master_version

Field google.container.v1.UpdateMasterRequest.master_version

name

Field google.container.v1.UpdateMasterRequest.name

project_id

Field google.container.v1.UpdateMasterRequest.project_id

zone

Field google.container.v1.UpdateMasterRequest.zone

class google.cloud.container_v1.types.UpdateNodePoolRequest#

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

project_id#

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone#

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

cluster_id#

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

node_pool_id#

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

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

image_type#

The desired image type for the node pool.

name#

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

cluster_id

Field google.container.v1.UpdateNodePoolRequest.cluster_id

image_type

Field google.container.v1.UpdateNodePoolRequest.image_type

name

Field google.container.v1.UpdateNodePoolRequest.name

node_pool_id

Field google.container.v1.UpdateNodePoolRequest.node_pool_id

node_version

Field google.container.v1.UpdateNodePoolRequest.node_version

project_id

Field google.container.v1.UpdateNodePoolRequest.project_id

zone

Field google.container.v1.UpdateNodePoolRequest.zone