{ "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "View and manage your data across Google Cloud Platform services" } } } }, "basePath": "", "baseUrl": "https://container.googleapis.com/", "batchPath": "batch", "canonicalName": "Container", "description": "Builds and manages container-based applications, powered by the open source Kubernetes technology.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/container-engine/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "id": "container:v1", "kind": "discovery#restDescription", "name": "container", "ownerDomain": "google.com", "ownerName": "Google", "parameters": { "$.xgafv": { "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "type": "string" }, "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" }, "alt": { "default": "json", "description": "Data format for response.", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "type": "string" }, "callback": { "description": "JSONP", "location": "query", "type": "string" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "type": "string" }, "key": { "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query", "type": "string" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "prettyPrint": { "default": "true", "description": "Returns response with indentations and line breaks.", "location": "query", "type": "boolean" }, "quotaUser": { "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query", "type": "string" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" } }, "protocol": "rest", "resources": { "projects": { "resources": { "aggregated": { "resources": { "usableSubnetworks": { "methods": { "list": { "description": "Lists subnetworks that are usable for creating clusters in a project.", "flatPath": "v1/projects/{projectsId}/aggregated/usableSubnetworks", "httpMethod": "GET", "id": "container.projects.aggregated.usableSubnetworks.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { "description": "Filtering currently only supports equality on the networkProjectId and must\nbe in the form: \"networkProjectId=[PROJECTID]\", where `networkProjectId`\nis the project which owns the listed subnetworks. This defaults to the\nparent project ID.", "location": "query", "type": "string" }, "pageSize": { "description": "The max number of results per page that should be returned. If the number\nof available results is larger than `page_size`, a `next_page_token` is\nreturned which can be used to get the next page of results in subsequent\nrequests. Acceptable values are 0 to 500, inclusive. (Default: 500)", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { "description": "Specifies a page token to use. Set this to the nextPageToken returned by\nprevious list requests to get the next page of results.", "location": "query", "type": "string" }, "parent": { "description": "The parent project where subnetworks are usable.\nSpecified in the format 'projects/*'.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+parent}/aggregated/usableSubnetworks", "response": { "$ref": "ListUsableSubnetworksResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } }, "locations": { "methods": { "getServerConfig": { "description": "Returns configuration info about the Google Kubernetes Engine service.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serverConfig", "httpMethod": "GET", "id": "container.projects.locations.getServerConfig", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name (project and location) of the server config to get,\nspecified in the format 'projects/*/locations/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) to return operations for.\nThis field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } }, "path": "v1/{+name}/serverConfig", "response": { "$ref": "ServerConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "clusters": { "methods": { "completeIpRotation": { "description": "Completes master IP rotation.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:completeIpRotation", "httpMethod": "POST", "id": "container.projects.locations.clusters.completeIpRotation", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name (project, location, cluster id) of the cluster to complete IP\nrotation. Specified in the format 'projects/*/locations/*/clusters/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:completeIpRotation", "request": { "$ref": "CompleteIPRotationRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe Kubelet creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range the cluster is using.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters", "httpMethod": "POST", "id": "container.projects.locations.clusters.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+parent}/clusters", "request": { "$ref": "CreateClusterRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster,\nsuch as load balancer resources, are not deleted if they weren't present\nwhen the cluster was initially created.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", "httpMethod": "DELETE", "id": "container.projects.locations.clusters.delete", "parameterOrder": [ "name" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to delete.\nThis field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "name": { "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } }, "path": "v1/{+name}", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "description": "Gets the details of a specific cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", "httpMethod": "GET", "id": "container.projects.locations.clusters.get", "parameterOrder": [ "name" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to retrieve.\nThis field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "name": { "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } }, "path": "v1/{+name}", "response": { "$ref": "Cluster" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "getJwks": { "description": "Gets the public component of the cluster signing keys in\nJSON Web Key format.\nThis API is not yet intended for general use, and is not available for all\nclusters.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/jwks", "httpMethod": "GET", "id": "container.projects.locations.clusters.getJwks", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "The cluster (project, location, cluster id) to get keys for. Specified in\nthe format 'projects/*/locations/*/clusters/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+parent}/jwks", "response": { "$ref": "GetJSONWebKeysResponse" } }, "list": { "description": "Lists all clusters owned by a project in either the specified zone or all\nzones.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters", "httpMethod": "GET", "id": "container.projects.locations.clusters.list", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.\nThis field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" } }, "path": "v1/{+parent}/clusters", "response": { "$ref": "ListClustersResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setAddons": { "description": "Sets the addons for a specific cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setAddons", "httpMethod": "POST", "id": "container.projects.locations.clusters.setAddons", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name (project, location, cluster) of the cluster to set addons.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:setAddons", "request": { "$ref": "SetAddonsConfigRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setLegacyAbac": { "description": "Enables or disables the ABAC authorization mechanism on a cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLegacyAbac", "httpMethod": "POST", "id": "container.projects.locations.clusters.setLegacyAbac", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:setLegacyAbac", "request": { "$ref": "SetLegacyAbacRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setLocations": { "description": "Sets the locations for a specific cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLocations", "httpMethod": "POST", "id": "container.projects.locations.clusters.setLocations", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name (project, location, cluster) of the cluster to set locations.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:setLocations", "request": { "$ref": "SetLocationsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setLogging": { "description": "Sets the logging service for a specific cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLogging", "httpMethod": "POST", "id": "container.projects.locations.clusters.setLogging", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name (project, location, cluster) of the cluster to set logging.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:setLogging", "request": { "$ref": "SetLoggingServiceRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setMaintenancePolicy": { "description": "Sets the maintenance policy for a cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMaintenancePolicy", "httpMethod": "POST", "id": "container.projects.locations.clusters.setMaintenancePolicy", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name (project, location, cluster id) of the cluster to set maintenance\npolicy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:setMaintenancePolicy", "request": { "$ref": "SetMaintenancePolicyRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setMasterAuth": { "description": "Sets master auth materials. Currently supports changing the admin password\nor a specific cluster, either via password generation or explicitly setting\nthe password.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMasterAuth", "httpMethod": "POST", "id": "container.projects.locations.clusters.setMasterAuth", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:setMasterAuth", "request": { "$ref": "SetMasterAuthRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setMonitoring": { "description": "Sets the monitoring service for a specific cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMonitoring", "httpMethod": "POST", "id": "container.projects.locations.clusters.setMonitoring", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name (project, location, cluster) of the cluster to set monitoring.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:setMonitoring", "request": { "$ref": "SetMonitoringServiceRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setNetworkPolicy": { "description": "Enables or disables Network Policy for a cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setNetworkPolicy", "httpMethod": "POST", "id": "container.projects.locations.clusters.setNetworkPolicy", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name (project, location, cluster id) of the cluster to set networking\npolicy. Specified in the format 'projects/*/locations/*/clusters/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:setNetworkPolicy", "request": { "$ref": "SetNetworkPolicyRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setResourceLabels": { "description": "Sets labels on a cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setResourceLabels", "httpMethod": "POST", "id": "container.projects.locations.clusters.setResourceLabels", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:setResourceLabels", "request": { "$ref": "SetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "startIpRotation": { "description": "Starts master IP rotation.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:startIpRotation", "httpMethod": "POST", "id": "container.projects.locations.clusters.startIpRotation", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name (project, location, cluster id) of the cluster to start IP\nrotation. Specified in the format 'projects/*/locations/*/clusters/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:startIpRotation", "request": { "$ref": "StartIPRotationRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "update": { "description": "Updates the settings of a specific cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", "httpMethod": "PUT", "id": "container.projects.locations.clusters.update", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "request": { "$ref": "UpdateClusterRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "updateMaster": { "description": "Updates the master for a specific cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:updateMaster", "httpMethod": "POST", "id": "container.projects.locations.clusters.updateMaster", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:updateMaster", "request": { "$ref": "UpdateMasterRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "nodePools": { "methods": { "create": { "description": "Creates a node pool for a cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools", "httpMethod": "POST", "id": "container.projects.locations.clusters.nodePools.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "The parent (project, location, cluster id) where the node pool will be\ncreated. Specified in the format\n'projects/*/locations/*/clusters/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+parent}/nodePools", "request": { "$ref": "CreateNodePoolRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "description": "Deletes a node pool from a cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}", "httpMethod": "DELETE", "id": "container.projects.locations.clusters.nodePools.delete", "parameterOrder": [ "name" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster.\nThis field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "name": { "description": "The name (project, location, cluster, node pool id) of the node pool to\ndelete. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to delete.\nThis field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } }, "path": "v1/{+name}", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "description": "Retrieves the requested node pool.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}", "httpMethod": "GET", "id": "container.projects.locations.clusters.nodePools.get", "parameterOrder": [ "name" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster.\nThis field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "name": { "description": "The name (project, location, cluster, node pool id) of the node pool to\nget. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool.\nThis field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } }, "path": "v1/{+name}", "response": { "$ref": "NodePool" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "description": "Lists the node pools for a cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools", "httpMethod": "GET", "id": "container.projects.locations.clusters.nodePools.list", "parameterOrder": [ "parent" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster.\nThis field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" }, "parent": { "description": "The parent (project, location, cluster id) where the node pools will be\nlisted. Specified in the format 'projects/*/locations/*/clusters/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" } }, "path": "v1/{+parent}/nodePools", "response": { "$ref": "ListNodePoolsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "rollback": { "description": "Rolls back a previously Aborted or Failed NodePool upgrade.\nThis makes no changes if the last upgrade successfully completed.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:rollback", "httpMethod": "POST", "id": "container.projects.locations.clusters.nodePools.rollback", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:rollback", "request": { "$ref": "RollbackNodePoolUpgradeRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setAutoscaling": { "description": "Sets the autoscaling settings for the specified node pool.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setAutoscaling", "httpMethod": "POST", "id": "container.projects.locations.clusters.nodePools.setAutoscaling", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name (project, location, cluster, node pool) of the node pool to set\nautoscaler settings. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:setAutoscaling", "request": { "$ref": "SetNodePoolAutoscalingRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setManagement": { "description": "Sets the NodeManagement options for a node pool.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setManagement", "httpMethod": "POST", "id": "container.projects.locations.clusters.nodePools.setManagement", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name (project, location, cluster, node pool id) of the node pool to set\nmanagement properties. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:setManagement", "request": { "$ref": "SetNodePoolManagementRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setSize": { "description": "Sets the size for a specific node pool.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setSize", "httpMethod": "POST", "id": "container.projects.locations.clusters.nodePools.setSize", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name (project, location, cluster, node pool id) of the node pool to set\nsize.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:setSize", "request": { "$ref": "SetNodePoolSizeRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "update": { "description": "Updates the version and/or image type for the specified node pool.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}", "httpMethod": "PUT", "id": "container.projects.locations.clusters.nodePools.update", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name (project, location, cluster, node pool) of the node pool to\nupdate. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "request": { "$ref": "UpdateNodePoolRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "well-known": { "methods": { "getOpenid-configuration": { "description": "Gets the OIDC discovery document for the cluster.\nSee the\n[OpenID Connect Discovery 1.0\nspecification](https://openid.net/specs/openid-connect-discovery-1_0.html)\nfor details.\nThis API is not yet intended for general use, and is not available for all\nclusters.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/.well-known/openid-configuration", "httpMethod": "GET", "id": "container.projects.locations.clusters.well-known.getOpenid-configuration", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "The cluster (project, location, cluster id) to get the discovery document\nfor. Specified in the format 'projects/*/locations/*/clusters/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+parent}/.well-known/openid-configuration", "response": { "$ref": "GetOpenIDConfigResponse" } } } } } }, "operations": { "methods": { "cancel": { "description": "Cancels the specified operation.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "container.projects.locations.operations.cancel", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:cancel", "request": { "$ref": "CancelOperationRequest" }, "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "description": "Gets the specified operation.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "id": "container.projects.locations.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, "operationId": { "description": "Required. Deprecated. The server-assigned `name` of the operation.\nThis field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } }, "path": "v1/{+name}", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "description": "Lists all operations in a project in a specific zone or all zones.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "httpMethod": "GET", "id": "container.projects.locations.operations.list", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) to return operations for, or `-` for\nall zones. This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" } }, "path": "v1/{+parent}/operations", "response": { "$ref": "ListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } }, "zones": { "methods": { "getServerconfig": { "description": "Returns configuration info about the Google Kubernetes Engine service.", "flatPath": "v1/projects/{projectId}/zones/{zone}/serverconfig", "httpMethod": "GET", "id": "container.projects.zones.getServerconfig", "parameterOrder": [ "projectId", "zone" ], "parameters": { "name": { "description": "The name (project and location) of the server config to get,\nspecified in the format 'projects/*/locations/*'.", "location": "query", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) to return operations for.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/serverconfig", "response": { "$ref": "ServerConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "clusters": { "methods": { "addons": { "description": "Sets the addons for a specific cluster.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons", "httpMethod": "POST", "id": "container.projects.zones.clusters.addons", "parameterOrder": [ "projectId", "zone", "clusterId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons", "request": { "$ref": "SetAddonsConfigRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "completeIpRotation": { "description": "Completes master IP rotation.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation", "httpMethod": "POST", "id": "container.projects.zones.clusters.completeIpRotation", "parameterOrder": [ "projectId", "zone", "clusterId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation", "request": { "$ref": "CompleteIPRotationRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe Kubelet creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range the cluster is using.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters", "httpMethod": "POST", "id": "container.projects.zones.clusters.create", "parameterOrder": [ "projectId", "zone" ], "parameters": { "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters", "request": { "$ref": "CreateClusterRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster,\nsuch as load balancer resources, are not deleted if they weren't present\nwhen the cluster was initially created.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", "httpMethod": "DELETE", "id": "container.projects.zones.clusters.delete", "parameterOrder": [ "projectId", "zone", "clusterId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to delete.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "name": { "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "location": "query", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "description": "Gets the details of a specific cluster.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", "httpMethod": "GET", "id": "container.projects.zones.clusters.get", "parameterOrder": [ "projectId", "zone", "clusterId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to retrieve.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "name": { "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "location": "query", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", "response": { "$ref": "Cluster" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "legacyAbac": { "description": "Enables or disables the ABAC authorization mechanism on a cluster.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac", "httpMethod": "POST", "id": "container.projects.zones.clusters.legacyAbac", "parameterOrder": [ "projectId", "zone", "clusterId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to update.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac", "request": { "$ref": "SetLegacyAbacRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "description": "Lists all clusters owned by a project in either the specified zone or all\nzones.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters", "httpMethod": "GET", "id": "container.projects.zones.clusters.list", "parameterOrder": [ "projectId", "zone" ], "parameters": { "parent": { "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.", "location": "query", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.\nThis field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters", "response": { "$ref": "ListClustersResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "locations": { "description": "Sets the locations for a specific cluster.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations", "httpMethod": "POST", "id": "container.projects.zones.clusters.locations", "parameterOrder": [ "projectId", "zone", "clusterId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations", "request": { "$ref": "SetLocationsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "logging": { "description": "Sets the logging service for a specific cluster.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging", "httpMethod": "POST", "id": "container.projects.zones.clusters.logging", "parameterOrder": [ "projectId", "zone", "clusterId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging", "request": { "$ref": "SetLoggingServiceRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "master": { "description": "Updates the master for a specific cluster.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master", "httpMethod": "POST", "id": "container.projects.zones.clusters.master", "parameterOrder": [ "projectId", "zone", "clusterId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master", "request": { "$ref": "UpdateMasterRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "monitoring": { "description": "Sets the monitoring service for a specific cluster.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring", "httpMethod": "POST", "id": "container.projects.zones.clusters.monitoring", "parameterOrder": [ "projectId", "zone", "clusterId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring", "request": { "$ref": "SetMonitoringServiceRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "resourceLabels": { "description": "Sets labels on a cluster.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels", "httpMethod": "POST", "id": "container.projects.zones.clusters.resourceLabels", "parameterOrder": [ "projectId", "zone", "clusterId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels", "request": { "$ref": "SetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setMaintenancePolicy": { "description": "Sets the maintenance policy for a cluster.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy", "httpMethod": "POST", "id": "container.projects.zones.clusters.setMaintenancePolicy", "parameterOrder": [ "projectId", "zone", "clusterId" ], "parameters": { "clusterId": { "description": "Required. The name of the cluster to update.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy", "request": { "$ref": "SetMaintenancePolicyRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setMasterAuth": { "description": "Sets master auth materials. Currently supports changing the admin password\nor a specific cluster, either via password generation or explicitly setting\nthe password.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth", "httpMethod": "POST", "id": "container.projects.zones.clusters.setMasterAuth", "parameterOrder": [ "projectId", "zone", "clusterId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth", "request": { "$ref": "SetMasterAuthRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setNetworkPolicy": { "description": "Enables or disables Network Policy for a cluster.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy", "httpMethod": "POST", "id": "container.projects.zones.clusters.setNetworkPolicy", "parameterOrder": [ "projectId", "zone", "clusterId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy", "request": { "$ref": "SetNetworkPolicyRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "startIpRotation": { "description": "Starts master IP rotation.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation", "httpMethod": "POST", "id": "container.projects.zones.clusters.startIpRotation", "parameterOrder": [ "projectId", "zone", "clusterId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation", "request": { "$ref": "StartIPRotationRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "update": { "description": "Updates the settings of a specific cluster.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", "httpMethod": "PUT", "id": "container.projects.zones.clusters.update", "parameterOrder": [ "projectId", "zone", "clusterId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", "request": { "$ref": "UpdateClusterRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "nodePools": { "methods": { "autoscaling": { "description": "Sets the autoscaling settings for the specified node pool.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling", "httpMethod": "POST", "id": "container.projects.zones.clusters.nodePools.autoscaling", "parameterOrder": [ "projectId", "zone", "clusterId", "nodePoolId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to upgrade.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling", "request": { "$ref": "SetNodePoolAutoscalingRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "description": "Creates a node pool for a cluster.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools", "httpMethod": "POST", "id": "container.projects.zones.clusters.nodePools.create", "parameterOrder": [ "projectId", "zone", "clusterId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster.\nThis field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools", "request": { "$ref": "CreateNodePoolRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "description": "Deletes a node pool from a cluster.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", "httpMethod": "DELETE", "id": "container.projects.zones.clusters.nodePools.delete", "parameterOrder": [ "projectId", "zone", "clusterId", "nodePoolId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "name": { "description": "The name (project, location, cluster, node pool id) of the node pool to\ndelete. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", "location": "query", "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to delete.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "description": "Retrieves the requested node pool.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", "httpMethod": "GET", "id": "container.projects.zones.clusters.nodePools.get", "parameterOrder": [ "projectId", "zone", "clusterId", "nodePoolId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "name": { "description": "The name (project, location, cluster, node pool id) of the node pool to\nget. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", "location": "query", "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", "response": { "$ref": "NodePool" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "description": "Lists the node pools for a cluster.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools", "httpMethod": "GET", "id": "container.projects.zones.clusters.nodePools.list", "parameterOrder": [ "projectId", "zone", "clusterId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster.\nThis field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "parent": { "description": "The parent (project, location, cluster id) where the node pools will be\nlisted. Specified in the format 'projects/*/locations/*/clusters/*'.", "location": "query", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools", "response": { "$ref": "ListNodePoolsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "rollback": { "description": "Rolls back a previously Aborted or Failed NodePool upgrade.\nThis makes no changes if the last upgrade successfully completed.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback", "httpMethod": "POST", "id": "container.projects.zones.clusters.nodePools.rollback", "parameterOrder": [ "projectId", "zone", "clusterId", "nodePoolId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to rollback.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to rollback.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback", "request": { "$ref": "RollbackNodePoolUpgradeRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setManagement": { "description": "Sets the NodeManagement options for a node pool.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement", "httpMethod": "POST", "id": "container.projects.zones.clusters.nodePools.setManagement", "parameterOrder": [ "projectId", "zone", "clusterId", "nodePoolId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to update.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to update.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement", "request": { "$ref": "SetNodePoolManagementRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setSize": { "description": "Sets the size for a specific node pool.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize", "httpMethod": "POST", "id": "container.projects.zones.clusters.nodePools.setSize", "parameterOrder": [ "projectId", "zone", "clusterId", "nodePoolId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to update.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to update.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize", "request": { "$ref": "SetNodePoolSizeRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "update": { "description": "Updates the version and/or image type for the specified node pool.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update", "httpMethod": "POST", "id": "container.projects.zones.clusters.nodePools.update", "parameterOrder": [ "projectId", "zone", "clusterId", "nodePoolId" ], "parameters": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to upgrade.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update", "request": { "$ref": "UpdateNodePoolRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } }, "operations": { "methods": { "cancel": { "description": "Cancels the specified operation.", "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel", "httpMethod": "POST", "id": "container.projects.zones.operations.cancel", "parameterOrder": [ "projectId", "zone", "operationId" ], "parameters": { "operationId": { "description": "Required. Deprecated. The server-assigned `name` of the operation.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel", "request": { "$ref": "CancelOperationRequest" }, "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "description": "Gets the specified operation.", "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}", "httpMethod": "GET", "id": "container.projects.zones.operations.get", "parameterOrder": [ "projectId", "zone", "operationId" ], "parameters": { "name": { "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.", "location": "query", "type": "string" }, "operationId": { "description": "Required. Deprecated. The server-assigned `name` of the operation.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "description": "Lists all operations in a project in a specific zone or all zones.", "flatPath": "v1/projects/{projectId}/zones/{zone}/operations", "httpMethod": "GET", "id": "container.projects.zones.operations.list", "parameterOrder": [ "projectId", "zone" ], "parameters": { "parent": { "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.", "location": "query", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) to return operations for, or `-` for\nall zones. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" } }, "path": "v1/projects/{projectId}/zones/{zone}/operations", "response": { "$ref": "ListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } } } }, "revision": "20191115", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { "description": "AcceleratorConfig represents a Hardware Accelerator request.", "id": "AcceleratorConfig", "properties": { "acceleratorCount": { "description": "The number of the accelerator cards exposed to an instance.", "format": "int64", "type": "string" }, "acceleratorType": { "description": "The accelerator type resource name. List of supported accelerators\n[here](/compute/docs/gpus)", "type": "string" } }, "type": "object" }, "AddonsConfig": { "description": "Configuration for the addons that can be automatically spun up in the\ncluster, enabling additional functionality.", "id": "AddonsConfig", "properties": { "cloudRunConfig": { "$ref": "CloudRunConfig", "description": "Configuration for the Cloud Run addon, which allows the user to use a\nmanaged Knative service." }, "horizontalPodAutoscaling": { "$ref": "HorizontalPodAutoscaling", "description": "Configuration for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods." }, "httpLoadBalancing": { "$ref": "HttpLoadBalancing", "description": "Configuration for the HTTP (L7) load balancing controller addon, which\nmakes it easy to set up HTTP load balancers for services in a cluster." }, "kubernetesDashboard": { "$ref": "KubernetesDashboard", "description": "Configuration for the Kubernetes Dashboard.\nThis addon is deprecated, and will be disabled in 1.15. It is recommended\nto use the Cloud Console to manage and monitor your Kubernetes clusters,\nworkloads and applications. For more information, see:\nhttps://cloud.google.com/kubernetes-engine/docs/concepts/dashboards" }, "networkPolicyConfig": { "$ref": "NetworkPolicyConfig", "description": "Configuration for NetworkPolicy. This only tracks whether the addon\nis enabled or not on the Master, it does not track whether network policy\nis enabled for the nodes." } }, "type": "object" }, "AuthenticatorGroupsConfig": { "description": "Configuration for returning group information from authenticators.", "id": "AuthenticatorGroupsConfig", "properties": { "enabled": { "description": "Whether this cluster should return group membership lookups\nduring authentication using a group of security groups.", "type": "boolean" }, "securityGroup": { "description": "The name of the security group-of-groups to be used. Only relevant\nif enabled = true.", "type": "string" } }, "type": "object" }, "AutoUpgradeOptions": { "description": "AutoUpgradeOptions defines the set of options for the user to control how\nthe Auto Upgrades will proceed.", "id": "AutoUpgradeOptions", "properties": { "autoUpgradeStartTime": { "description": "[Output only] This field is set when upgrades are about to commence\nwith the approximate start time for the upgrades, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "type": "string" }, "description": { "description": "[Output only] This field is set when upgrades are about to commence\nwith the description of the upgrade.", "type": "string" } }, "type": "object" }, "AutoprovisioningNodePoolDefaults": { "description": "AutoprovisioningNodePoolDefaults contains defaults for a node pool created\nby NAP.", "id": "AutoprovisioningNodePoolDefaults", "properties": { "oauthScopes": { "description": "Scopes that are used by NAP when creating node pools. If oauth_scopes are\nspecified, service_account should be empty.", "items": { "type": "string" }, "type": "array" }, "serviceAccount": { "description": "The Google Cloud Platform Service Account to be used by the node VMs. If\nservice_account is specified, scopes should be empty.", "type": "string" } }, "type": "object" }, "BigQueryDestination": { "description": "Parameters for using BigQuery as the destination of resource usage export.", "id": "BigQueryDestination", "properties": { "datasetId": { "description": "The ID of a BigQuery Dataset.", "type": "string" } }, "type": "object" }, "BinaryAuthorization": { "description": "Configuration for Binary Authorization.", "id": "BinaryAuthorization", "properties": { "enabled": { "description": "Enable Binary Authorization for this cluster. If enabled, all container\nimages will be validated by Binary Authorization.", "type": "boolean" } }, "type": "object" }, "CancelOperationRequest": { "description": "CancelOperationRequest cancels a single operation.", "id": "CancelOperationRequest", "properties": { "name": { "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'.", "type": "string" }, "operationId": { "description": "Required. Deprecated. The server-assigned `name` of the operation.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.\nThis field has been deprecated and replaced by the name field.", "type": "string" } }, "type": "object" }, "CidrBlock": { "description": "CidrBlock contains an optional name and one CIDR block.", "id": "CidrBlock", "properties": { "cidrBlock": { "description": "cidr_block must be specified in CIDR notation.", "type": "string" }, "displayName": { "description": "display_name is an optional field for users to identify CIDR blocks.", "type": "string" } }, "type": "object" }, "ClientCertificateConfig": { "description": "Configuration for client certificates on the cluster.", "id": "ClientCertificateConfig", "properties": { "issueClientCertificate": { "description": "Issue a client certificate.", "type": "boolean" } }, "type": "object" }, "CloudRunConfig": { "description": "Configuration options for the Cloud Run feature.", "id": "CloudRunConfig", "properties": { "disabled": { "description": "Whether Cloud Run addon is enabled for this cluster.", "type": "boolean" } }, "type": "object" }, "Cluster": { "description": "A Google Kubernetes Engine cluster.", "id": "Cluster", "properties": { "addonsConfig": { "$ref": "AddonsConfig", "description": "Configurations for the various addons available to run in the cluster." }, "authenticatorGroupsConfig": { "$ref": "AuthenticatorGroupsConfig", "description": "Configuration controlling RBAC group membership information." }, "autoscaling": { "$ref": "ClusterAutoscaling", "description": "Cluster-level autoscaling configuration." }, "binaryAuthorization": { "$ref": "BinaryAuthorization", "description": "Configuration for Binary Authorization." }, "clusterIpv4Cidr": { "description": "The IP address range of the container pods in this cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`). Leave blank to have\none automatically chosen or specify a `/14` block in `10.0.0.0/8`.", "type": "string" }, "conditions": { "description": "Which conditions caused the current cluster state.", "items": { "$ref": "StatusCondition" }, "type": "array" }, "createTime": { "description": "[Output only] The time the cluster was created, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "type": "string" }, "currentMasterVersion": { "description": "[Output only] The current software version of the master endpoint.", "type": "string" }, "currentNodeCount": { "description": "[Output only] The number of nodes currently in the cluster. Deprecated.\nCall Kubernetes API directly to retrieve node information.", "format": "int32", "type": "integer" }, "currentNodeVersion": { "description": "[Output only] Deprecated, use\n[NodePools.version](/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools)\ninstead. The current version of the node software components. If they are\ncurrently at multiple versions because they're in the process of being\nupgraded, this reflects the minimum version of all nodes.", "type": "string" }, "databaseEncryption": { "$ref": "DatabaseEncryption", "description": "Configuration of etcd encryption." }, "defaultMaxPodsConstraint": { "$ref": "MaxPodsConstraint", "description": "The default constraint on the maximum number of pods that can be run\nsimultaneously on a node in the node pool of this cluster. Only honored\nif cluster created with IP Alias support." }, "description": { "description": "An optional description of this cluster.", "type": "string" }, "enableKubernetesAlpha": { "description": "Kubernetes alpha features are enabled on this cluster. This includes alpha\nAPI groups (e.g. v1alpha1) and features that may not be production ready in\nthe kubernetes version of the master and nodes.\nThe cluster has no SLA for uptime and master/node upgrades are disabled.\nAlpha enabled clusters are automatically deleted thirty days after\ncreation.", "type": "boolean" }, "enableTpu": { "description": "Enable the ability to use Cloud TPUs in this cluster.", "type": "boolean" }, "endpoint": { "description": "[Output only] The IP address of this cluster's master endpoint.\nThe endpoint can be accessed from the internet at\n`https://username:password@endpoint/`.\n\nSee the `masterAuth` property of this resource for username and\npassword information.", "type": "string" }, "expireTime": { "description": "[Output only] The time the cluster will be automatically\ndeleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "type": "string" }, "initialClusterVersion": { "description": "The initial Kubernetes version for this cluster. Valid versions are those\nfound in validMasterVersions returned by getServerConfig. The version can\nbe upgraded over time; such upgrades are reflected in\ncurrentMasterVersion and currentNodeVersion.\n\nUsers may specify either explicit versions offered by\nKubernetes Engine or version aliases, which have the following behavior:\n\n- \"latest\": picks the highest valid Kubernetes version\n- \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version\n- \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version\n- \"1.X.Y-gke.N\": picks an explicit Kubernetes version\n- \"\",\"-\": picks the default Kubernetes version", "type": "string" }, "initialNodeCount": { "description": "The number of nodes to create in this cluster. You must ensure that your\nCompute Engine \u003ca href=\"/compute/docs/resource-quotas\"\u003eresource quota\u003c/a\u003e\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"node_config\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\n\nThis field is deprecated, use node_pool.initial_node_count instead.", "format": "int32", "type": "integer" }, "instanceGroupUrls": { "description": "Deprecated. Use node_pools.instance_group_urls.", "items": { "type": "string" }, "type": "array" }, "ipAllocationPolicy": { "$ref": "IPAllocationPolicy", "description": "Configuration for cluster IP allocation." }, "labelFingerprint": { "description": "The fingerprint of the set of labels for this cluster.", "type": "string" }, "legacyAbac": { "$ref": "LegacyAbac", "description": "Configuration for the legacy ABAC authorization mode." }, "location": { "description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/regions-zones/regions-zones#available) or\n[region](/compute/docs/regions-zones/regions-zones#available) in which\nthe cluster resides.", "type": "string" }, "locations": { "description": "The list of Google Compute Engine\n[zones](/compute/docs/zones#available) in which the cluster's nodes\nshould be located.", "items": { "type": "string" }, "type": "array" }, "loggingService": { "description": "The logging service the cluster should use to write logs.\nCurrently available options:\n\n* \"logging.googleapis.com/kubernetes\" - the Google Cloud Logging\nservice with Kubernetes-native resource model\n* `logging.googleapis.com` - the Google Cloud Logging service.\n* `none` - no logs will be exported from the cluster.\n* if left as an empty string,`logging.googleapis.com` will be used.", "type": "string" }, "maintenancePolicy": { "$ref": "MaintenancePolicy", "description": "Configure the maintenance policy for this cluster." }, "masterAuth": { "$ref": "MasterAuth", "description": "The authentication information for accessing the master endpoint.\nIf unspecified, the defaults are used:\nFor clusters before v1.12, if master_auth is unspecified, `username` will\nbe set to \"admin\", a random password will be generated, and a client\ncertificate will be issued." }, "masterAuthorizedNetworksConfig": { "$ref": "MasterAuthorizedNetworksConfig", "description": "The configuration options for master authorized networks feature." }, "monitoringService": { "description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* `monitoring.googleapis.com` - the Google Cloud Monitoring service.\n* `none` - no metrics will be exported from the cluster.\n* if left as an empty string, `monitoring.googleapis.com` will be used.", "type": "string" }, "name": { "description": "The name of this cluster. The name must be unique within this project\nand location (e.g. zone or region), and can be up to 40 characters with\nthe following restrictions:\n\n* Lowercase letters, numbers, and hyphens only.\n* Must start with a letter.\n* Must end with a number or a letter.", "type": "string" }, "network": { "description": "The name of the Google Compute Engine\n[network](/compute/docs/networks-and-firewalls#networks) to which the\ncluster is connected. If left unspecified, the `default` network\nwill be used.", "type": "string" }, "networkConfig": { "$ref": "NetworkConfig", "description": "Configuration for cluster networking." }, "networkPolicy": { "$ref": "NetworkPolicy", "description": "Configuration options for the NetworkPolicy feature." }, "nodeConfig": { "$ref": "NodeConfig", "description": "Parameters used in creating the cluster's nodes.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"initial_node_count\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\nFor responses, this field will be populated with the node configuration of\nthe first node pool. (For configuration of each node pool, see\n`node_pool.config`)\n\nIf unspecified, the defaults are used.\nThis field is deprecated, use node_pool.config instead." }, "nodeIpv4CidrSize": { "description": "[Output only] The size of the address space on each node for hosting\ncontainers. This is provisioned from within the `container_ipv4_cidr`\nrange. This field will only be set when cluster is in route-based network\nmode.", "format": "int32", "type": "integer" }, "nodePools": { "description": "The node pools associated with this cluster.\nThis field should not be set if \"node_config\" or \"initial_node_count\" are\nspecified.", "items": { "$ref": "NodePool" }, "type": "array" }, "privateClusterConfig": { "$ref": "PrivateClusterConfig", "description": "Configuration for private cluster." }, "resourceLabels": { "additionalProperties": { "type": "string" }, "description": "The resource labels for the cluster to use to annotate any related\nGoogle Compute Engine resources.", "type": "object" }, "resourceUsageExportConfig": { "$ref": "ResourceUsageExportConfig", "description": "Configuration for exporting resource usages. Resource usage export is\ndisabled when this config is unspecified." }, "selfLink": { "description": "[Output only] Server-defined URL for the resource.", "type": "string" }, "servicesIpv4Cidr": { "description": "[Output only] The IP address range of the Kubernetes services in\nthis cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `1.2.3.4/29`). Service addresses are\ntypically put in the last `/16` from the container CIDR.", "type": "string" }, "status": { "description": "[Output only] The current status of this cluster.", "enum": [ "STATUS_UNSPECIFIED", "PROVISIONING", "RUNNING", "RECONCILING", "STOPPING", "ERROR", "DEGRADED" ], "enumDescriptions": [ "Not set.", "The PROVISIONING state indicates the cluster is being created.", "The RUNNING state indicates the cluster has been created and is fully\nusable.", "The RECONCILING state indicates that some work is actively being done on\nthe cluster, such as upgrading the master or node software. Details can\nbe found in the `statusMessage` field.", "The STOPPING state indicates the cluster is being deleted.", "The ERROR state indicates the cluster may be unusable. Details\ncan be found in the `statusMessage` field.", "The DEGRADED state indicates the cluster requires user action to restore\nfull functionality. Details can be found in the `statusMessage` field." ], "type": "string" }, "statusMessage": { "description": "[Output only] Additional information about the current status of this\ncluster, if available.", "type": "string" }, "subnetwork": { "description": "The name of the Google Compute Engine\n[subnetwork](/compute/docs/subnetworks) to which the\ncluster is connected.", "type": "string" }, "tpuIpv4CidrBlock": { "description": "[Output only] The IP address range of the Cloud TPUs in this cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `1.2.3.4/29`).", "type": "string" }, "verticalPodAutoscaling": { "$ref": "VerticalPodAutoscaling", "description": "Cluster-level Vertical Pod Autoscaling configuration." }, "zone": { "description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use location instead.", "type": "string" } }, "type": "object" }, "ClusterAutoscaling": { "description": "ClusterAutoscaling contains global, per-cluster information\nrequired by Cluster Autoscaler to automatically adjust\nthe size of the cluster and create/delete\nnode pools based on the current needs.", "id": "ClusterAutoscaling", "properties": { "autoprovisioningLocations": { "description": "The list of Google Compute Engine [zones](/compute/docs/zones#available)\nin which the NodePool's nodes can be created by NAP.", "items": { "type": "string" }, "type": "array" }, "autoprovisioningNodePoolDefaults": { "$ref": "AutoprovisioningNodePoolDefaults", "description": "AutoprovisioningNodePoolDefaults contains defaults for a node pool\ncreated by NAP." }, "enableNodeAutoprovisioning": { "description": "Enables automatic node pool creation and deletion.", "type": "boolean" }, "resourceLimits": { "description": "Contains global constraints regarding minimum and maximum\namount of resources in the cluster.", "items": { "$ref": "ResourceLimit" }, "type": "array" } }, "type": "object" }, "ClusterUpdate": { "description": "ClusterUpdate describes an update to the cluster. Exactly one update can\nbe applied to a cluster with each request, so at most one field can be\nprovided.", "id": "ClusterUpdate", "properties": { "desiredAddonsConfig": { "$ref": "AddonsConfig", "description": "Configurations for the various addons available to run in the cluster." }, "desiredBinaryAuthorization": { "$ref": "BinaryAuthorization", "description": "The desired configuration options for the Binary Authorization feature." }, "desiredClusterAutoscaling": { "$ref": "ClusterAutoscaling", "description": "Cluster-level autoscaling configuration." }, "desiredDatabaseEncryption": { "$ref": "DatabaseEncryption", "description": "Configuration of etcd encryption." }, "desiredImageType": { "description": "The desired image type for the node pool.\nNOTE: Set the \"desired_node_pool\" field as well.", "type": "string" }, "desiredIntraNodeVisibilityConfig": { "$ref": "IntraNodeVisibilityConfig", "description": "The desired config of Intra-node visibility." }, "desiredLocations": { "description": "The desired list of Google Compute Engine\n[zones](/compute/docs/zones#available) in which the cluster's nodes\nshould be located. Changing the locations a cluster is in will result\nin nodes being either created or removed from the cluster, depending on\nwhether locations are being added or removed.\n\nThis list must always include the cluster's primary zone.", "items": { "type": "string" }, "type": "array" }, "desiredLoggingService": { "description": "The logging service the cluster should use to write logs.\nCurrently available options:\n\n* \"logging.googleapis.com/kubernetes\" - the Google Cloud Logging\nservice with Kubernetes-native resource model\n* \"logging.googleapis.com\" - the Google Cloud Logging service\n* \"none\" - no logs will be exported from the cluster", "type": "string" }, "desiredMasterAuthorizedNetworksConfig": { "$ref": "MasterAuthorizedNetworksConfig", "description": "The desired configuration options for master authorized networks feature." }, "desiredMasterVersion": { "description": "The Kubernetes version to change the master to.\n\nUsers may specify either explicit versions offered by\nKubernetes Engine or version aliases, which have the following behavior:\n\n- \"latest\": picks the highest valid Kubernetes version\n- \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version\n- \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version\n- \"1.X.Y-gke.N\": picks an explicit Kubernetes version\n- \"-\": picks the default Kubernetes version", "type": "string" }, "desiredMonitoringService": { "description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com/kubernetes\" - the Google Cloud Monitoring\nservice with Kubernetes-native resource model\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster", "type": "string" }, "desiredNodePoolAutoscaling": { "$ref": "NodePoolAutoscaling", "description": "Autoscaler configuration for the node pool specified in\ndesired_node_pool_id. If there is only one pool in the\ncluster and desired_node_pool_id is not provided then\nthe change applies to that single node pool." }, "desiredNodePoolId": { "description": "The node pool to be upgraded. This field is mandatory if\n\"desired_node_version\", \"desired_image_family\" or\n\"desired_node_pool_autoscaling\" is specified and there is more than one\nnode pool on the cluster.", "type": "string" }, "desiredNodeVersion": { "description": "The Kubernetes version to change the nodes to (typically an\nupgrade).\n\nUsers may specify either explicit versions offered by\nKubernetes Engine or version aliases, which have the following behavior:\n\n- \"latest\": picks the highest valid Kubernetes version\n- \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version\n- \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version\n- \"1.X.Y-gke.N\": picks an explicit Kubernetes version\n- \"-\": picks the Kubernetes master version", "type": "string" }, "desiredResourceUsageExportConfig": { "$ref": "ResourceUsageExportConfig", "description": "The desired configuration for exporting resource usage." }, "desiredVerticalPodAutoscaling": { "$ref": "VerticalPodAutoscaling", "description": "Cluster-level Vertical Pod Autoscaling configuration." } }, "type": "object" }, "CompleteIPRotationRequest": { "description": "CompleteIPRotationRequest moves the cluster master back into single-IP mode.", "id": "CompleteIPRotationRequest", "properties": { "clusterId": { "description": "Required. Deprecated. The name of the cluster.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "name": { "description": "The name (project, location, cluster id) of the cluster to complete IP\nrotation. Specified in the format 'projects/*/locations/*/clusters/*'.", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "type": "string" } }, "type": "object" }, "ConsumptionMeteringConfig": { "description": "Parameters for controlling consumption metering.", "id": "ConsumptionMeteringConfig", "properties": { "enabled": { "description": "Whether to enable consumption metering for this cluster. If enabled, a\nsecond BigQuery table will be created to hold resource consumption\nrecords.", "type": "boolean" } }, "type": "object" }, "CreateClusterRequest": { "description": "CreateClusterRequest creates a cluster.", "id": "CreateClusterRequest", "properties": { "cluster": { "$ref": "Cluster", "description": "Required. A [cluster\nresource](/container-engine/reference/rest/v1/projects.zones.clusters)" }, "parent": { "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the parent field.", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the parent field.", "type": "string" } }, "type": "object" }, "CreateNodePoolRequest": { "description": "CreateNodePoolRequest creates a node pool for a cluster.", "id": "CreateNodePoolRequest", "properties": { "clusterId": { "description": "Required. Deprecated. The name of the cluster.\nThis field has been deprecated and replaced by the parent field.", "type": "string" }, "nodePool": { "$ref": "NodePool", "description": "Required. The node pool to create." }, "parent": { "description": "The parent (project, location, cluster id) where the node pool will be\ncreated. Specified in the format\n'projects/*/locations/*/clusters/*'.", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field has been deprecated and replaced by the parent field.", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the parent field.", "type": "string" } }, "type": "object" }, "DailyMaintenanceWindow": { "description": "Time window specified for daily maintenance operations.", "id": "DailyMaintenanceWindow", "properties": { "duration": { "description": "[Output only] Duration of the time window, automatically chosen to be\nsmallest possible in the given scenario.\nDuration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)\nformat \"PTnHnMnS\".", "type": "string" }, "startTime": { "description": "Time within the maintenance window to start the maintenance operations.\nTime format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)\nformat \"HH:MM\", where HH : [00-23] and MM : [00-59] GMT.", "type": "string" } }, "type": "object" }, "DatabaseEncryption": { "description": "Configuration of etcd encryption.", "id": "DatabaseEncryption", "properties": { "keyName": { "description": "Name of CloudKMS key to use for the encryption of secrets in etcd.\nEx. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key", "type": "string" }, "state": { "description": "Denotes the state of etcd encryption.", "enum": [ "UNKNOWN", "ENCRYPTED", "DECRYPTED" ], "enumDescriptions": [ "Should never be set", "Secrets in etcd are encrypted.", "Secrets in etcd are stored in plain text (at etcd level) - this is\nunrelated to GCE level full disk encryption." ], "type": "string" } }, "type": "object" }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", "properties": {}, "type": "object" }, "GetJSONWebKeysResponse": { "description": "GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517", "id": "GetJSONWebKeysResponse", "properties": { "cacheHeader": { "$ref": "HttpCacheControlResponseHeader", "description": "OnePlatform automatically extracts this field and uses it to set the HTTP\nCache-Control header." }, "keys": { "description": "The public component of the keys used by the cluster to sign token\nrequests.", "items": { "$ref": "Jwk" }, "type": "array" } }, "type": "object" }, "GetOpenIDConfigResponse": { "description": "GetOpenIDConfigResponse is an OIDC discovery document for the cluster.\nSee the OpenID Connect Discovery 1.0 specification for details.", "id": "GetOpenIDConfigResponse", "properties": { "cacheHeader": { "$ref": "HttpCacheControlResponseHeader", "description": "OnePlatform automatically extracts this field and uses it to set the HTTP\nCache-Control header." }, "claims_supported": { "description": "Supported claims.", "items": { "type": "string" }, "type": "array" }, "grant_types": { "description": "Supported grant types.", "items": { "type": "string" }, "type": "array" }, "id_token_signing_alg_values_supported": { "description": "supported ID Token signing Algorithms.", "items": { "type": "string" }, "type": "array" }, "issuer": { "description": "OIDC Issuer.", "type": "string" }, "jwks_uri": { "description": "JSON Web Key uri.", "type": "string" }, "response_types_supported": { "description": "Supported response types.", "items": { "type": "string" }, "type": "array" }, "subject_types_supported": { "description": "Supported subject types.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "HorizontalPodAutoscaling": { "description": "Configuration options for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods.", "id": "HorizontalPodAutoscaling", "properties": { "disabled": { "description": "Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.\nWhen enabled, it ensures that a Heapster pod is running in the cluster,\nwhich is also used by the Cloud Monitoring service.", "type": "boolean" } }, "type": "object" }, "HttpCacheControlResponseHeader": { "description": "RFC-2616: cache control support", "id": "HttpCacheControlResponseHeader", "properties": { "age": { "description": "14.6 response cache age, in seconds since the response is generated", "format": "int64", "type": "string" }, "directive": { "description": "14.9 request and response directives", "type": "string" }, "expires": { "description": "14.21 response cache expires, in RFC 1123 date format", "type": "string" } }, "type": "object" }, "HttpLoadBalancing": { "description": "Configuration options for the HTTP (L7) load balancing controller addon,\nwhich makes it easy to set up HTTP load balancers for services in a cluster.", "id": "HttpLoadBalancing", "properties": { "disabled": { "description": "Whether the HTTP Load Balancing controller is enabled in the cluster.\nWhen enabled, it runs a small pod in the cluster that manages the load\nbalancers.", "type": "boolean" } }, "type": "object" }, "IPAllocationPolicy": { "description": "Configuration for controlling how IPs are allocated in the cluster.", "id": "IPAllocationPolicy", "properties": { "clusterIpv4Cidr": { "description": "This field is deprecated, use cluster_ipv4_cidr_block.", "type": "string" }, "clusterIpv4CidrBlock": { "description": "The IP address range for the cluster pod IPs. If this field is set, then\n`cluster.cluster_ipv4_cidr` must be left blank.\n\nThis field is only applicable when `use_ip_aliases` is true.\n\nSet to blank to have a range chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.", "type": "string" }, "clusterSecondaryRangeName": { "description": "The name of the secondary range to be used for the cluster CIDR\nblock. The secondary range will be used for pod IP\naddresses. This must be an existing secondary range associated\nwith the cluster subnetwork.\n\nThis field is only applicable with use_ip_aliases is true and\ncreate_subnetwork is false.", "type": "string" }, "createSubnetwork": { "description": "Whether a new subnetwork will be created automatically for the cluster.\n\nThis field is only applicable when `use_ip_aliases` is true.", "type": "boolean" }, "nodeIpv4Cidr": { "description": "This field is deprecated, use node_ipv4_cidr_block.", "type": "string" }, "nodeIpv4CidrBlock": { "description": "The IP address range of the instance IPs in this cluster.\n\nThis is applicable only if `create_subnetwork` is true.\n\nSet to blank to have a range chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.", "type": "string" }, "servicesIpv4Cidr": { "description": "This field is deprecated, use services_ipv4_cidr_block.", "type": "string" }, "servicesIpv4CidrBlock": { "description": "The IP address range of the services IPs in this cluster. If blank, a range\nwill be automatically chosen with the default size.\n\nThis field is only applicable when `use_ip_aliases` is true.\n\nSet to blank to have a range chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.", "type": "string" }, "servicesSecondaryRangeName": { "description": "The name of the secondary range to be used as for the services\nCIDR block. The secondary range will be used for service\nClusterIPs. This must be an existing secondary range associated\nwith the cluster subnetwork.\n\nThis field is only applicable with use_ip_aliases is true and\ncreate_subnetwork is false.", "type": "string" }, "subnetworkName": { "description": "A custom subnetwork name to be used if `create_subnetwork` is true. If\nthis field is empty, then an automatic name will be chosen for the new\nsubnetwork.", "type": "string" }, "tpuIpv4CidrBlock": { "description": "The IP address range of the Cloud TPUs in this cluster. If unspecified, a\nrange will be automatically chosen with the default size.\n\nThis field is only applicable when `use_ip_aliases` is true.\n\nIf unspecified, the range will use the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.", "type": "string" }, "useIpAliases": { "description": "Whether alias IPs will be used for pod IPs in the cluster.", "type": "boolean" } }, "type": "object" }, "IntraNodeVisibilityConfig": { "description": "IntraNodeVisibilityConfig contains the desired config of the intra-node\nvisibility on this cluster.", "id": "IntraNodeVisibilityConfig", "properties": { "enabled": { "description": "Enables intra node visibility for this cluster.", "type": "boolean" } }, "type": "object" }, "Jwk": { "description": "Jwk is a JSON Web Key as specified in RFC 7517", "id": "Jwk", "properties": { "alg": { "description": "Algorithm.", "type": "string" }, "crv": { "description": "Used for ECDSA keys.", "type": "string" }, "e": { "description": "Used for RSA keys.", "type": "string" }, "kid": { "description": "Key ID.", "type": "string" }, "kty": { "description": "Key Type.", "type": "string" }, "n": { "description": "Used for RSA keys.", "type": "string" }, "use": { "description": "Permitted uses for the public keys.", "type": "string" }, "x": { "description": "Used for ECDSA keys.", "type": "string" }, "y": { "description": "Used for ECDSA keys.", "type": "string" } }, "type": "object" }, "KubernetesDashboard": { "description": "Configuration for the Kubernetes Dashboard.", "id": "KubernetesDashboard", "properties": { "disabled": { "description": "Whether the Kubernetes Dashboard is enabled for this cluster.", "type": "boolean" } }, "type": "object" }, "LegacyAbac": { "description": "Configuration for the legacy Attribute Based Access Control authorization\nmode.", "id": "LegacyAbac", "properties": { "enabled": { "description": "Whether the ABAC authorizer is enabled for this cluster. When enabled,\nidentities in the system, including service accounts, nodes, and\ncontrollers, will have statically granted permissions beyond those\nprovided by the RBAC configuration or IAM.", "type": "boolean" } }, "type": "object" }, "ListClustersResponse": { "description": "ListClustersResponse is the result of ListClustersRequest.", "id": "ListClustersResponse", "properties": { "clusters": { "description": "A list of clusters in the project in the specified zone, or\nacross all ones.", "items": { "$ref": "Cluster" }, "type": "array" }, "missingZones": { "description": "If any zones are listed here, the list of clusters returned\nmay be missing those zones.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "ListNodePoolsResponse": { "description": "ListNodePoolsResponse is the result of ListNodePoolsRequest.", "id": "ListNodePoolsResponse", "properties": { "nodePools": { "description": "A list of node pools for a cluster.", "items": { "$ref": "NodePool" }, "type": "array" } }, "type": "object" }, "ListOperationsResponse": { "description": "ListOperationsResponse is the result of ListOperationsRequest.", "id": "ListOperationsResponse", "properties": { "missingZones": { "description": "If any zones are listed here, the list of operations returned\nmay be missing the operations from those zones.", "items": { "type": "string" }, "type": "array" }, "operations": { "description": "A list of operations in the project in the specified zone.", "items": { "$ref": "Operation" }, "type": "array" } }, "type": "object" }, "ListUsableSubnetworksResponse": { "description": "ListUsableSubnetworksResponse is the response of\nListUsableSubnetworksRequest.", "id": "ListUsableSubnetworksResponse", "properties": { "nextPageToken": { "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `page_size`, use the\n`next_page_token` as a value for the query parameter `page_token` in the\nnext request. The value will become empty when there are no more pages.", "type": "string" }, "subnetworks": { "description": "A list of usable subnetworks in the specified network project.", "items": { "$ref": "UsableSubnetwork" }, "type": "array" } }, "type": "object" }, "MaintenancePolicy": { "description": "MaintenancePolicy defines the maintenance policy to be used for the cluster.", "id": "MaintenancePolicy", "properties": { "resourceVersion": { "description": "A hash identifying the version of this policy, so that updates to fields of\nthe policy won't accidentally undo intermediate changes (and so that users\nof the API unaware of some fields won't accidentally remove other fields).\nMake a \u003ccode\u003eget()\u003c/code\u003e request to the cluster to get the current\nresource version and include it with requests to set the policy.", "type": "string" }, "window": { "$ref": "MaintenanceWindow", "description": "Specifies the maintenance window in which maintenance may be performed." } }, "type": "object" }, "MaintenanceWindow": { "description": "MaintenanceWindow defines the maintenance window to be used for the cluster.", "id": "MaintenanceWindow", "properties": { "dailyMaintenanceWindow": { "$ref": "DailyMaintenanceWindow", "description": "DailyMaintenanceWindow specifies a daily maintenance operation window." }, "maintenanceExclusions": { "additionalProperties": { "$ref": "TimeWindow" }, "description": "Exceptions to maintenance window. Non-emergency maintenance should not\noccur in these windows.", "type": "object" }, "recurringWindow": { "$ref": "RecurringTimeWindow", "description": "RecurringWindow specifies some number of recurring time periods for\nmaintenance to occur. The time windows may be overlapping. If no\nmaintenance windows are set, maintenance can occur at any time." } }, "type": "object" }, "MasterAuth": { "description": "The authentication information for accessing the master endpoint.\nAuthentication can be done using HTTP basic auth or using client\ncertificates.", "id": "MasterAuth", "properties": { "clientCertificate": { "description": "[Output only] Base64-encoded public certificate used by clients to\nauthenticate to the cluster endpoint.", "type": "string" }, "clientCertificateConfig": { "$ref": "ClientCertificateConfig", "description": "Configuration for client certificate authentication on the cluster. For\nclusters before v1.12, if no configuration is specified, a client\ncertificate is issued." }, "clientKey": { "description": "[Output only] Base64-encoded private key used by clients to authenticate\nto the cluster endpoint.", "type": "string" }, "clusterCaCertificate": { "description": "[Output only] Base64-encoded public certificate that is the root of\ntrust for the cluster.", "type": "string" }, "password": { "description": "The password to use for HTTP basic authentication to the master endpoint.\nBecause the master endpoint is open to the Internet, you should create a\nstrong password. If a password is provided for cluster creation, username\nmust be non-empty.", "type": "string" }, "username": { "description": "The username to use for HTTP basic authentication to the master endpoint.\nFor clusters v1.6.0 and later, basic authentication can be disabled by\nleaving username unspecified (or setting it to the empty string).", "type": "string" } }, "type": "object" }, "MasterAuthorizedNetworksConfig": { "description": "Configuration options for the master authorized networks feature. Enabled\nmaster authorized networks will disallow all external traffic to access\nKubernetes master through HTTPS except traffic from the given CIDR blocks,\nGoogle Compute Engine Public IPs and Google Prod IPs.", "id": "MasterAuthorizedNetworksConfig", "properties": { "cidrBlocks": { "description": "cidr_blocks define up to 50 external networks that could access\nKubernetes master through HTTPS.", "items": { "$ref": "CidrBlock" }, "type": "array" }, "enabled": { "description": "Whether or not master authorized networks is enabled.", "type": "boolean" } }, "type": "object" }, "MaxPodsConstraint": { "description": "Constraints applied to pods.", "id": "MaxPodsConstraint", "properties": { "maxPodsPerNode": { "description": "Constraint enforced on the max num of pods per node.", "format": "int64", "type": "string" } }, "type": "object" }, "NetworkConfig": { "description": "NetworkConfig reports the relative names of network \u0026 subnetwork.", "id": "NetworkConfig", "properties": { "enableIntraNodeVisibility": { "description": "Whether Intra-node visibility is enabled for this cluster.\nThis makes same node pod to pod traffic visible for VPC network.", "type": "boolean" }, "network": { "description": "Output only. The relative name of the Google Compute Engine\nnetwork(/compute/docs/networks-and-firewalls#networks) to which\nthe cluster is connected.\nExample: projects/my-project/global/networks/my-network", "type": "string" }, "subnetwork": { "description": "Output only. The relative name of the Google Compute Engine\n[subnetwork](/compute/docs/vpc) to which the cluster is connected.\nExample: projects/my-project/regions/us-central1/subnetworks/my-subnet", "type": "string" } }, "type": "object" }, "NetworkPolicy": { "description": "Configuration options for the NetworkPolicy feature.\nhttps://kubernetes.io/docs/concepts/services-networking/networkpolicies/", "id": "NetworkPolicy", "properties": { "enabled": { "description": "Whether network policy is enabled on the cluster.", "type": "boolean" }, "provider": { "description": "The selected network policy provider.", "enum": [ "PROVIDER_UNSPECIFIED", "CALICO" ], "enumDescriptions": [ "Not set", "Tigera (Calico Felix)." ], "type": "string" } }, "type": "object" }, "NetworkPolicyConfig": { "description": "Configuration for NetworkPolicy. This only tracks whether the addon\nis enabled or not on the Master, it does not track whether network policy\nis enabled for the nodes.", "id": "NetworkPolicyConfig", "properties": { "disabled": { "description": "Whether NetworkPolicy is enabled for this cluster.", "type": "boolean" } }, "type": "object" }, "NodeConfig": { "description": "Parameters that describe the nodes in a cluster.", "id": "NodeConfig", "properties": { "accelerators": { "description": "A list of hardware accelerators to be attached to each node.\nSee https://cloud.google.com/compute/docs/gpus for more information about\nsupport for GPUs.", "items": { "$ref": "AcceleratorConfig" }, "type": "array" }, "diskSizeGb": { "description": "Size of the disk attached to each node, specified in GB.\nThe smallest allowed disk size is 10GB.\n\nIf unspecified, the default disk size is 100GB.", "format": "int32", "type": "integer" }, "diskType": { "description": "Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')\n\nIf unspecified, the default disk type is 'pd-standard'", "type": "string" }, "imageType": { "description": "The image type to use for this node. Note that for a given image type,\nthe latest version of it will be used.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "The map of Kubernetes labels (key/value pairs) to be applied to each node.\nThese will added in addition to any default label(s) that\nKubernetes may apply to the node.\nIn case of conflict in label keys, the applied set may differ depending on\nthe Kubernetes version -- it's best to assume the behavior is undefined\nand conflicts should be avoided.\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", "type": "object" }, "localSsdCount": { "description": "The number of local SSD disks to be attached to the node.\n\nThe limit for this value is dependent upon the maximum number of\ndisks available on a machine per zone. See:\nhttps://cloud.google.com/compute/docs/disks/local-ssd\nfor more information.", "format": "int32", "type": "integer" }, "machineType": { "description": "The name of a Google Compute Engine [machine\ntype](/compute/docs/machine-types) (e.g.\n`n1-standard-1`).\n\nIf unspecified, the default machine type is\n`n1-standard-1`.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "The metadata key/value pairs assigned to instances in the cluster.\n\nKeys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes\nin length. These are reflected as part of a URL in the metadata server.\nAdditionally, to avoid ambiguity, keys must not conflict with any other\nmetadata keys for the project or be one of the reserved keys:\n \"cluster-location\"\n \"cluster-name\"\n \"cluster-uid\"\n \"configure-sh\"\n \"containerd-configure-sh\"\n \"enable-os-login\"\n \"gci-update-strategy\"\n \"gci-ensure-gke-docker\"\n \"instance-template\"\n \"kube-env\"\n \"startup-script\"\n \"user-data\"\n \"disable-address-manager\"\n \"windows-startup-script-ps1\"\n \"common-psm1\"\n \"k8s-node-setup-psm1\"\n \"install-ssh-psm1\"\n \"user-profile-psm1\"\n \"serial-port-logging-enable\"\n\nValues are free-form strings, and only have meaning as interpreted by\nthe image running in the instance. The only restriction placed on them is\nthat each value's size must be less than or equal to 32 KB.\n\nThe total size of all keys and values must be less than 512 KB.", "type": "object" }, "minCpuPlatform": { "description": "Minimum CPU platform to be used by this instance. The instance may be\nscheduled on the specified or newer CPU platform. Applicable values are the\nfriendly names of CPU platforms, such as\n\u003ccode\u003eminCpuPlatform: \u0026quot;Intel Haswell\u0026quot;\u003c/code\u003e or\n\u003ccode\u003eminCpuPlatform: \u0026quot;Intel Sandy Bridge\u0026quot;\u003c/code\u003e. For more\ninformation, read [how to specify min CPU\nplatform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)", "type": "string" }, "oauthScopes": { "description": "The set of Google API scopes to be made available on all of the\nnode VMs under the \"default\" service account.\n\nThe following scopes are recommended, but not required, and by default are\nnot included:\n\n* `https://www.googleapis.com/auth/compute` is required for mounting\npersistent storage on your nodes.\n* `https://www.googleapis.com/auth/devstorage.read_only` is required for\ncommunicating with **gcr.io**\n(the [Google Container Registry](/container-registry/)).\n\nIf unspecified, no scopes are added, unless Cloud Logging or Cloud\nMonitoring are enabled, in which case their required scopes will be added.", "items": { "type": "string" }, "type": "array" }, "preemptible": { "description": "Whether the nodes are created as preemptible VM instances. See:\nhttps://cloud.google.com/compute/docs/instances/preemptible for more\ninformation about preemptible VM instances.", "type": "boolean" }, "serviceAccount": { "description": "The Google Cloud Platform Service Account to be used by the node VMs. If\nno Service Account is specified, the \"default\" service account is used.", "type": "string" }, "shieldedInstanceConfig": { "$ref": "ShieldedInstanceConfig", "description": "Shielded Instance options." }, "tags": { "description": "The list of instance tags applied to all nodes. Tags are used to identify\nvalid sources or targets for network firewalls and are specified by\nthe client during cluster or node pool creation. Each tag within the list\nmust comply with RFC1035.", "items": { "type": "string" }, "type": "array" }, "taints": { "description": "List of kubernetes taints to be applied to each node.\n\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/configuration/taint-and-toleration/", "items": { "$ref": "NodeTaint" }, "type": "array" } }, "type": "object" }, "NodeManagement": { "description": "NodeManagement defines the set of node management services turned on for the\nnode pool.", "id": "NodeManagement", "properties": { "autoRepair": { "description": "A flag that specifies whether the node auto-repair is enabled for the node\npool. If enabled, the nodes in this node pool will be monitored and, if\nthey fail health checks too many times, an automatic repair action will be\ntriggered.", "type": "boolean" }, "autoUpgrade": { "description": "A flag that specifies whether node auto-upgrade is enabled for the node\npool. If enabled, node auto-upgrade helps keep the nodes in your node pool\nup to date with the latest release version of Kubernetes.", "type": "boolean" }, "upgradeOptions": { "$ref": "AutoUpgradeOptions", "description": "Specifies the Auto Upgrade knobs for the node pool." } }, "type": "object" }, "NodePool": { "description": "NodePool contains the name and configuration for a cluster's node pool.\nNode pools are a set of nodes (i.e. VM's), with a common configuration and\nspecification, under the control of the cluster master. They may have a set\nof Kubernetes labels applied to them, which may be used to reference them\nduring pod scheduling. They may also be resized up or down, to accommodate\nthe workload.", "id": "NodePool", "properties": { "autoscaling": { "$ref": "NodePoolAutoscaling", "description": "Autoscaler configuration for this NodePool. Autoscaler is enabled\nonly if a valid configuration is present." }, "conditions": { "description": "Which conditions caused the current node pool state.", "items": { "$ref": "StatusCondition" }, "type": "array" }, "config": { "$ref": "NodeConfig", "description": "The node configuration of the pool." }, "initialNodeCount": { "description": "The initial node count for the pool. You must ensure that your\nCompute Engine \u003ca href=\"/compute/docs/resource-quotas\"\u003eresource quota\u003c/a\u003e\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.", "format": "int32", "type": "integer" }, "instanceGroupUrls": { "description": "[Output only] The resource URLs of the [managed instance\ngroups](/compute/docs/instance-groups/creating-groups-of-managed-instances)\nassociated with this node pool.", "items": { "type": "string" }, "type": "array" }, "management": { "$ref": "NodeManagement", "description": "NodeManagement configuration for this NodePool." }, "maxPodsConstraint": { "$ref": "MaxPodsConstraint", "description": "The constraint on the maximum number of pods that can be run\nsimultaneously on a node in the node pool." }, "name": { "description": "The name of the node pool.", "type": "string" }, "podIpv4CidrSize": { "description": "[Output only] The pod CIDR block size per node in this node pool.", "format": "int32", "type": "integer" }, "selfLink": { "description": "[Output only] Server-defined URL for the resource.", "type": "string" }, "status": { "description": "[Output only] The status of the nodes in this pool instance.", "enum": [ "STATUS_UNSPECIFIED", "PROVISIONING", "RUNNING", "RUNNING_WITH_ERROR", "RECONCILING", "STOPPING", "ERROR" ], "enumDescriptions": [ "Not set.", "The PROVISIONING state indicates the node pool is being created.", "The RUNNING state indicates the node pool has been created\nand is fully usable.", "The RUNNING_WITH_ERROR state indicates the node pool has been created\nand is partially usable. Some error state has occurred and some\nfunctionality may be impaired. Customer may need to reissue a request\nor trigger a new update.", "The RECONCILING state indicates that some work is actively being done on\nthe node pool, such as upgrading node software. Details can\nbe found in the `statusMessage` field.", "The STOPPING state indicates the node pool is being deleted.", "The ERROR state indicates the node pool may be unusable. Details\ncan be found in the `statusMessage` field." ], "type": "string" }, "statusMessage": { "description": "[Output only] Additional information about the current status of this\nnode pool instance, if available.", "type": "string" }, "version": { "description": "The version of the Kubernetes of this node.", "type": "string" } }, "type": "object" }, "NodePoolAutoscaling": { "description": "NodePoolAutoscaling contains information required by cluster autoscaler to\nadjust the size of the node pool to the current cluster usage.", "id": "NodePoolAutoscaling", "properties": { "autoprovisioned": { "description": "Can this node pool be deleted automatically.", "type": "boolean" }, "enabled": { "description": "Is autoscaling enabled for this node pool.", "type": "boolean" }, "maxNodeCount": { "description": "Maximum number of nodes in the NodePool. Must be \u003e= min_node_count. There\nhas to enough quota to scale up the cluster.", "format": "int32", "type": "integer" }, "minNodeCount": { "description": "Minimum number of nodes in the NodePool. Must be \u003e= 1 and \u003c=\nmax_node_count.", "format": "int32", "type": "integer" } }, "type": "object" }, "NodeTaint": { "description": "Kubernetes taint is comprised of three fields: key, value, and effect. Effect\ncan only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.\n\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/configuration/taint-and-toleration/", "id": "NodeTaint", "properties": { "effect": { "description": "Effect for taint.", "enum": [ "EFFECT_UNSPECIFIED", "NO_SCHEDULE", "PREFER_NO_SCHEDULE", "NO_EXECUTE" ], "enumDescriptions": [ "Not set", "NoSchedule", "PreferNoSchedule", "NoExecute" ], "type": "string" }, "key": { "description": "Key for taint.", "type": "string" }, "value": { "description": "Value for taint.", "type": "string" } }, "type": "object" }, "Operation": { "description": "This operation resource represents operations that may have happened or are\nhappening on the cluster. All fields are output only.", "id": "Operation", "properties": { "clusterConditions": { "description": "Which conditions caused the current cluster state.", "items": { "$ref": "StatusCondition" }, "type": "array" }, "detail": { "description": "Detailed operation progress, if available.", "type": "string" }, "endTime": { "description": "[Output only] The time the operation completed, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "type": "string" }, "location": { "description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/regions-zones/regions-zones#available) or\n[region](/compute/docs/regions-zones/regions-zones#available) in which\nthe cluster resides.", "type": "string" }, "name": { "description": "The server-assigned ID for the operation.", "type": "string" }, "nodepoolConditions": { "description": "Which conditions caused the current node pool state.", "items": { "$ref": "StatusCondition" }, "type": "array" }, "operationType": { "description": "The operation type.", "enum": [ "TYPE_UNSPECIFIED", "CREATE_CLUSTER", "DELETE_CLUSTER", "UPGRADE_MASTER", "UPGRADE_NODES", "REPAIR_CLUSTER", "UPDATE_CLUSTER", "CREATE_NODE_POOL", "DELETE_NODE_POOL", "SET_NODE_POOL_MANAGEMENT", "AUTO_REPAIR_NODES", "AUTO_UPGRADE_NODES", "SET_LABELS", "SET_MASTER_AUTH", "SET_NODE_POOL_SIZE", "SET_NETWORK_POLICY", "SET_MAINTENANCE_POLICY" ], "enumDescriptions": [ "Not set.", "Cluster create.", "Cluster delete.", "A master upgrade.", "A node upgrade.", "Cluster repair.", "Cluster update.", "Node pool create.", "Node pool delete.", "Set node pool management.", "Automatic node pool repair.", "Automatic node upgrade.", "Set labels.", "Set/generate master auth materials", "Set node pool size.", "Updates network policy for a cluster.", "Set the maintenance policy." ], "type": "string" }, "selfLink": { "description": "Server-defined URL for the resource.", "type": "string" }, "startTime": { "description": "[Output only] The time the operation started, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "type": "string" }, "status": { "description": "The current status of the operation.", "enum": [ "STATUS_UNSPECIFIED", "PENDING", "RUNNING", "DONE", "ABORTING" ], "enumDescriptions": [ "Not set.", "The operation has been created.", "The operation is currently running.", "The operation is done, either cancelled or completed.", "The operation is aborting." ], "type": "string" }, "statusMessage": { "description": "If an error has occurred, a textual description of the error.", "type": "string" }, "targetLink": { "description": "Server-defined URL for the target of the operation.", "type": "string" }, "zone": { "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation\nis taking place.\nThis field is deprecated, use location instead.", "type": "string" } }, "type": "object" }, "PrivateClusterConfig": { "description": "Configuration options for private clusters.", "id": "PrivateClusterConfig", "properties": { "enablePrivateEndpoint": { "description": "Whether the master's internal IP address is used as the cluster endpoint.", "type": "boolean" }, "enablePrivateNodes": { "description": "Whether nodes have internal IP addresses only. If enabled, all nodes are\ngiven only RFC 1918 private addresses and communicate with the master via\nprivate networking.", "type": "boolean" }, "masterIpv4CidrBlock": { "description": "The IP range in CIDR notation to use for the hosted master network. This\nrange will be used for assigning internal IP addresses to the master or\nset of masters, as well as the ILB VIP. This range must not overlap with\nany other ranges in use within the cluster's network.", "type": "string" }, "privateEndpoint": { "description": "Output only. The internal IP address of this cluster's master endpoint.", "type": "string" }, "publicEndpoint": { "description": "Output only. The external IP address of this cluster's master endpoint.", "type": "string" } }, "type": "object" }, "RecurringTimeWindow": { "description": "Represents an arbitrary window of time that recurs.", "id": "RecurringTimeWindow", "properties": { "recurrence": { "description": "An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how\nthis window reccurs. They go on for the span of time between the start and\nend time.\n\nFor example, to have something repeat every weekday, you'd use:\n \u003ccode\u003eFREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\u003c/code\u003e\nTo repeat some window daily (equivalent to the DailyMaintenanceWindow):\n \u003ccode\u003eFREQ=DAILY\u003c/code\u003e\nFor the first weekend of every month:\n \u003ccode\u003eFREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU\u003c/code\u003e\nThis specifies how frequently the window starts. Eg, if you wanted to have\na 9-5 UTC-4 window every weekday, you'd use something like:\n\u003ccode\u003e\n start time = 2019-01-01T09:00:00-0400\n end time = 2019-01-01T17:00:00-0400\n recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR\n\u003c/code\u003e\nWindows can span multiple days. Eg, to make the window encompass every\nweekend from midnight Saturday till the last minute of Sunday UTC:\n\u003ccode\u003e\n start time = 2019-01-05T00:00:00Z\n end time = 2019-01-07T23:59:00Z\n recurrence = FREQ=WEEKLY;BYDAY=SA\n\u003c/code\u003e\nNote the start and end time's specific dates are largely arbitrary except\nto specify duration of the window and when it first starts.\nThe FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.", "type": "string" }, "window": { "$ref": "TimeWindow", "description": "The window of the first recurrence." } }, "type": "object" }, "ResourceLimit": { "description": "Contains information about amount of some resource in the cluster.\nFor memory, value should be in GB.", "id": "ResourceLimit", "properties": { "maximum": { "description": "Maximum amount of the resource in the cluster.", "format": "int64", "type": "string" }, "minimum": { "description": "Minimum amount of the resource in the cluster.", "format": "int64", "type": "string" }, "resourceType": { "description": "Resource name \"cpu\", \"memory\" or gpu-specific string.", "type": "string" } }, "type": "object" }, "ResourceUsageExportConfig": { "description": "Configuration for exporting cluster resource usages.", "id": "ResourceUsageExportConfig", "properties": { "bigqueryDestination": { "$ref": "BigQueryDestination", "description": "Configuration to use BigQuery as usage export destination." }, "consumptionMeteringConfig": { "$ref": "ConsumptionMeteringConfig", "description": "Configuration to enable resource consumption metering." }, "enableNetworkEgressMetering": { "description": "Whether to enable network egress metering for this cluster. If enabled, a\ndaemonset will be created in the cluster to meter network egress traffic.", "type": "boolean" } }, "type": "object" }, "RollbackNodePoolUpgradeRequest": { "description": "RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed\nNodePool upgrade. This will be an no-op if the last upgrade successfully\ncompleted.", "id": "RollbackNodePoolUpgradeRequest", "properties": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to rollback.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "name": { "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to rollback.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "type": "string" } }, "type": "object" }, "ServerConfig": { "description": "Kubernetes Engine service configuration.", "id": "ServerConfig", "properties": { "defaultClusterVersion": { "description": "Version of Kubernetes the service deploys by default.", "type": "string" }, "defaultImageType": { "description": "Default image type.", "type": "string" }, "validImageTypes": { "description": "List of valid image types.", "items": { "type": "string" }, "type": "array" }, "validMasterVersions": { "description": "List of valid master versions.", "items": { "type": "string" }, "type": "array" }, "validNodeVersions": { "description": "List of valid node upgrade target versions.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "SetAddonsConfigRequest": { "description": "SetAddonsConfigRequest sets the addons associated with the cluster.", "id": "SetAddonsConfigRequest", "properties": { "addonsConfig": { "$ref": "AddonsConfig", "description": "Required. The desired configurations for the various addons available to run in the\ncluster." }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "name": { "description": "The name (project, location, cluster) of the cluster to set addons.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "type": "string" } }, "type": "object" }, "SetLabelsRequest": { "description": "SetLabelsRequest sets the Google Cloud Platform labels on a Google Container\nEngine cluster, which will in turn set them for Google Compute Engine\nresources used by that cluster", "id": "SetLabelsRequest", "properties": { "clusterId": { "description": "Required. Deprecated. The name of the cluster.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "labelFingerprint": { "description": "Required. The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nKubernetes Engine and changes after every request to modify or update\nlabels. You must always provide an up-to-date fingerprint hash when\nupdating or changing labels. Make a \u003ccode\u003eget()\u003c/code\u003e request to the\nresource to get the latest fingerprint.", "type": "string" }, "name": { "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "resourceLabels": { "additionalProperties": { "type": "string" }, "description": "Required. The labels to set for that cluster.", "type": "object" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "type": "string" } }, "type": "object" }, "SetLegacyAbacRequest": { "description": "SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for\na cluster.", "id": "SetLegacyAbacRequest", "properties": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to update.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "enabled": { "description": "Required. Whether ABAC authorization will be enabled in the cluster.", "type": "boolean" }, "name": { "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "type": "string" } }, "type": "object" }, "SetLocationsRequest": { "description": "SetLocationsRequest sets the locations of the cluster.", "id": "SetLocationsRequest", "properties": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "locations": { "description": "Required. The desired list of Google Compute Engine\n[zones](/compute/docs/zones#available) in which the cluster's nodes\nshould be located. Changing the locations a cluster is in will result\nin nodes being either created or removed from the cluster, depending on\nwhether locations are being added or removed.\n\nThis list must always include the cluster's primary zone.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name (project, location, cluster) of the cluster to set locations.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "type": "string" } }, "type": "object" }, "SetLoggingServiceRequest": { "description": "SetLoggingServiceRequest sets the logging service of a cluster.", "id": "SetLoggingServiceRequest", "properties": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "loggingService": { "description": "Required. The logging service the cluster should use to write metrics.\nCurrently available options:\n\n* \"logging.googleapis.com\" - the Google Cloud Logging service\n* \"none\" - no metrics will be exported from the cluster", "type": "string" }, "name": { "description": "The name (project, location, cluster) of the cluster to set logging.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "type": "string" } }, "type": "object" }, "SetMaintenancePolicyRequest": { "description": "SetMaintenancePolicyRequest sets the maintenance policy for a cluster.", "id": "SetMaintenancePolicyRequest", "properties": { "clusterId": { "description": "Required. The name of the cluster to update.", "type": "string" }, "maintenancePolicy": { "$ref": "MaintenancePolicy", "description": "Required. The maintenance policy to be set for the cluster. An empty field\nclears the existing maintenance policy." }, "name": { "description": "The name (project, location, cluster id) of the cluster to set maintenance\npolicy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "type": "string" }, "projectId": { "description": "Required. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", "type": "string" }, "zone": { "description": "Required. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", "type": "string" } }, "type": "object" }, "SetMasterAuthRequest": { "description": "SetMasterAuthRequest updates the admin password of a cluster.", "id": "SetMasterAuthRequest", "properties": { "action": { "description": "Required. The exact form of action to be taken on the master auth.", "enum": [ "UNKNOWN", "SET_PASSWORD", "GENERATE_PASSWORD", "SET_USERNAME" ], "enumDescriptions": [ "Operation is unknown and will error out.", "Set the password to a user generated value.", "Generate a new password and set it to that.", "Set the username. If an empty username is provided, basic authentication\nis disabled for the cluster. If a non-empty username is provided, basic\nauthentication is enabled, with either a provided password or a generated\none." ], "type": "string" }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "name": { "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "update": { "$ref": "MasterAuth", "description": "Required. A description of the update." }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "type": "string" } }, "type": "object" }, "SetMonitoringServiceRequest": { "description": "SetMonitoringServiceRequest sets the monitoring service of a cluster.", "id": "SetMonitoringServiceRequest", "properties": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "monitoringService": { "description": "Required. The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com/kubernetes\" - the Google Cloud Monitoring\nservice with Kubernetes-native resource model\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster", "type": "string" }, "name": { "description": "The name (project, location, cluster) of the cluster to set monitoring.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "type": "string" } }, "type": "object" }, "SetNetworkPolicyRequest": { "description": "SetNetworkPolicyRequest enables/disables network policy for a cluster.", "id": "SetNetworkPolicyRequest", "properties": { "clusterId": { "description": "Required. Deprecated. The name of the cluster.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "name": { "description": "The name (project, location, cluster id) of the cluster to set networking\npolicy. Specified in the format 'projects/*/locations/*/clusters/*'.", "type": "string" }, "networkPolicy": { "$ref": "NetworkPolicy", "description": "Required. Configuration options for the NetworkPolicy feature." }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "type": "string" } }, "type": "object" }, "SetNodePoolAutoscalingRequest": { "description": "SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.", "id": "SetNodePoolAutoscalingRequest", "properties": { "autoscaling": { "$ref": "NodePoolAutoscaling", "description": "Required. Autoscaling configuration for the node pool." }, "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "name": { "description": "The name (project, location, cluster, node pool) of the node pool to set\nautoscaler settings. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to upgrade.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "type": "string" } }, "type": "object" }, "SetNodePoolManagementRequest": { "description": "SetNodePoolManagementRequest sets the node management properties of a node\npool.", "id": "SetNodePoolManagementRequest", "properties": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to update.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "management": { "$ref": "NodeManagement", "description": "Required. NodeManagement configuration for the node pool." }, "name": { "description": "The name (project, location, cluster, node pool id) of the node pool to set\nmanagement properties. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to update.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "type": "string" } }, "type": "object" }, "SetNodePoolSizeRequest": { "description": "SetNodePoolSizeRequest sets the size a node\npool.", "id": "SetNodePoolSizeRequest", "properties": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to update.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "name": { "description": "The name (project, location, cluster, node pool id) of the node pool to set\nsize.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", "type": "string" }, "nodeCount": { "description": "Required. The desired node count for the pool.", "format": "int32", "type": "integer" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to update.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "type": "string" } }, "type": "object" }, "ShieldedInstanceConfig": { "description": "A set of Shielded Instance options.", "id": "ShieldedInstanceConfig", "properties": { "enableIntegrityMonitoring": { "description": "Defines whether the instance has integrity monitoring enabled.\n\nEnables monitoring and attestation of the boot integrity of the instance.\nThe attestation is performed against the integrity policy baseline. This\nbaseline is initially derived from the implicitly trusted boot image when\nthe instance is created.", "type": "boolean" }, "enableSecureBoot": { "description": "Defines whether the instance has Secure Boot enabled.\n\nSecure Boot helps ensure that the system only runs authentic software by\nverifying the digital signature of all boot components, and halting the\nboot process if signature verification fails.", "type": "boolean" } }, "type": "object" }, "StartIPRotationRequest": { "description": "StartIPRotationRequest creates a new IP for the cluster and then performs\na node upgrade on each node pool to point to the new IP.", "id": "StartIPRotationRequest", "properties": { "clusterId": { "description": "Required. Deprecated. The name of the cluster.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "name": { "description": "The name (project, location, cluster id) of the cluster to start IP\nrotation. Specified in the format 'projects/*/locations/*/clusters/*'.", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "rotateCredentials": { "description": "Whether to rotate credentials during IP rotation.", "type": "boolean" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "type": "string" } }, "type": "object" }, "StatusCondition": { "description": "StatusCondition describes why a cluster or a node pool has a certain status\n(e.g., ERROR or DEGRADED).", "id": "StatusCondition", "properties": { "code": { "description": "Machine-friendly representation of the condition", "enum": [ "UNKNOWN", "GCE_STOCKOUT", "GKE_SERVICE_ACCOUNT_DELETED", "GCE_QUOTA_EXCEEDED", "SET_BY_OPERATOR", "CLOUD_KMS_KEY_ERROR" ], "enumDescriptions": [ "UNKNOWN indicates a generic condition.", "GCE_STOCKOUT indicates a Google Compute Engine stockout.", "GKE_SERVICE_ACCOUNT_DELETED indicates that the user deleted their robot\nservice account.", "Google Compute Engine quota was exceeded.", "Cluster state was manually changed by an SRE due to a system logic error.", "Unable to perform an encrypt operation against the CloudKMS key used for\netcd level encryption.\nMore codes TBA" ], "type": "string" }, "message": { "description": "Human-friendly representation of the condition", "type": "string" } }, "type": "object" }, "TimeWindow": { "description": "Represents an arbitrary window of time.", "id": "TimeWindow", "properties": { "endTime": { "description": "The time that the window ends. The end time should take place after the\nstart time.", "format": "google-datetime", "type": "string" }, "startTime": { "description": "The time that the window first starts.", "format": "google-datetime", "type": "string" } }, "type": "object" }, "UpdateClusterRequest": { "description": "UpdateClusterRequest updates the settings of a cluster.", "id": "UpdateClusterRequest", "properties": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "name": { "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "update": { "$ref": "ClusterUpdate", "description": "Required. A description of the update." }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "type": "string" } }, "type": "object" }, "UpdateMasterRequest": { "description": "UpdateMasterRequest updates the master of the cluster.", "id": "UpdateMasterRequest", "properties": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "masterVersion": { "description": "Required. The Kubernetes version to change the master to.\n\nUsers may specify either explicit versions offered by Kubernetes Engine or\nversion aliases, which have the following behavior:\n\n- \"latest\": picks the highest valid Kubernetes version\n- \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version\n- \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version\n- \"1.X.Y-gke.N\": picks an explicit Kubernetes version\n- \"-\": picks the default Kubernetes version", "type": "string" }, "name": { "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "type": "string" } }, "type": "object" }, "UpdateNodePoolRequest": { "description": "UpdateNodePoolRequests update a node pool's image and/or version.", "id": "UpdateNodePoolRequest", "properties": { "clusterId": { "description": "Required. Deprecated. The name of the cluster to upgrade.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "imageType": { "description": "Required. The desired image type for the node pool.", "type": "string" }, "name": { "description": "The name (project, location, cluster, node pool) of the node pool to\nupdate. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", "type": "string" }, "nodePoolId": { "description": "Required. Deprecated. The name of the node pool to upgrade.\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "nodeVersion": { "description": "Required. The Kubernetes version to change the nodes to (typically an\nupgrade).\n\nUsers may specify either explicit versions offered by Kubernetes Engine or\nversion aliases, which have the following behavior:\n\n- \"latest\": picks the highest valid Kubernetes version\n- \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version\n- \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version\n- \"1.X.Y-gke.N\": picks an explicit Kubernetes version\n- \"-\": picks the Kubernetes master version", "type": "string" }, "projectId": { "description": "Required. Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "description": "Required. Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.", "type": "string" } }, "type": "object" }, "UsableSubnetwork": { "description": "UsableSubnetwork resource returns the subnetwork name, its associated network\nand the primary CIDR range.", "id": "UsableSubnetwork", "properties": { "ipCidrRange": { "description": "The range of internal addresses that are owned by this subnetwork.", "type": "string" }, "network": { "description": "Network Name.\nExample: projects/my-project/global/networks/my-network", "type": "string" }, "secondaryIpRanges": { "description": "Secondary IP ranges.", "items": { "$ref": "UsableSubnetworkSecondaryRange" }, "type": "array" }, "statusMessage": { "description": "A human readable status message representing the reasons for cases where\nthe caller cannot use the secondary ranges under the subnet. For example if\nthe secondary_ip_ranges is empty due to a permission issue, an insufficient\npermission message will be given by status_message.", "type": "string" }, "subnetwork": { "description": "Subnetwork Name.\nExample: projects/my-project/regions/us-central1/subnetworks/my-subnet", "type": "string" } }, "type": "object" }, "UsableSubnetworkSecondaryRange": { "description": "Secondary IP range of a usable subnetwork.", "id": "UsableSubnetworkSecondaryRange", "properties": { "ipCidrRange": { "description": "The range of IP addresses belonging to this subnetwork secondary range.", "type": "string" }, "rangeName": { "description": "The name associated with this subnetwork secondary range, used when adding\nan alias IP range to a VM instance.", "type": "string" }, "status": { "description": "This field is to determine the status of the secondary range programmably.", "enum": [ "UNKNOWN", "UNUSED", "IN_USE_SERVICE", "IN_USE_SHAREABLE_POD", "IN_USE_MANAGED_POD" ], "enumDescriptions": [ "UNKNOWN is the zero value of the Status enum. It's not a valid status.", "UNUSED denotes that this range is unclaimed by any cluster.", "IN_USE_SERVICE denotes that this range is claimed by a cluster for\nservices. It cannot be used for other clusters.", "IN_USE_SHAREABLE_POD denotes this range was created by the network admin\nand is currently claimed by a cluster for pods. It can only be used by\nother clusters as a pod range.", "IN_USE_MANAGED_POD denotes this range was created by GKE and is claimed\nfor pods. It cannot be used for other clusters." ], "type": "string" } }, "type": "object" }, "VerticalPodAutoscaling": { "description": "VerticalPodAutoscaling contains global, per-cluster information\nrequired by Vertical Pod Autoscaler to automatically adjust\nthe resources of pods controlled by it.", "id": "VerticalPodAutoscaling", "properties": { "enabled": { "description": "Enables vertical pod autoscaling.", "type": "boolean" } }, "type": "object" } }, "servicePath": "", "title": "Kubernetes Engine API", "version": "v1" }