Google Git
Sign in
chromium / external / github.com / google / google-api-python-client / refs/heads/release-v1.13.0 / . / googleapiclient / discovery_cache / documents / container.v1.json
blob: 60b8aa31d51763119e8379d8a4c277a30b842366 [file] [log] [blame] [edit]
{
"discoveryVersion": "v1",
"resources": {
"projects": {
"resources": {
"aggregated": {
"resources": {
"usableSubnetworks": {
"methods": {
"list": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"pageSize": {
"type": "integer",
"description": "The max number of results per page that should be returned. If the number of available results is larger than `page_size`, a `next_page_token` is returned which can be used to get the next page of results in subsequent requests. Acceptable values are 0 to 500, inclusive. (Default: 500)",
"location": "query",
"format": "int32"
},
"parent": {
"pattern": "^projects/[^/]+$",
"location": "path",
"description": "The parent project where subnetworks are usable. Specified in the format `projects/*`.",
"required": true,
"type": "string"
},
"filter": {
"location": "query",
"type": "string",
"description": "Filtering currently only supports equality on the networkProjectId and must be in the form: \"networkProjectId=[PROJECTID]\", where `networkProjectId` is the project which owns the listed subnetworks. This defaults to the parent project ID."
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set this to the nextPageToken returned by previous list requests to get the next page of results.",
"location": "query"
}
},
"parameterOrder": [
"parent"
],
"id": "container.projects.aggregated.usableSubnetworks.list",
"response": {
"$ref": "ListUsableSubnetworksResponse"
},
"flatPath": "v1/projects/{projectsId}/aggregated/usableSubnetworks",
"description": "Lists subnetworks that are usable for creating clusters in a project.",
"path": "v1/{+parent}/aggregated/usableSubnetworks",
"httpMethod": "GET"
}
}
}
}
},
"locations": {
"methods": {
"getServerConfig": {
"path": "v1/{+name}/serverConfig",
"description": "Returns configuration info about the Google Kubernetes Engine service.",
"httpMethod": "GET",
"parameters": {
"name": {
"required": true,
"location": "path",
"description": "The name (project and location) of the server config to get, specified in the format `projects/*/locations/*`.",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"type": "string"
},
"zone": {
"location": "query",
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field."
},
"projectId": {
"location": "query",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.",
"type": "string"
}
},
"id": "container.projects.locations.getServerConfig",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serverConfig",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "ServerConfig"
},
"parameterOrder": [
"name"
]
}
},
"resources": {
"operations": {
"methods": {
"get": {
"parameterOrder": [
"name"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"path": "v1/{+name}",
"httpMethod": "GET",
"parameters": {
"zone": {
"type": "string",
"location": "query",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field."
},
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"type": "string",
"location": "path",
"required": true,
"description": "The name (project, location, operation id) of the operation to get. Specified in the format `projects/*/locations/*/operations/*`."
},
"operationId": {
"location": "query",
"type": "string",
"description": "Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field."
},
"projectId": {
"location": "query",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.",
"type": "string"
}
},
"description": "Gets the specified operation.",
"id": "container.projects.locations.operations.get"
},
"cancel": {
"path": "v1/{+name}:cancel",
"description": "Cancels the specified operation.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"required": true,
"type": "string",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"description": "The name (project, location, operation id) of the operation to cancel. Specified in the format `projects/*/locations/*/operations/*`."
}
},
"response": {
"$ref": "Empty"
},
"httpMethod": "POST",
"parameterOrder": [
"name"
],
"id": "container.projects.locations.operations.cancel",
"request": {
"$ref": "CancelOperationRequest"
}
},
"list": {
"response": {
"$ref": "ListOperationsResponse"
},
"httpMethod": "GET",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations",
"parameters": {
"zone": {
"location": "query",
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field."
},
"parent": {
"required": true,
"type": "string",
"description": "The parent (project and location) where the operations will be listed. Specified in the format `projects/*/locations/*`. Location \"-\" matches all zones and all regions.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$"
},
"projectId": {
"type": "string",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field.",
"location": "query"
}
},
"description": "Lists all operations in a project in a specific zone or all zones.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameterOrder": [
"parent"
],
"id": "container.projects.locations.operations.list",
"path": "v1/{+parent}/operations"
}
}
},
"clusters": {
"methods": {
"setMonitoring": {
"description": "Sets the monitoring service for a specific cluster.",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"location": "path",
"type": "string",
"description": "The name (project, location, cluster) of the cluster to set monitoring. Specified in the format `projects/*/locations/*/clusters/*`.",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"required": true
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMonitoring",
"id": "container.projects.locations.clusters.setMonitoring",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "POST",
"request": {
"$ref": "SetMonitoringServiceRequest"
},
"path": "v1/{+name}:setMonitoring"
},
"delete": {
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
"id": "container.projects.locations.clusters.delete",
"parameters": {
"name": {
"description": "The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/*/locations/*/clusters/*`.",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"location": "path",
"type": "string",
"required": true
},
"zone": {
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
"location": "query",
"type": "string"
},
"projectId": {
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.",
"location": "query",
"type": "string"
},
"clusterId": {
"type": "string",
"description": "Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field.",
"location": "query"
}
},
"response": {
"$ref": "Operation"
},
"path": "v1/{+name}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.",
"httpMethod": "DELETE",
"parameterOrder": [
"name"
]
},
"list": {
"description": "Lists all clusters owned by a project in either the specified zone or all zones.",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"required": true,
"description": "The parent (project and location) where the clusters will be listed. Specified in the format `projects/*/locations/*`. Location \"-\" matches all zones and all regions.",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"type": "string",
"location": "path"
},
"projectId": {
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field.",
"location": "query",
"type": "string"
},
"zone": {
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.",
"location": "query"
}
},
"id": "container.projects.locations.clusters.list",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters",
"path": "v1/{+parent}/clusters",
"response": {
"$ref": "ListClustersResponse"
},
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getJwks": {
"id": "container.projects.locations.clusters.getJwks",
"description": "Gets the public component of the cluster signing keys in JSON Web Key format. This API is not yet intended for general use, and is not available for all clusters.",
"path": "v1/{+parent}/jwks",
"httpMethod": "GET",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/jwks",
"parameters": {
"parent": {
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"required": true,
"description": "The cluster (project, location, cluster id) to get keys for. Specified in the format `projects/*/locations/*/clusters/*`.",
"location": "path",
"type": "string"
}
},
"parameterOrder": [
"parent"
],
"response": {
"$ref": "GetJSONWebKeysResponse"
}
},
"completeIpRotation": {
"path": "v1/{+name}:completeIpRotation",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"request": {
"$ref": "CompleteIPRotationRequest"
},
"response": {
"$ref": "Operation"
},
"parameters": {
"name": {
"location": "path",
"required": true,
"type": "string",
"description": "The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:completeIpRotation",
"httpMethod": "POST",
"id": "container.projects.locations.clusters.completeIpRotation",
"parameterOrder": [
"name"
],
"description": "Completes master IP rotation."
},
"setAddons": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Sets the addons for a specific cluster.",
"id": "container.projects.locations.clusters.setAddons",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setAddons",
"response": {
"$ref": "Operation"
},
"path": "v1/{+name}:setAddons",
"httpMethod": "POST",
"request": {
"$ref": "SetAddonsConfigRequest"
},
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"type": "string",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"description": "The name (project, location, cluster) of the cluster to set addons. Specified in the format `projects/*/locations/*/clusters/*`.",
"required": true
}
}
},
"updateMaster": {
"httpMethod": "POST",
"parameters": {
"name": {
"description": "The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"type": "string",
"location": "path",
"required": true
}
},
"id": "container.projects.locations.clusters.updateMaster",
"parameterOrder": [
"name"
],
"path": "v1/{+name}:updateMaster",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "Operation"
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:updateMaster",
"description": "Updates the master for a specific cluster.",
"request": {
"$ref": "UpdateMasterRequest"
}
},
"setNetworkPolicy": {
"parameters": {
"name": {
"description": "The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format `projects/*/locations/*/clusters/*`.",
"location": "path",
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"required": true
}
},
"description": "Enables or disables Network Policy for a cluster.",
"parameterOrder": [
"name"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setNetworkPolicy",
"response": {
"$ref": "Operation"
},
"id": "container.projects.locations.clusters.setNetworkPolicy",
"httpMethod": "POST",
"request": {
"$ref": "SetNetworkPolicyRequest"
},
"path": "v1/{+name}:setNetworkPolicy"
},
"setLogging": {
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLogging",
"parameterOrder": [
"name"
],
"id": "container.projects.locations.clusters.setLogging",
"description": "Sets the logging service for a specific cluster.",
"response": {
"$ref": "Operation"
},
"parameters": {
"name": {
"location": "path",
"description": "The name (project, location, cluster) of the cluster to set logging. Specified in the format `projects/*/locations/*/clusters/*`.",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"type": "string"
}
},
"request": {
"$ref": "SetLoggingServiceRequest"
},
"path": "v1/{+name}:setLogging",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "POST"
},
"startIpRotation": {
"path": "v1/{+name}:startIpRotation",
"description": "Starts master IP rotation.",
"httpMethod": "POST",
"parameters": {
"name": {
"location": "path",
"required": true,
"description": "The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"type": "string"
}
},
"parameterOrder": [
"name"
],
"id": "container.projects.locations.clusters.startIpRotation",
"response": {
"$ref": "Operation"
},
"request": {
"$ref": "StartIPRotationRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:startIpRotation"
},
"setResourceLabels": {
"httpMethod": "POST",
"id": "container.projects.locations.clusters.setResourceLabels",
"path": "v1/{+name}:setResourceLabels",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Operation"
},
"parameters": {
"name": {
"location": "path",
"type": "string",
"description": "The name (project, location, cluster id) of the cluster to set labels. Specified in the format `projects/*/locations/*/clusters/*`.",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
}
},
"description": "Sets labels on a cluster.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setResourceLabels",
"request": {
"$ref": "SetLabelsRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "container.projects.locations.clusters.get",
"response": {
"$ref": "Cluster"
},
"path": "v1/{+name}",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
"httpMethod": "GET",
"parameterOrder": [
"name"
],
"description": "Gets the details of a specific cluster.",
"parameters": {
"projectId": {
"type": "string",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.",
"location": "query"
},
"clusterId": {
"type": "string",
"description": "Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field.",
"location": "query"
},
"zone": {
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
"location": "query"
},
"name": {
"type": "string",
"required": true,
"location": "path",
"description": "The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/*/locations/*/clusters/*`.",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
}
}
},
"update": {
"description": "Updates the settings of a specific cluster.",
"id": "container.projects.locations.clusters.update",
"path": "v1/{+name}",
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"description": "The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.",
"type": "string",
"required": true,
"location": "path"
}
},
"response": {
"$ref": "Operation"
},
"request": {
"$ref": "UpdateClusterRequest"
},
"httpMethod": "PUT",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameterOrder": [
"name"
]
},
"setMasterAuth": {
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"parameters": {
"name": {
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"location": "path",
"required": true,
"description": "The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`."
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMasterAuth",
"request": {
"$ref": "SetMasterAuthRequest"
},
"response": {
"$ref": "Operation"
},
"description": "Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.",
"path": "v1/{+name}:setMasterAuth",
"id": "container.projects.locations.clusters.setMasterAuth"
},
"create": {
"path": "v1/{+parent}/clusters",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "Operation"
},
"httpMethod": "POST",
"request": {
"$ref": "CreateClusterRequest"
},
"parameters": {
"parent": {
"pattern": "^projects/[^/]+/locations/[^/]+$",
"description": "The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`.",
"location": "path",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.",
"id": "container.projects.locations.clusters.create"
},
"setLocations": {
"httpMethod": "POST",
"parameterOrder": [
"name"
],
"path": "v1/{+name}:setLocations",
"parameters": {
"name": {
"location": "path",
"required": true,
"type": "string",
"description": "The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`.",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
}
},
"request": {
"$ref": "SetLocationsRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLocations",
"description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.",
"id": "container.projects.locations.clusters.setLocations",
"response": {
"$ref": "Operation"
}
},
"setMaintenancePolicy": {
"request": {
"$ref": "SetMaintenancePolicyRequest"
},
"path": "v1/{+name}:setMaintenancePolicy",
"id": "container.projects.locations.clusters.setMaintenancePolicy",
"response": {
"$ref": "Operation"
},
"parameters": {
"name": {
"location": "path",
"type": "string",
"description": "The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format `projects/*/locations/*/clusters/*`.",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
}
},
"description": "Sets the maintenance policy for a cluster.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMaintenancePolicy",
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameterOrder": [
"name"
]
},
"setLegacyAbac": {
"request": {
"$ref": "SetLegacyAbacRequest"
},
"response": {
"$ref": "Operation"
},
"parameters": {
"name": {
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"type": "string",
"location": "path",
"description": "The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format `projects/*/locations/*/clusters/*`."
}
},
"id": "container.projects.locations.clusters.setLegacyAbac",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLegacyAbac",
"parameterOrder": [
"name"
],
"path": "v1/{+name}:setLegacyAbac",
"httpMethod": "POST",
"description": "Enables or disables the ABAC authorization mechanism on a cluster.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"nodePools": {
"methods": {
"create": {
"path": "v1/{+parent}/nodePools",
"description": "Creates a node pool for a cluster.",
"parameterOrder": [
"parent"
],
"id": "container.projects.locations.clusters.nodePools.create",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools",
"request": {
"$ref": "CreateNodePoolRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "Operation"
},
"httpMethod": "POST",
"parameters": {
"parent": {
"description": "The parent (project, location, cluster id) where the node pool will be created. Specified in the format `projects/*/locations/*/clusters/*`.",
"required": true,
"type": "string",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
}
}
},
"rollback": {
"description": "Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:rollback",
"id": "container.projects.locations.clusters.nodePools.rollback",
"parameters": {
"name": {
"type": "string",
"description": "The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.",
"required": true,
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$"
}
},
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
"request": {
"$ref": "RollbackNodePoolUpgradeRequest"
},
"path": "v1/{+name}:rollback",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "POST"
},
"delete": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "DELETE",
"parameters": {
"nodePoolId": {
"description": "Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field.",
"type": "string",
"location": "query"
},
"zone": {
"location": "query",
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field."
},
"projectId": {
"location": "query",
"type": "string",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field."
},
"clusterId": {
"type": "string",
"location": "query",
"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field."
},
"name": {
"type": "string",
"location": "path",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
"description": "The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`."
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}",
"parameterOrder": [
"name"
],
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"id": "container.projects.locations.clusters.nodePools.delete",
"description": "Deletes a node pool from a cluster."
},
"list": {
"parameters": {
"zone": {
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
"type": "string",
"location": "query"
},
"projectId": {
"location": "query",
"type": "string",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field."
},
"parent": {
"required": true,
"type": "string",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"description": "The parent (project, location, cluster id) where the node pools will be listed. Specified in the format `projects/*/locations/*/clusters/*`."
},
"clusterId": {
"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.",
"type": "string",
"location": "query"
}
},
"description": "Lists the node pools for a cluster.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools",
"response": {
"$ref": "ListNodePoolsResponse"
},
"httpMethod": "GET",
"id": "container.projects.locations.clusters.nodePools.list",
"path": "v1/{+parent}/nodePools",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameterOrder": [
"parent"
]
},
"get": {
"httpMethod": "GET",
"path": "v1/{+name}",
"description": "Retrieves the requested node pool.",
"parameters": {
"name": {
"required": true,
"description": "The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
"type": "string"
},
"nodePoolId": {
"type": "string",
"location": "query",
"description": "Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field."
},
"zone": {
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
"location": "query"
},
"projectId": {
"type": "string",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.",
"location": "query"
},
"clusterId": {
"type": "string",
"location": "query",
"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field."
}
},
"response": {
"$ref": "NodePool"
},
"parameterOrder": [
"name"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "container.projects.locations.clusters.nodePools.get"
},
"setAutoscaling": {
"path": "v1/{+name}:setAutoscaling",
"description": "Sets the autoscaling settings for the specified node pool.",
"id": "container.projects.locations.clusters.nodePools.setAutoscaling",
"request": {
"$ref": "SetNodePoolAutoscalingRequest"
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setAutoscaling",
"response": {
"$ref": "Operation"
},
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"location": "path",
"required": true,
"description": "The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
"type": "string"
}
}
},
"setManagement": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameterOrder": [
"name"
],
"description": "Sets the NodeManagement options for a node pool.",
"id": "container.projects.locations.clusters.nodePools.setManagement",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setManagement",
"response": {
"$ref": "Operation"
},
"parameters": {
"name": {
"description": "The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.",
"location": "path",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$"
}
},
"path": "v1/{+name}:setManagement",
"request": {
"$ref": "SetNodePoolManagementRequest"
},
"httpMethod": "POST"
},
"setSize": {
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"location": "path",
"type": "string",
"required": true,
"description": "The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setSize",
"parameterOrder": [
"name"
],
"id": "container.projects.locations.clusters.nodePools.setSize",
"path": "v1/{+name}:setSize",
"description": "Sets the size for a specific node pool.",
"request": {
"$ref": "SetNodePoolSizeRequest"
},
"response": {
"$ref": "Operation"
}
},
"update": {
"request": {
"$ref": "UpdateNodePoolRequest"
},
"id": "container.projects.locations.clusters.nodePools.update",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
"description": "Updates the version and/or image type for the specified node pool.",
"httpMethod": "PUT",
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
"required": true,
"location": "path",
"type": "string",
"description": "The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`."
}
},
"path": "v1/{+name}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}"
}
}
},
"well-known": {
"methods": {
"getOpenid-configuration": {
"response": {
"$ref": "GetOpenIDConfigResponse"
},
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/.well-known/openid-configuration",
"path": "v1/{+parent}/.well-known/openid-configuration",
"id": "container.projects.locations.clusters.well-known.getOpenid-configuration",
"parameters": {
"parent": {
"location": "path",
"description": "The cluster (project, location, cluster id) to get the discovery document for. Specified in the format `projects/*/locations/*/clusters/*`.",
"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"type": "string",
"required": true
}
},
"description": "Gets the OIDC discovery document for the cluster. See the [OpenID Connect Discovery 1.0 specification](https://openid.net/specs/openid-connect-discovery-1_0.html) for details. This API is not yet intended for general use, and is not available for all clusters."
}
}
}
}
}
}
},
"zones": {
"methods": {
"getServerconfig": {
"path": "v1/projects/{projectId}/zones/{zone}/serverconfig",
"response": {
"$ref": "ServerConfig"
},
"parameters": {
"zone": {
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.",
"location": "path",
"type": "string",
"required": true
},
"name": {
"description": "The name (project and location) of the server config to get, specified in the format `projects/*/locations/*`.",
"location": "query",
"type": "string"
},
"projectId": {
"location": "path",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.",
"required": true,
"type": "string"
}
},
"id": "container.projects.zones.getServerconfig",
"flatPath": "v1/projects/{projectId}/zones/{zone}/serverconfig",
"parameterOrder": [
"projectId",
"zone"
],
"description": "Returns configuration info about the Google Kubernetes Engine service.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "GET"
}
},
"resources": {
"operations": {
"methods": {
"get": {
"id": "container.projects.zones.operations.get",
"parameterOrder": [
"projectId",
"zone",
"operationId"
],
"path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
"parameters": {
"name": {
"description": "The name (project, location, operation id) of the operation to get. Specified in the format `projects/*/locations/*/operations/*`.",
"type": "string",
"location": "query"
},
"projectId": {
"location": "path",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.",
"required": true,
"type": "string"
},
"zone": {
"type": "string",
"location": "path",
"required": true,
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field."
},
"operationId": {
"location": "path",
"required": true,
"description": "Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.",
"type": "string"
}
},
"response": {
"$ref": "Operation"
},
"httpMethod": "GET",
"description": "Gets the specified operation.",
"flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"parameters": {
"parent": {
"location": "query",
"type": "string",
"description": "The parent (project and location) where the operations will be listed. Specified in the format `projects/*/locations/*`. Location \"-\" matches all zones and all regions."
},
"zone": {
"required": true,
"location": "path",
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field."
},
"projectId": {
"location": "path",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field.",
"type": "string",
"required": true
}
},
"httpMethod": "GET",
"parameterOrder": [
"projectId",
"zone"
],
"response": {
"$ref": "ListOperationsResponse"
},
"description": "Lists all operations in a project in a specific zone or all zones.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectId}/zones/{zone}/operations",
"id": "container.projects.zones.operations.list",
"path": "v1/projects/{projectId}/zones/{zone}/operations"
},
"cancel": {
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"projectId",
"zone",
"operationId"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"operationId": {
"location": "path",
"description": "Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.",
"type": "string",
"required": true
},
"projectId": {
"location": "path",
"required": true,
"type": "string",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field."
},
"zone": {
"required": true,
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.",
"type": "string",
"location": "path"
}
},
"id": "container.projects.zones.operations.cancel",
"description": "Cancels the specified operation.",
"httpMethod": "POST",
"flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
"path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
"request": {
"$ref": "CancelOperationRequest"
}
}
}
},
"clusters": {
"resources": {
"nodePools": {
"methods": {
"update": {
"id": "container.projects.zones.clusters.nodePools.update",
"response": {
"$ref": "Operation"
},
"request": {
"$ref": "UpdateNodePoolRequest"
},
"parameters": {
"projectId": {
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.",
"required": true,
"location": "path",
"type": "string"
},
"nodePoolId": {
"type": "string",
"description": "Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.",
"location": "path",
"required": true
},
"clusterId": {
"type": "string",
"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.",
"location": "path",
"required": true
},
"zone": {
"type": "string",
"required": true,
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
"location": "path"
}
},
"description": "Updates the version and/or image type for the specified node pool.",
"parameterOrder": [
"projectId",
"zone",
"clusterId",
"nodePoolId"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update",
"httpMethod": "POST"
},
"get": {
"response": {
"$ref": "NodePool"
},
"description": "Retrieves the requested node pool.",
"httpMethod": "GET",
"id": "container.projects.zones.clusters.nodePools.get",
"parameters": {
"zone": {
"location": "path",
"type": "string",
"required": true,
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field."
},
"projectId": {
"type": "string",
"location": "path",
"required": true,
"description": "Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field."
},
"nodePoolId": {
"type": "string",
"required": true,
"description": "Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field.",
"location": "path"
},
"name": {
"description": "The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.",
"type": "string",
"location": "query"
},
"clusterId": {
"type": "string",
"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"projectId",
"zone",
"clusterId",
"nodePoolId"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}"
},
"setManagement": {
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
"parameters": {
"zone": {
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
"required": true,
"location": "path"
},
"projectId": {
"location": "path",
"type": "string",
"required": true,
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field."
},
"clusterId": {
"location": "path",
"required": true,
"description": "Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.",
"type": "string"
},
"nodePoolId": {
"location": "path",
"description": "Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "Operation"
},
"id": "container.projects.zones.clusters.nodePools.setManagement",
"httpMethod": "POST",
"request": {
"$ref": "SetNodePoolManagementRequest"
},
"parameterOrder": [
"projectId",
"zone",
"clusterId",
"nodePoolId"
],
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
"description": "Sets the NodeManagement options for a node pool."
},
"autoscaling": {
"request": {
"$ref": "SetNodePoolAutoscalingRequest"
},
"description": "Sets the autoscaling settings for the specified node pool.",
"parameters": {
"nodePoolId": {
"required": true,
"location": "path",
"description": "Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.",
"type": "string"
},
"clusterId": {
"type": "string",
"location": "path",
"required": true,
"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field."
},
"zone": {
"required": true,
"location": "path",
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field."
},
"projectId": {
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.",
"location": "path",
"type": "string",
"required": true
}
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling",
"httpMethod": "POST",
"parameterOrder": [
"projectId",
"zone",
"clusterId",
"nodePoolId"
],
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling",
"id": "container.projects.zones.clusters.nodePools.autoscaling"
},
"setSize": {
"description": "Sets the size for a specific node pool.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"request": {
"$ref": "SetNodePoolSizeRequest"
},
"id": "container.projects.zones.clusters.nodePools.setSize",
"response": {
"$ref": "Operation"
},
"httpMethod": "POST",
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize",
"parameters": {
"clusterId": {
"description": "Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.",
"location": "path",
"type": "string",
"required": true
},
"zone": {
"location": "path",
"required": true,
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field."
},
"nodePoolId": {
"type": "string",
"description": "Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.",
"required": true,
"location": "path"
},
"projectId": {
"location": "path",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.",
"type": "string",
"required": true
}
},
"parameterOrder": [
"projectId",
"zone",
"clusterId",
"nodePoolId"
],
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize"
},
"create": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "POST",
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
"response": {
"$ref": "Operation"
},
"parameters": {
"zone": {
"location": "path",
"type": "string",
"required": true,
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field."
},
"projectId": {
"type": "string",
"required": true,
"description": "Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field.",
"location": "path"
},
"clusterId": {
"type": "string",
"required": true,
"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.",
"location": "path"
}
},
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
"id": "container.projects.zones.clusters.nodePools.create",
"description": "Creates a node pool for a cluster.",
"request": {
"$ref": "CreateNodePoolRequest"
},
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools"
},
"rollback": {
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
"request": {
"$ref": "RollbackNodePoolUpgradeRequest"
},
"parameters": {
"zone": {
"location": "path",
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
"required": true
},
"projectId": {
"type": "string",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.",
"required": true,
"location": "path"
},
"clusterId": {
"required": true,
"description": "Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.",
"location": "path",
"type": "string"
},
"nodePoolId": {
"type": "string",
"location": "path",
"description": "Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field.",
"required": true
}
},
"httpMethod": "POST",
"id": "container.projects.zones.clusters.nodePools.rollback",
"parameterOrder": [
"projectId",
"zone",
"clusterId",
"nodePoolId"
],
"response": {
"$ref": "Operation"
},
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed."
},
"list": {
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
"httpMethod": "GET",
"id": "container.projects.zones.clusters.nodePools.list",
"parameters": {
"clusterId": {
"type": "string",
"required": true,
"location": "path",
"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field."
},
"parent": {
"type": "string",
"location": "query",
"description": "The parent (project, location, cluster id) where the node pools will be listed. Specified in the format `projects/*/locations/*/clusters/*`."
},
"zone": {
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
"location": "path",
"required": true
},
"projectId": {
"type": "string",
"required": true,
"description": "Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field.",
"location": "path"
}
},
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
"description": "Lists the node pools for a cluster.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "ListNodePoolsResponse"
}
},
"delete": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
"parameters": {
"projectId": {
"required": true,
"type": "string",
"location": "path",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field."
},
"zone": {
"location": "path",
"required": true,
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field."
},
"nodePoolId": {
"type": "string",
"description": "Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field.",
"required": true,
"location": "path"
},
"name": {
"description": "The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.",
"type": "string",
"location": "query"
},
"clusterId": {
"type": "string",
"location": "path",
"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.",
"required": true
}
},
"response": {
"$ref": "Operation"
},
"id": "container.projects.zones.clusters.nodePools.delete",
"httpMethod": "DELETE",
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
"description": "Deletes a node pool from a cluster.",
"parameterOrder": [
"projectId",
"zone",
"clusterId",
"nodePoolId"
]
}
}
}
},
"methods": {
"update": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
"id": "container.projects.zones.clusters.update",
"parameters": {
"projectId": {
"location": "path",
"type": "string",
"required": true,
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field."
},
"clusterId": {
"location": "path",
"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.",
"type": "string",
"required": true
},
"zone": {
"type": "string",
"location": "path",
"required": true,
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field."
}
},
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
"description": "Updates the settings of a specific cluster.",
"httpMethod": "PUT",
"request": {
"$ref": "UpdateClusterRequest"
},
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}"
},
"setMaintenancePolicy": {
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
"response": {
"$ref": "Operation"
},
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy",
"description": "Sets the maintenance policy for a cluster.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "container.projects.zones.clusters.setMaintenancePolicy",
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy",
"httpMethod": "POST",
"parameters": {
"projectId": {
"type": "string",
"description": "Required. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840).",
"location": "path",
"required": true
},
"clusterId": {
"required": true,
"type": "string",
"description": "Required. The name of the cluster to update.",
"location": "path"
},
"zone": {
"location": "path",
"description": "Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides.",
"type": "string",
"required": true
}
},
"request": {
"$ref": "SetMaintenancePolicyRequest"
}
},
"setMasterAuth": {
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth",
"parameters": {
"clusterId": {
"required": true,
"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.",
"location": "path",
"type": "string"
},
"projectId": {
"required": true,
"type": "string",
"location": "path",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field."
},
"zone": {
"required": true,
"location": "path",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
"type": "string"
}
},
"id": "container.projects.zones.clusters.setMasterAuth",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "POST",
"request": {
"$ref": "SetMasterAuthRequest"
},
"description": "Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.",
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth"
},
"legacyAbac": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"clusterId": {
"required": true,
"location": "path",
"type": "string",
"description": "Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field."
},
"zone": {
"required": true,
"type": "string",
"location": "path",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field."
},
"projectId": {
"location": "path",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.",
"type": "string",
"required": true
}
},
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
"httpMethod": "POST",
"request": {
"$ref": "SetLegacyAbacRequest"
},
"description": "Enables or disables the ABAC authorization mechanism on a cluster.",
"response": {
"$ref": "Operation"
},
"id": "container.projects.zones.clusters.legacyAbac"
},
"create": {
"path": "v1/projects/{projectId}/zones/{zone}/clusters",
"parameterOrder": [
"projectId",
"zone"
],
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters",
"description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.",
"request": {
"$ref": "CreateClusterRequest"
},
"id": "container.projects.zones.clusters.create",
"parameters": {
"zone": {
"location": "path",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
"type": "string",
"required": true
},
"projectId": {
"required": true,
"location": "path",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "Operation"
},
"httpMethod": "POST"
},
"list": {
"description": "Lists all clusters owned by a project in either the specified zone or all zones.",
"response": {
"$ref": "ListClustersResponse"
},
"parameters": {
"zone": {
"location": "path",
"required": true,
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field."
},
"projectId": {
"location": "path",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field.",
"required": true,
"type": "string"
},
"parent": {
"description": "The parent (project and location) where the clusters will be listed. Specified in the format `projects/*/locations/*`. Location \"-\" matches all zones and all regions.",
"type": "string",
"location": "query"
}
},
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters",
"parameterOrder": [
"projectId",
"zone"
],
"httpMethod": "GET",
"id": "container.projects.zones.clusters.list",
"path": "v1/projects/{projectId}/zones/{zone}/clusters",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"addons": {
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons",
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
"description": "Sets the addons for a specific cluster.",
"id": "container.projects.zones.clusters.addons",
"response": {
"$ref": "Operation"
},
"request": {
"$ref": "SetAddonsConfigRequest"
},
"parameters": {
"clusterId": {
"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.",
"required": true,
"location": "path",
"type": "string"
},
"zone": {
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
"required": true,
"location": "path",
"type": "string"
},
"projectId": {
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.",
"required": true,
"location": "path",
"type": "string"
}
},
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons"
},
"startIpRotation": {
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
"parameters": {
"zone": {
"location": "path",
"type": "string",
"required": true,
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field."
},
"projectId": {
"type": "string",
"location": "path",
"required": true,
"description": "Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field."
},
"clusterId": {
"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.",
"required": true,
"location": "path",
"type": "string"
}
},
"id": "container.projects.zones.clusters.startIpRotation",
"response": {
"$ref": "Operation"
},
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Starts master IP rotation.",
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
"request": {
"$ref": "StartIPRotationRequest"
},
"httpMethod": "POST"
},
"setNetworkPolicy": {
"httpMethod": "POST",
"description": "Enables or disables Network Policy for a cluster.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
"id": "container.projects.zones.clusters.setNetworkPolicy",
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
"parameters": {
"zone": {
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
"location": "path",
"required": true,
"type": "string"
},
"clusterId": {
"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.",
"required": true,
"type": "string",
"location": "path"
},
"projectId": {
"location": "path",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.",
"type": "string",
"required": true
}
},
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
"response": {
"$ref": "Operation"
},
"request": {
"$ref": "SetNetworkPolicyRequest"
}
},
"locations": {
"parameters": {
"zone": {
"required": true,
"location": "path",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
"type": "string"
},
"projectId": {
"location": "path",
"required": true,
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.",
"type": "string"
},
"clusterId": {
"location": "path",
"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.",
"type": "string",
"required": true
}
},
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
"description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
"id": "container.projects.zones.clusters.locations",
"httpMethod": "POST",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"request": {
"$ref": "SetLocationsRequest"
}
},
"master": {
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
"id": "container.projects.zones.clusters.master",
"request": {
"$ref": "UpdateMasterRequest"
},
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master",
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master",
"parameters": {
"clusterId": {
"type": "string",
"location": "path",
"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.",
"required": true
},
"projectId": {
"location": "path",
"type": "string",
"required": true,
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field."
},
"zone": {
"location": "path",
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Updates the master for a specific cluster.",
"httpMethod": "POST",
"response": {
"$ref": "Operation"
}
},
"monitoring": {
"id": "container.projects.zones.clusters.monitoring",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"request": {
"$ref": "SetMonitoringServiceRequest"
},
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring",
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
"httpMethod": "POST",
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring",
"description": "Sets the monitoring service for a specific cluster.",
"parameters": {
"zone": {
"location": "path",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
"type": "string",
"required": true
},
"projectId": {
"location": "path",
"type": "string",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.",
"required": true
},
"clusterId": {
"required": true,
"type": "string",
"location": "path",
"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field."
}
},
"response": {
"$ref": "Operation"
}
},
"delete": {
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
"parameters": {
"zone": {
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
"required": true,
"location": "path",
"type": "string"
},
"projectId": {
"type": "string",
"required": true,
"location": "path",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field."
},
"name": {
"type": "string",
"location": "query",
"description": "The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/*/locations/*/clusters/*`."
},
"clusterId": {
"required": true,
"location": "path",
"description": "Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field.",
"type": "string"
}
},
"response": {
"$ref": "Operation"
},
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
"id": "container.projects.zones.clusters.delete",
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "DELETE",
"description": "Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created."
},
"completeIpRotation": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"request": {
"$ref": "CompleteIPRotationRequest"
},
"description": "Completes master IP rotation.",
"id": "container.projects.zones.clusters.completeIpRotation",
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
"parameters": {
"clusterId": {
"location": "path",
"type": "string",
"required": true,
"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field."
},
"projectId": {
"required": true,
"location": "path",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.",
"type": "string"
},
"zone": {
"type": "string",
"location": "path",
"required": true,
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field."
}
},
"httpMethod": "POST",
"response": {
"$ref": "Operation"
}
},
"resourceLabels": {
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
"id": "container.projects.zones.clusters.resourceLabels",
"httpMethod": "POST",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
"description": "Sets labels on a cluster.",
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"zone": {
"type": "string",
"location": "path",
"required": true,
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field."
},
"projectId": {
"location": "path",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.",
"type": "string",
"required": true
},
"clusterId": {
"type": "string",
"required": true,
"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.",
"location": "path"
}
},
"request": {
"$ref": "SetLabelsRequest"
}
},
"logging": {
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging",
"id": "container.projects.zones.clusters.logging",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging",
"parameters": {
"clusterId": {
"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.",
"location": "path",
"required": true,
"type": "string"
},
"zone": {
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
"type": "string",
"required": true,
"location": "path"
},
"projectId": {
"required": true,
"location": "path",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.",
"type": "string"
}
},
"response": {
"$ref": "Operation"
},
"httpMethod": "POST",
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"request": {
"$ref": "SetLoggingServiceRequest"
},
"description": "Sets the logging service for a specific cluster."
},
"get": {
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
"parameters": {
"name": {
"type": "string",
"location": "query",
"description": "The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/*/locations/*/clusters/*`."
},
"zone": {
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
"location": "path",
"required": true,
"type": "string"
},
"projectId": {
"type": "string",
"location": "path",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.",
"required": true
},
"clusterId": {
"description": "Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field.",
"required": true,
"location": "path",
"type": "string"
}
},
"response": {
"$ref": "Cluster"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "GET",
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
"id": "container.projects.zones.clusters.get",
"description": "Gets the details of a specific cluster."
}
}
}
}
}
}
}
},
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"baseUrl": "https://container.googleapis.com/",
"canonicalName": "Container",
"parameters": {
"access_token": {
"type": "string",
"description": "OAuth access token.",
"location": "query"
},
"key": {
"location": "query",
"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.",
"type": "string"
},
"upload_protocol": {
"location": "query",
"type": "string",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"uploadType": {
"location": "query",
"type": "string",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
},
"quotaUser": {
"type": "string",
"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"
},
"callback": {
"location": "query",
"description": "JSONP",
"type": "string"
},
"$.xgafv": {
"description": "V1 error format.",
"type": "string",
"location": "query",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"enum": [
"1",
"2"
]
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
"location": "query",
"default": "true"
},
"alt": {
"location": "query",
"enum": [
"json",
"media",
"proto"
],
"default": "json",
"description": "Data format for response.",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"type": "string"
}
},
"mtlsRootUrl": "https://container.mtls.googleapis.com/",
"kind": "discovery#restDescription",
"id": "container:v1",
"title": "Kubernetes Engine API",
"name": "container",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"ownerDomain": "google.com",
"ownerName": "Google",
"basePath": "",
"fullyEncodeReservedExpansion": true,
"revision": "20201007",
"rootUrl": "https://container.googleapis.com/",
"servicePath": "",
"protocol": "rest",
"schemas": {
"VerticalPodAutoscaling": {
"type": "object",
"properties": {
"enabled": {
"description": "Enables vertical pod autoscaling.",
"type": "boolean"
}
},
"id": "VerticalPodAutoscaling",
"description": "VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it."
},
"ConsumptionMeteringConfig": {
"properties": {
"enabled": {
"description": "Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records.",
"type": "boolean"
}
},
"type": "object",
"description": "Parameters for controlling consumption metering.",
"id": "ConsumptionMeteringConfig"
},
"UpdateMasterRequest": {
"type": "object",
"description": "UpdateMasterRequest updates the master of the cluster.",
"id": "UpdateMasterRequest",
"properties": {
"name": {
"type": "string",
"description": "The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`."
},
"masterVersion": {
"type": "string",
"description": "Required. The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - \"latest\": picks the highest valid Kubernetes version - \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version - \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version - \"1.X.Y-gke.N\": picks an explicit Kubernetes version - \"-\": picks the default Kubernetes version"
},
"clusterId": {
"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.",
"type": "string"
},
"zone": {
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
"type": "string"
},
"projectId": {
"type": "string",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field."
}
}
},
"AddonsConfig": {
"type": "object",
"id": "AddonsConfig",
"properties": {
"kubernetesDashboard": {
"$ref": "KubernetesDashboard",
"description": "Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards"
},
"httpLoadBalancing": {
"$ref": "HttpLoadBalancing",
"description": "Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster."
},
"horizontalPodAutoscaling": {
"$ref": "HorizontalPodAutoscaling",
"description": "Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods."
},
"cloudRunConfig": {
"description": "Configuration for the Cloud Run addon, which allows the user to use a managed Knative service.",
"$ref": "CloudRunConfig"
},
"dnsCacheConfig": {
"description": "Configuration for NodeLocalDNS, a dns cache running on cluster nodes",
"$ref": "DnsCacheConfig"
},
"networkPolicyConfig": {
"description": "Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.",
"$ref": "NetworkPolicyConfig"
},
"configConnectorConfig": {
"description": "Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API",
"$ref": "ConfigConnectorConfig"
}
},
"description": "Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality."
},
"DnsCacheConfig": {
"id": "DnsCacheConfig",
"description": "Configuration for NodeLocal DNSCache",
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether NodeLocal DNSCache is enabled for this cluster."
}
}
},
"NetworkPolicy": {
"type": "object",
"description": "Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/",
"id": "NetworkPolicy",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether network policy is enabled on the cluster."
},
"provider": {
"enum": [
"PROVIDER_UNSPECIFIED",
"CALICO"
],
"enumDescriptions": [
"Not set",
"Tigera (Calico Felix)."
],
"type": "string",
"description": "The selected network policy provider."
}
}
},
"OperationProgress": {
"type": "object",
"id": "OperationProgress",
"properties": {
"metrics": {
"items": {
"$ref": "Metric"
},
"type": "array",
"description": "Progress metric bundle, for example: metrics: [{name: \"nodes done\", int_value: 15}, {name: \"nodes total\", int_value: 32}] or metrics: [{name: \"progress\", double_value: 0.56}, {name: \"progress scale\", double_value: 1.0}]"
},
"stages": {
"items": {
"$ref": "OperationProgress"
},
"type": "array",
"description": "Substages of an operation or a stage."
},
"name": {
"type": "string",
"description": "A non-parameterized string describing an operation stage. Unset for single-stage operations."
},
"status": {
"enum": [
"STATUS_UNSPECIFIED",
"PENDING",
"RUNNING",
"DONE",
"ABORTING"
],
"description": "Status of an operation stage. Unset for single-stage operations.",
"type": "string",
"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."
]
}
},
"description": "Information about operation (or operation stage) progress."
},
"UsableSubnetworkSecondaryRange": {
"id": "UsableSubnetworkSecondaryRange",
"properties": {
"ipCidrRange": {
"description": "The range of IP addresses belonging to this subnetwork secondary range.",
"type": "string"
},
"status": {
"type": "string",
"enum": [
"UNKNOWN",
"UNUSED",
"IN_USE_SERVICE",
"IN_USE_SHAREABLE_POD",
"IN_USE_MANAGED_POD"
],
"description": "This field is to determine the status of the secondary range programmably.",
"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 services. It cannot be used for other clusters.",
"IN_USE_SHAREABLE_POD denotes this range was created by the network admin and is currently claimed by a cluster for pods. It can only be used by other clusters as a pod range.",
"IN_USE_MANAGED_POD denotes this range was created by GKE and is claimed for pods. It cannot be used for other clusters."
]
},
"rangeName": {
"type": "string",
"description": "The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance."
}
},
"type": "object",
"description": "Secondary IP range of a usable subnetwork."
},
"MaintenancePolicy": {
"properties": {
"resourceVersion": {
"type": "string",
"description": "A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy."
},
"window": {
"$ref": "MaintenanceWindow",
"description": "Specifies the maintenance window in which maintenance may be performed."
}
},
"description": "MaintenancePolicy defines the maintenance policy to be used for the cluster.",
"id": "MaintenancePolicy",
"type": "object"
},
"UpgradeSettings": {
"type": "object",
"description": "These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available.",
"properties": {
"maxUnavailable": {
"type": "integer",
"description": "The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.",
"format": "int32"
},
"maxSurge": {
"description": "The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.",
"format": "int32",
"type": "integer"
}
},
"id": "UpgradeSettings"
},
"MasterAuth": {
"description": "The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates.",
"properties": {
"password": {
"description": "The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication",
"type": "string"
},
"clusterCaCertificate": {
"type": "string",
"description": "[Output only] Base64-encoded public certificate that is the root of trust for the cluster."
},
"clientKey": {
"type": "string",
"description": "[Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint."
},
"username": {
"description": "The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication",
"type": "string"
},
"clientCertificateConfig": {
"description": "Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.",
"$ref": "ClientCertificateConfig"
},
"clientCertificate": {
"type": "string",
"description": "[Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint."
}
},
"type": "object",
"id": "MasterAuth"
},
"NetworkConfig": {
"description": "NetworkConfig reports the relative names of network & subnetwork.",
"properties": {
"enableIntraNodeVisibility": {
"type": "boolean",
"description": "Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network."
},
"subnetwork": {
"type": "string",
"description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet"
},
"defaultSnatStatus": {
"description": "Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic.",
"$ref": "DefaultSnatStatus"
},
"network": {
"description": "Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network",
"type": "string"
}
},
"type": "object",
"id": "NetworkConfig"
},
"MasterAuthorizedNetworksConfig": {
"properties": {
"enabled": {
"description": "Whether or not master authorized networks is enabled.",
"type": "boolean"
},
"cidrBlocks": {
"items": {
"$ref": "CidrBlock"
},
"description": "cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.",
"type": "array"
}
},
"type": "object",
"id": "MasterAuthorizedNetworksConfig",
"description": "Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs."
},
"RollbackNodePoolUpgradeRequest": {
"description": "RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.",
"properties": {
"clusterId": {
"description": "Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.",
"type": "string"
},
"name": {
"type": "string",
"description": "The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`."
},
"zone": {
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field."
},
"projectId": {
"type": "string",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field."
},
"nodePoolId": {
"type": "string",
"description": "Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field."
}
},
"id": "RollbackNodePoolUpgradeRequest",
"type": "object"
},
"AuthenticatorGroupsConfig": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether this cluster should return group membership lookups during authentication using a group of security groups."
},
"securityGroup": {
"description": "The name of the security group-of-groups to be used. Only relevant if enabled = true.",
"type": "string"
}
},
"type": "object",
"id": "AuthenticatorGroupsConfig",
"description": "Configuration for returning group information from authenticators."
},
"StartIPRotationRequest": {
"id": "StartIPRotationRequest",
"description": "StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP.",
"type": "object",
"properties": {
"rotateCredentials": {
"description": "Whether to rotate credentials during IP rotation.",
"type": "boolean"
},
"projectId": {
"description": "Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.",
"type": "string"
},
"clusterId": {
"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.",
"type": "string"
},
"name": {
"type": "string",
"description": "The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format `projects/*/locations/*/clusters/*`."
},
"zone": {
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
"type": "string"
}
}
},
"ListNodePoolsResponse": {
"description": "ListNodePoolsResponse is the result of ListNodePoolsRequest.",
"properties": {
"nodePools": {
"description": "A list of node pools for a cluster.",
"items": {
"$ref": "NodePool"
},
"type": "array"
}
},
"type": "object",
"id": "ListNodePoolsResponse"
},
"NodeManagement": {
"description": "NodeManagement defines the set of node management services turned on for the node pool.",
"properties": {
"autoRepair": {
"type": "boolean",
"description": "A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered."
},
"autoUpgrade": {
"type": "boolean",
"description": "A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes."
},
"upgradeOptions": {
"$ref": "AutoUpgradeOptions",
"description": "Specifies the Auto Upgrade knobs for the node pool."
}
},
"id": "NodeManagement",
"type": "object"
},
"DefaultSnatStatus": {
"description": "DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster.",
"type": "object",
"id": "DefaultSnatStatus",
"properties": {
"disabled": {
"type": "boolean",
"description": "Disables cluster default sNAT rules."
}
}
},
"WorkloadIdentityConfig": {
"type": "object",
"description": "Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.",
"properties": {
"workloadPool": {
"description": "The workload pool to attach all Kubernetes service accounts to.",
"type": "string"
}
},
"id": "WorkloadIdentityConfig"
},
"UpdateNodePoolRequest": {
"id": "UpdateNodePoolRequest",
"properties": {
"workloadMetadataConfig": {
"description": "The desired workload metadata config for the node pool.",
"$ref": "WorkloadMetadataConfig"
},
"clusterId": {
"type": "string",
"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field."
},
"zone": {
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This 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 update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.",
"type": "string"
},
"imageType": {
"type": "string",
"description": "Required. The desired image type for the node pool."
},
"projectId": {
"type": "string",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field."
},
"nodeVersion": {
"description": "Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - \"latest\": picks the highest valid Kubernetes version - \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version - \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version - \"1.X.Y-gke.N\": picks an explicit Kubernetes version - \"-\": picks the Kubernetes master version",
"type": "string"
},
"locations": {
"type": "array",
"items": {
"type": "string"
},
"description": "The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed."
},
"upgradeSettings": {
"description": "Upgrade settings control disruption and speed of the upgrade.",
"$ref": "UpgradeSettings"
},
"nodePoolId": {
"type": "string",
"description": "Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field."
}
},
"type": "object",
"description": "UpdateNodePoolRequests update a node pool's image and/or version."
},
"SetNodePoolSizeRequest": {
"type": "object",
"description": "SetNodePoolSizeRequest sets the size a node pool.",
"id": "SetNodePoolSizeRequest",
"properties": {
"zone": {
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field."
},
"nodePoolId": {
"type": "string",
"description": "Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field."
},
"projectId": {
"type": "string",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field."
},
"name": {
"description": "The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.",
"type": "string"
},
"clusterId": {
"description": "Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.",
"type": "string"
},
"nodeCount": {
"type": "integer",
"format": "int32",
"description": "Required. The desired node count for the pool."
}
}
},
"NodePool": {
"type": "object",
"properties": {
"autoscaling": {
"$ref": "NodePoolAutoscaling",
"description": "Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present."
},
"locations": {
"type": "array",
"description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.",
"items": {
"type": "string"
}
},
"selfLink": {
"type": "string",
"description": "[Output only] Server-defined URL for the resource."
},
"upgradeSettings": {
"description": "Upgrade settings control disruption and speed of the upgrade.",
"$ref": "UpgradeSettings"
},
"maxPodsConstraint": {
"description": "The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.",
"$ref": "MaxPodsConstraint"
},
"management": {
"description": "NodeManagement configuration for this NodePool.",
"$ref": "NodeManagement"
},
"initialNodeCount": {
"description": "The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.",
"format": "int32",
"type": "integer"
},
"status": {
"description": "[Output only] The status of the nodes in this pool instance.",
"enumDescriptions": [
"Not set.",
"The PROVISIONING state indicates the node pool is being created.",
"The RUNNING state indicates the node pool has been created and is fully usable.",
"The RUNNING_WITH_ERROR state indicates the node pool has been created and is partially usable. Some error state has occurred and some functionality may be impaired. Customer may need to reissue a request or trigger a new update.",
"The RECONCILING state indicates that some work is actively being done on the node pool, such as upgrading node software. Details can be 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 can be found in the `statusMessage` field."
],
"enum": [
"STATUS_UNSPECIFIED",
"PROVISIONING",
"RUNNING",
"RUNNING_WITH_ERROR",
"RECONCILING",
"STOPPING",
"ERROR"
],
"type": "string"
},
"statusMessage": {
"type": "string",
"description": "[Output only] Additional information about the current status of this node pool instance, if available."
},
"podIpv4CidrSize": {
"description": "[Output only] The pod CIDR block size per node in this node pool.",
"type": "integer",
"format": "int32"
},
"instanceGroupUrls": {
"type": "array",
"items": {
"type": "string"
},
"description": "[Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool."
},
"version": {
"description": "The version of the Kubernetes of this node.",
"type": "string"
},
"name": {
"description": "The name of the node pool.",
"type": "string"
},
"config": {
"$ref": "NodeConfig",
"description": "The node configuration of the pool."
},
"conditions": {
"type": "array",
"items": {
"$ref": "StatusCondition"
},
"description": "Which conditions caused the current node pool state."
}
},
"description": "NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.",
"id": "NodePool"
},
"PrivateClusterMasterGlobalAccessConfig": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Whenever master is accessible globally or not."
}
},
"description": "Configuration for controlling master global access settings.",
"type": "object",
"id": "PrivateClusterMasterGlobalAccessConfig"
},
"SetLoggingServiceRequest": {
"description": "SetLoggingServiceRequest sets the logging service of a cluster.",
"type": "object",
"properties": {
"projectId": {
"type": "string",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field."
},
"zone": {
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field."
},
"name": {
"description": "The name (project, location, cluster) of the cluster to set logging. Specified in the format `projects/*/locations/*/clusters/*`.",
"type": "string"
},
"loggingService": {
"type": "string",
"description": "Required. The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions."
},
"clusterId": {
"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.",
"type": "string"
}
},
"id": "SetLoggingServiceRequest"
},
"StatusCondition": {
"id": "StatusCondition",
"description": "StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).",
"properties": {
"message": {
"type": "string",
"description": "Human-friendly representation of the condition"
},
"code": {
"enumDescriptions": [
"UNKNOWN indicates a generic condition.",
"GCE_STOCKOUT indicates that Google Compute Engine resources are temporarily unavailable.",
"GKE_SERVICE_ACCOUNT_DELETED indicates that the user deleted their robot service 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 etcd level encryption. More codes TBA"
],
"enum": [
"UNKNOWN",
"GCE_STOCKOUT",
"GKE_SERVICE_ACCOUNT_DELETED",
"GCE_QUOTA_EXCEEDED",
"SET_BY_OPERATOR",
"CLOUD_KMS_KEY_ERROR"
],
"description": "Machine-friendly representation of the condition",
"type": "string"
}
},
"type": "object"
},
"IPAllocationPolicy": {
"type": "object",
"id": "IPAllocationPolicy",
"description": "Configuration for controlling how IPs are allocated in the cluster.",
"properties": {
"servicesIpv4CidrBlock": {
"type": "string",
"description": "The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use."
},
"useIpAliases": {
"description": "Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode",
"type": "boolean"
},
"nodeIpv4CidrBlock": {
"description": "The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.",
"type": "string"
},
"useRoutes": {
"type": "boolean",
"description": "Whether routes will be used for pod IPs in the cluster. This is used in conjunction with use_ip_aliases. It cannot be true if use_ip_aliases is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode"
},
"nodeIpv4Cidr": {
"description": "This field is deprecated, use node_ipv4_cidr_block.",
"type": "string"
},
"tpuIpv4CidrBlock": {
"description": "The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.",
"type": "string"
},
"createSubnetwork": {
"description": "Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true.",
"type": "boolean"
},
"subnetworkName": {
"description": "A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork.",
"type": "string"
},
"servicesIpv4Cidr": {
"description": "This field is deprecated, use services_ipv4_cidr_block.",
"type": "string"
},
"clusterSecondaryRangeName": {
"description": "The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.",
"type": "string"
},
"clusterIpv4CidrBlock": {
"type": "string",
"description": "The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use."
},
"servicesSecondaryRangeName": {
"type": "string",
"description": "The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false."
},
"clusterIpv4Cidr": {
"type": "string",
"description": "This field is deprecated, use cluster_ipv4_cidr_block."
}
}
},
"ClientCertificateConfig": {
"description": "Configuration for client certificates on the cluster.",
"id": "ClientCertificateConfig",
"type": "object",
"properties": {
"issueClientCertificate": {
"description": "Issue a client certificate.",
"type": "boolean"
}
}
},
"NodeTaint": {
"type": "object",
"id": "NodeTaint",
"description": "Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.",
"properties": {
"value": {
"description": "Value for taint.",
"type": "string"
},
"effect": {
"type": "string",
"enumDescriptions": [
"Not set",
"NoSchedule",
"PreferNoSchedule",
"NoExecute"
],
"enum": [
"EFFECT_UNSPECIFIED",
"NO_SCHEDULE",
"PREFER_NO_SCHEDULE",
"NO_EXECUTE"
],
"description": "Effect for taint."
},
"key": {
"description": "Key for taint.",
"type": "string"
}
}
},
"PrivateClusterConfig": {
"description": "Configuration options for private clusters.",
"type": "object",
"id": "PrivateClusterConfig",
"properties": {
"publicEndpoint": {
"description": "Output only. The external IP address of this cluster's master endpoint.",
"type": "string"
},
"privateEndpoint": {
"type": "string",
"description": "Output only. The internal IP address of this cluster's master endpoint."
},
"masterGlobalAccessConfig": {
"description": "Controls master global access settings.",
"$ref": "PrivateClusterMasterGlobalAccessConfig"
},
"enablePrivateNodes": {
"type": "boolean",
"description": "Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking."
},
"masterIpv4CidrBlock": {
"type": "string",
"description": "The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster's network."
},
"peeringName": {
"description": "Output only. The peering name in the customer VPC used by this cluster.",
"type": "string"
},
"enablePrivateEndpoint": {
"description": "Whether the master's internal IP address is used as the cluster endpoint.",
"type": "boolean"
}
}
},
"ClusterAutoscaling": {
"id": "ClusterAutoscaling",
"description": "ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs.",
"type": "object",
"properties": {
"autoprovisioningLocations": {
"items": {
"type": "string"
},
"type": "array",
"description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP."
},
"autoprovisioningNodePoolDefaults": {
"description": "AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.",
"$ref": "AutoprovisioningNodePoolDefaults"
},
"enableNodeAutoprovisioning": {
"description": "Enables automatic node pool creation and deletion.",
"type": "boolean"
},
"resourceLimits": {
"items": {
"$ref": "ResourceLimit"
},
"description": "Contains global constraints regarding minimum and maximum amount of resources in the cluster.",
"type": "array"
}
}
},
"Cluster": {
"description": "A Google Kubernetes Engine cluster.",
"properties": {
"currentNodeVersion": {
"type": "string",
"description": "[Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes."
},
"defaultMaxPodsConstraint": {
"description": "The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.",
"$ref": "MaxPodsConstraint"
},
"clusterIpv4Cidr": {
"type": "string",
"description": "The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`."
},
"expireTime": {
"description": "[Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"type": "string"
},
"nodeIpv4CidrSize": {
"description": "[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.",
"format": "int32",
"type": "integer"
},
"servicesIpv4Cidr": {
"type": "string",
"description": "[Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR."
},
"description": {
"type": "string",
"description": "An optional description of this cluster."
},
"masterAuthorizedNetworksConfig": {
"$ref": "MasterAuthorizedNetworksConfig",
"description": "The configuration options for master authorized networks feature."
},
"selfLink": {
"type": "string",
"description": "[Output only] Server-defined URL for the resource."
},
"monitoringService": {
"description": "The monitoring service the cluster should use to write metrics. Currently available options: * \"monitoring.googleapis.com/kubernetes\" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.",
"type": "string"
},
"zone": {
"type": "string",
"description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead."
},
"verticalPodAutoscaling": {
"description": "Cluster-level Vertical Pod Autoscaling configuration.",
"$ref": "VerticalPodAutoscaling"
},
"binaryAuthorization": {
"$ref": "BinaryAuthorization",
"description": "Configuration for Binary Authorization."
},
"instanceGroupUrls": {
"items": {
"type": "string"
},
"type": "array",
"description": "Deprecated. Use node_pools.instance_group_urls."
},
"currentNodeCount": {
"format": "int32",
"description": "[Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.",
"type": "integer"
},
"addonsConfig": {
"description": "Configurations for the various addons available to run in the cluster.",
"$ref": "AddonsConfig"
},
"legacyAbac": {
"description": "Configuration for the legacy ABAC authorization mode.",
"$ref": "LegacyAbac"
},
"nodePools": {
"description": "The node pools associated with this cluster. This field should not be set if \"node_config\" or \"initial_node_count\" are specified.",
"items": {
"$ref": "NodePool"
},
"type": "array"
},
"maintenancePolicy": {
"$ref": "MaintenancePolicy",
"description": "Configure the maintenance policy for this cluster."
},
"conditions": {
"items": {
"$ref": "StatusCondition"
},
"description": "Which conditions caused the current cluster state.",
"type": "array"
},
"networkPolicy": {
"$ref": "NetworkPolicy",
"description": "Configuration options for the NetworkPolicy feature."
},
"workloadIdentityConfig": {
"$ref": "WorkloadIdentityConfig",
"description": "Configuration for the use of Kubernetes Service Accounts in GCP IAM policies."
},
"resourceLabels": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"description": "The resource labels for the cluster to use to annotate any related Google Compute Engine resources."
},
"resourceUsageExportConfig": {
"$ref": "ResourceUsageExportConfig",
"description": "Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified."
},
"subnetwork": {
"type": "string",
"description": "The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected."
},
"networkConfig": {
"$ref": "NetworkConfig",
"description": "Configuration for cluster networking."
},
"enableKubernetesAlpha": {
"description": "Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.",
"type": "boolean"
},
"authenticatorGroupsConfig": {
"$ref": "AuthenticatorGroupsConfig",
"description": "Configuration controlling RBAC group membership information."
},
"privateClusterConfig": {
"$ref": "PrivateClusterConfig",
"description": "Configuration for private cluster."
},
"ipAllocationPolicy": {
"$ref": "IPAllocationPolicy",
"description": "Configuration for cluster IP allocation."
},
"enableTpu": {
"type": "boolean",
"description": "Enable the ability to use Cloud TPUs in this cluster."
},
"currentMasterVersion": {
"type": "string",
"description": "[Output only] The current software version of the master endpoint."
},
"createTime": {
"description": "[Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"type": "string"
},
"shieldedNodes": {
"description": "Shielded Nodes configuration.",
"$ref": "ShieldedNodes"
},
"databaseEncryption": {
"$ref": "DatabaseEncryption",
"description": "Configuration of etcd encryption."
},
"loggingService": {
"type": "string",
"description": "The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions."
},
"network": {
"type": "string",
"description": "The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used."
},
"labelFingerprint": {
"description": "The fingerprint of the set of labels for this cluster.",
"type": "string"
},
"nodeConfig": {
"$ref": "NodeConfig",
"description": "Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"initial_node_count\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead."
},
"endpoint": {
"description": "[Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.",
"type": "string"
},
"releaseChannel": {
"$ref": "ReleaseChannel",
"description": "Release channel configuration."
},
"initialClusterVersion": {
"type": "string",
"description": "The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - \"latest\": picks the highest valid Kubernetes version - \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version - \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version - \"1.X.Y-gke.N\": picks an explicit Kubernetes version - \"\",\"-\": picks the default Kubernetes version"
},
"location": {
"type": "string",
"description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides."
},
"masterAuth": {
"description": "The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to \"admin\", a random password will be generated, and a client certificate will be issued.",
"$ref": "MasterAuth"
},
"tpuIpv4CidrBlock": {
"type": "string",
"description": "[Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`)."
},
"status": {
"type": "string",
"enum": [
"STATUS_UNSPECIFIED",
"PROVISIONING",
"RUNNING",
"RECONCILING",
"STOPPING",
"ERROR",
"DEGRADED"
],
"description": "[Output only] The current status of this cluster.",
"enumDescriptions": [
"Not set.",
"The PROVISIONING state indicates the cluster is being created.",
"The RUNNING state indicates the cluster has been created and is fully usable.",
"The RECONCILING state indicates that some work is actively being done on the cluster, such as upgrading the master or node software. Details can be found in the `statusMessage` field.",
"The STOPPING state indicates the cluster is being deleted.",
"The ERROR state indicates the cluster is unusable. It will be automatically deleted. Details can be found in the `statusMessage` field.",
"The DEGRADED state indicates the cluster requires user action to restore full functionality. Details can be found in the `statusMessage` field."
]
},
"locations": {
"description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.",
"items": {
"type": "string"
},
"type": "array"
},
"autoscaling": {
"$ref": "ClusterAutoscaling",
"description": "Cluster-level autoscaling configuration."
},
"name": {
"type": "string",
"description": "The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter."
},
"initialNodeCount": {
"type": "integer",
"description": "The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"node_config\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.",
"format": "int32"
},
"statusMessage": {
"type": "string",
"description": "[Output only] Additional information about the current status of this cluster, if available."
}
},
"type": "object",
"id": "Cluster"
},
"ClusterUpdate": {
"description": "ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided.",
"type": "object",
"properties": {
"desiredWorkloadIdentityConfig": {
"description": "Configuration for Workload Identity.",
"$ref": "WorkloadIdentityConfig"
},
"desiredBinaryAuthorization": {
"description": "The desired configuration options for the Binary Authorization feature.",
"$ref": "BinaryAuthorization"
},
"desiredVerticalPodAutoscaling": {
"$ref": "VerticalPodAutoscaling",
"description": "Cluster-level Vertical Pod Autoscaling configuration."
},
"desiredIntraNodeVisibilityConfig": {
"description": "The desired config of Intra-node visibility.",
"$ref": "IntraNodeVisibilityConfig"
},
"desiredReleaseChannel": {
"$ref": "ReleaseChannel",
"description": "The desired release channel configuration."
},
"desiredLocations": {
"description": "The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.",
"type": "array",
"items": {
"type": "string"
}
},
"desiredImageType": {
"description": "The desired image type for the node pool. NOTE: Set the \"desired_node_pool\" field as well.",
"type": "string"
},
"desiredMonitoringService": {
"description": "The monitoring service the cluster should use to write metrics. Currently available options: * \"monitoring.googleapis.com/kubernetes\" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.",
"type": "string"
},
"desiredMasterVersion": {
"description": "The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - \"latest\": picks the highest valid Kubernetes version - \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version - \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version - \"1.X.Y-gke.N\": picks an explicit Kubernetes version - \"-\": picks the default Kubernetes version",
"type": "string"
},
"desiredShieldedNodes": {
"description": "Configuration for Shielded Nodes.",
"$ref": "ShieldedNodes"
},
"desiredNodePoolId": {
"description": "The node pool to be upgraded. This field is mandatory if \"desired_node_version\", \"desired_image_family\" or \"desired_node_pool_autoscaling\" is specified and there is more than one node pool on the cluster.",
"type": "string"
},
"desiredClusterAutoscaling": {
"$ref": "ClusterAutoscaling",
"description": "Cluster-level autoscaling configuration."
},
"desiredAddonsConfig": {
"$ref": "AddonsConfig",
"description": "Configurations for the various addons available to run in the cluster."
},
"desiredNodePoolAutoscaling": {
"description": "Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool.",
"$ref": "NodePoolAutoscaling"
},
"desiredDefaultSnatStatus": {
"$ref": "DefaultSnatStatus",
"description": "The desired status of whether to disable default sNAT for this cluster."
},
"desiredMasterAuthorizedNetworksConfig": {
"$ref": "MasterAuthorizedNetworksConfig",
"description": "The desired configuration options for master authorized networks feature."
},
"desiredNodeVersion": {
"description": "The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - \"latest\": picks the highest valid Kubernetes version - \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version - \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version - \"1.X.Y-gke.N\": picks an explicit Kubernetes version - \"-\": picks the Kubernetes master version",
"type": "string"
},
"desiredDatabaseEncryption": {
"$ref": "DatabaseEncryption",
"description": "Configuration of etcd encryption."
},
"desiredResourceUsageExportConfig": {
"description": "The desired configuration for exporting resource usage.",
"$ref": "ResourceUsageExportConfig"
},
"desiredPrivateClusterConfig": {
"description": "The desired private cluster configuration.",
"$ref": "PrivateClusterConfig"
},
"desiredLoggingService": {
"description": "The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.",
"type": "string"
}
},
"id": "ClusterUpdate"
},
"SandboxConfig": {
"type": "object",
"id": "SandboxConfig",
"properties": {
"type": {
"enum": [
"UNSPECIFIED",
"GVISOR"
],
"enumDescriptions": [
"Default value. This should not be used.",
"Run sandbox using gvisor."
],
"type": "string",
"description": "Type of the sandbox to use for the node."
}
},
"description": "SandboxConfig contains configurations of the sandbox to use for the node."
},
"HorizontalPodAutoscaling": {
"properties": {
"disabled": {
"description": "Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring.",
"type": "boolean"
}
},
"id": "HorizontalPodAutoscaling",
"description": "Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.",
"type": "object"
},
"IntraNodeVisibilityConfig": {
"description": "IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster.",
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Enables intra node visibility for this cluster."
}
},
"id": "IntraNodeVisibilityConfig"
},
"ListUsableSubnetworksResponse": {
"description": "ListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest.",
"properties": {
"subnetworks": {
"items": {
"$ref": "UsableSubnetwork"
},
"description": "A list of usable subnetworks in the specified network project.",
"type": "array"
},
"nextPageToken": {
"type": "string",
"description": "This token allows you to get the next page of results for list requests. If the number of results is larger than `page_size`, use the `next_page_token` as a value for the query parameter `page_token` in the next request. The value will become empty when there are no more pages."
}
},
"type": "object",
"id": "ListUsableSubnetworksResponse"
},
"LegacyAbac": {
"properties": {
"enabled": {
"description": "Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.",
"type": "boolean"
}
},
"description": "Configuration for the legacy Attribute Based Access Control authorization mode.",
"id": "LegacyAbac",
"type": "object"
},
"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.",
"type": "string",
"format": "int64"
},
"resourceType": {
"description": "Resource name \"cpu\", \"memory\" or gpu-specific string.",
"type": "string"
}
},
"description": "Contains information about amount of some resource in the cluster. For memory, value should be in GB.",
"type": "object",
"id": "ResourceLimit"
},
"SetLabelsRequest": {
"id": "SetLabelsRequest",
"properties": {
"projectId": {
"type": "string",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field."
},
"name": {
"description": "The name (project, location, cluster id) of the cluster to set labels. Specified in the format `projects/*/locations/*/clusters/*`.",
"type": "string"
},
"resourceLabels": {
"description": "Required. The labels to set for that cluster.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"clusterId": {
"type": "string",
"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field."
},
"labelFingerprint": {
"description": "Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a `get()` request to the resource to get the latest fingerprint.",
"type": "string"
},
"zone": {
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field."
}
},
"description": "SetLabelsRequest sets the Google Cloud Platform labels on a Google Container Engine cluster, which will in turn set them for Google Compute Engine resources used by that cluster",
"type": "object"
},
"ReleaseChannelConfig": {
"description": "ReleaseChannelConfig exposes configuration for a release channel.",
"id": "ReleaseChannelConfig",
"type": "object",
"properties": {
"validVersions": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of valid versions for the channel."
},
"channel": {
"type": "string",
"enum": [
"UNSPECIFIED",
"RAPID",
"REGULAR",
"STABLE"
],
"enumDescriptions": [
"No channel specified.",
"RAPID channel is offered on an early access basis for customers who want to test new releases. WARNING: Versions available in the RAPID Channel may be subject to unresolved issues with no known workaround and are not subject to any SLAs.",
"Clusters subscribed to REGULAR receive versions that are considered GA quality. REGULAR is intended for production users who want to take advantage of new features.",
"Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production."
],
"description": "The release channel this configuration applies to."
},
"defaultVersion": {
"description": "The default version for newly created clusters on the channel.",
"type": "string"
}
}
},
"Operation": {
"properties": {
"detail": {
"description": "Detailed operation progress, if available.",
"type": "string"
},
"status": {
"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",
"enum": [
"STATUS_UNSPECIFIED",
"PENDING",
"RUNNING",
"DONE",
"ABORTING"
],
"description": "The current status of the operation."
},
"startTime": {
"description": "[Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"type": "string"
},
"endTime": {
"description": "[Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"type": "string"
},
"clusterConditions": {
"description": "Which conditions caused the current cluster state.",
"type": "array",
"items": {
"$ref": "StatusCondition"
}
},
"zone": {
"type": "string",
"description": "The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead."
},
"location": {
"type": "string",
"description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides."
},
"name": {
"description": "The server-assigned ID for the operation.",
"type": "string"
},
"progress": {
"description": "Output only. [Output only] Progress information for an operation.",
"$ref": "OperationProgress",
"readOnly": true
},
"statusMessage": {
"type": "string",
"description": "Output only. If an error has occurred, a textual description of the error.",
"readOnly": true
},
"selfLink": {
"description": "Server-defined URL for the resource.",
"type": "string"
},
"nodepoolConditions": {
"items": {
"$ref": "StatusCondition"
},
"type": "array",
"description": "Which conditions caused the current node pool state."
},
"operationType": {
"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."
],
"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"
],
"type": "string",
"description": "The operation type."
},
"targetLink": {
"type": "string",
"description": "Server-defined URL for the target of the operation."
}
},
"id": "Operation",
"description": "This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.",
"type": "object"
},
"CreateClusterRequest": {
"properties": {
"cluster": {
"description": "Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1/projects.locations.clusters)",
"$ref": "Cluster"
},
"projectId": {
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field.",
"type": "string"
},
"parent": {
"description": "The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`.",
"type": "string"
},
"zone": {
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
"type": "string"
}
},
"description": "CreateClusterRequest creates a cluster.",
"type": "object",
"id": "CreateClusterRequest"
},
"CidrBlock": {
"type": "object",
"id": "CidrBlock",
"description": "CidrBlock contains an optional name and one CIDR block.",
"properties": {
"displayName": {
"description": "display_name is an optional field for users to identify CIDR blocks.",
"type": "string"
},
"cidrBlock": {
"description": "cidr_block must be specified in CIDR notation.",
"type": "string"
}
}
},
"AcceleratorConfig": {
"properties": {
"acceleratorCount": {
"format": "int64",
"description": "The number of the accelerator cards exposed to an instance.",
"type": "string"
},
"acceleratorType": {
"description": "The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)",
"type": "string"
}
},
"id": "AcceleratorConfig",
"type": "object",
"description": "AcceleratorConfig represents a Hardware Accelerator request."
},
"ServerConfig": {
"type": "object",
"properties": {
"defaultClusterVersion": {
"type": "string",
"description": "Version of Kubernetes the service deploys by default."
},
"channels": {
"description": "List of release channel configurations.",
"items": {
"$ref": "ReleaseChannelConfig"
},
"type": "array"
},
"defaultImageType": {
"type": "string",
"description": "Default image type."
},
"validMasterVersions": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of valid master versions, in descending order."
},
"validNodeVersions": {
"description": "List of valid node upgrade target versions, in descending order.",
"items": {
"type": "string"
},
"type": "array"
},
"validImageTypes": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of valid image types."
}
},
"id": "ServerConfig",
"description": "Kubernetes Engine service configuration."
},
"GetJSONWebKeysResponse": {
"id": "GetJSONWebKeysResponse",
"properties": {
"keys": {
"description": "The public component of the keys used by the cluster to sign token requests.",
"items": {
"$ref": "Jwk"
},
"type": "array"
},
"cacheHeader": {
"$ref": "HttpCacheControlResponseHeader",
"description": "OnePlatform automatically extracts this field and uses it to set the HTTP Cache-Control header."
}
},
"description": "GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517",
"type": "object"
},
"WorkloadMetadataConfig": {
"type": "object",
"description": "WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool.",
"id": "WorkloadMetadataConfig",
"properties": {
"mode": {
"enumDescriptions": [
"Not set.",
"Expose all Compute Engine metadata to pods.",
"Run the GKE Metadata Server on this node. The GKE Metadata Server exposes a metadata API to workloads that is compatible with the V1 Compute Metadata APIs exposed by the Compute Engine and App Engine Metadata Servers. This feature can only be enabled if Workload Identity is enabled at the cluster level."
],
"type": "string",
"enum": [
"MODE_UNSPECIFIED",
"GCE_METADATA",
"GKE_METADATA"
],
"description": "Mode is the configuration for how to expose metadata to workloads running on the node pool."
}
}
},
"SetMasterAuthRequest": {
"id": "SetMasterAuthRequest",
"description": "SetMasterAuthRequest updates the admin password of a cluster.",
"type": "object",
"properties": {
"action": {
"type": "string",
"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 is disabled for the cluster. If a non-empty username is provided, basic authentication is enabled, with either a provided password or a generated one."
],
"enum": [
"UNKNOWN",
"SET_PASSWORD",
"GENERATE_PASSWORD",
"SET_USERNAME"
],
"description": "Required. The exact form of action to be taken on the master auth."
},
"update": {
"description": "Required. A description of the update.",
"$ref": "MasterAuth"
},
"zone": {
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
"type": "string"
},
"clusterId": {
"description": "Deprecated. The name of the cluster to upgrade. This 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. Specified in the format `projects/*/locations/*/clusters/*`.",
"type": "string"
},
"projectId": {
"type": "string",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field."
}
}
},
"HttpCacheControlResponseHeader": {
"id": "HttpCacheControlResponseHeader",
"description": "RFC-2616: cache control support",
"properties": {
"directive": {
"description": "14.9 request and response directives",
"type": "string"
},
"expires": {
"description": "14.21 response cache expires, in RFC 1123 date format",
"type": "string"
},
"age": {
"type": "string",
"description": "14.6 response cache age, in seconds since the response is generated",
"format": "int64"
}
},
"type": "object"
},
"SetNodePoolManagementRequest": {
"properties": {
"clusterId": {
"type": "string",
"description": "Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field."
},
"name": {
"type": "string",
"description": "The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`."
},
"projectId": {
"type": "string",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field."
},
"nodePoolId": {
"type": "string",
"description": "Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field."
},
"management": {
"$ref": "NodeManagement",
"description": "Required. NodeManagement configuration for the node pool."
},
"zone": {
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field."
}
},
"type": "object",
"description": "SetNodePoolManagementRequest sets the node management properties of a node pool.",
"id": "SetNodePoolManagementRequest"
},
"UpgradeEvent": {
"properties": {
"resource": {
"description": "Optional. Optional relative path to the resource. For example in node pool upgrades, the relative path of the node pool.",
"type": "string"
},
"resourceType": {
"enumDescriptions": [
"Default value. This shouldn't be used.",
"Master / control plane",
"Node pool"
],
"description": "Required. The resource type that is upgrading.",
"type": "string",
"enum": [
"UPGRADE_RESOURCE_TYPE_UNSPECIFIED",
"MASTER",
"NODE_POOL"
]
},
"operationStartTime": {
"description": "Required. The time when the operation was started.",
"format": "google-datetime",
"type": "string"
},
"currentVersion": {
"description": "Required. The current version before the upgrade.",
"type": "string"
},
"targetVersion": {
"type": "string",
"description": "Required. The target version for the upgrade."
},
"operation": {
"description": "Required. The operation associated with this upgrade.",
"type": "string"
}
},
"id": "UpgradeEvent",
"type": "object",
"description": "UpgradeEvent is a notification sent to customers by the cluster server when a resource is upgrading."
},
"ConfigConnectorConfig": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether Cloud Connector is enabled for this cluster."
}
},
"description": "Configuration options for the Config Connector add-on.",
"type": "object",
"id": "ConfigConnectorConfig"
},
"Metric": {
"properties": {
"stringValue": {
"description": "For metrics with custom values (ratios, visual progress, etc.).",
"type": "string"
},
"name": {
"description": "Required. Metric name, e.g., \"nodes total\", \"percent done\".",
"type": "string"
},
"intValue": {
"type": "string",
"description": "For metrics with integer value.",
"format": "int64"
},
"doubleValue": {
"format": "double",
"description": "For metrics with floating point value.",
"type": "number"
}
},
"id": "Metric",
"type": "object",
"description": "Progress metric is (string, int|float|string) pair."
},
"SetMaintenancePolicyRequest": {
"description": "SetMaintenancePolicyRequest sets the maintenance policy for a cluster.",
"properties": {
"projectId": {
"description": "Required. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840).",
"type": "string"
},
"maintenancePolicy": {
"description": "Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.",
"$ref": "MaintenancePolicy"
},
"name": {
"description": "The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format `projects/*/locations/*/clusters/*`.",
"type": "string"
},
"zone": {
"type": "string",
"description": "Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides."
},
"clusterId": {
"description": "Required. The name of the cluster to update.",
"type": "string"
}
},
"id": "SetMaintenancePolicyRequest",
"type": "object"
},
"SetAddonsConfigRequest": {
"properties": {
"zone": {
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field."
},
"name": {
"type": "string",
"description": "The name (project, location, cluster) of the cluster to set addons. Specified in the format `projects/*/locations/*/clusters/*`."
},
"addonsConfig": {
"$ref": "AddonsConfig",
"description": "Required. The desired configurations for the various addons available to run in the cluster."
},
"projectId": {
"type": "string",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field."
},
"clusterId": {
"type": "string",
"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field."
}
},
"type": "object",
"id": "SetAddonsConfigRequest",
"description": "SetAddonsConfigRequest sets the addons associated with the cluster."
},
"BinaryAuthorization": {
"description": "Configuration for Binary Authorization.",
"properties": {
"enabled": {
"description": "Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Binary Authorization.",
"type": "boolean"
}
},
"type": "object",
"id": "BinaryAuthorization"
},
"NodeConfig": {
"type": "object",
"description": "Parameters that describe the nodes in a cluster.",
"properties": {
"diskType": {
"description": "Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard'",
"type": "string"
},
"accelerators": {
"items": {
"$ref": "AcceleratorConfig"
},
"type": "array",
"description": "A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs."
},
"shieldedInstanceConfig": {
"$ref": "ShieldedInstanceConfig",
"description": "Shielded Instance options."
},
"preemptible": {
"description": "Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.",
"type": "boolean"
},
"sandboxConfig": {
"description": "Sandbox configuration for this node.",
"$ref": "SandboxConfig"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"description": "The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - \"cluster-location\" - \"cluster-name\" - \"cluster-uid\" - \"configure-sh\" - \"containerd-configure-sh\" - \"enable-os-login\" - \"gci-ensure-gke-docker\" - \"gci-metrics-enabled\" - \"gci-update-strategy\" - \"instance-template\" - \"kube-env\" - \"startup-script\" - \"user-data\" - \"disable-address-manager\" - \"windows-startup-script-ps1\" - \"common-psm1\" - \"k8s-node-setup-psm1\" - \"install-ssh-psm1\" - \"user-profile-psm1\" The following keys are reserved for Windows nodes: - \"serial-port-logging-enable\" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB."
},
"minCpuPlatform": {
"type": "string",
"description": "Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: \"Intel Haswell\"` or `minCpuPlatform: \"Intel Sandy Bridge\"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)"
},
"machineType": {
"description": "The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.",
"type": "string"
},
"imageType": {
"type": "string",
"description": "The image type to use for this node. Note that for a given image type, the latest version of it will be used."
},
"oauthScopes": {
"type": "array",
"description": "The set of Google API scopes to be made available on all of the node VMs under the \"default\" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.",
"items": {
"type": "string"
}
},
"bootDiskKmsKey": {
"type": "string",
"description": " The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption"
},
"taints": {
"description": "List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/",
"items": {
"$ref": "NodeTaint"
},
"type": "array"
},
"localSsdCount": {
"format": "int32",
"type": "integer",
"description": "The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information."
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"description": "The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035."
},
"reservationAffinity": {
"description": "The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.",
"$ref": "ReservationAffinity"
},
"nodeGroup": {
"type": "string",
"description": "Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes)."
},
"workloadMetadataConfig": {
"$ref": "WorkloadMetadataConfig",
"description": "The workload metadata configuration for this node."
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"description": "The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/"
},
"diskSizeGb": {
"description": "Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.",
"type": "integer",
"format": "int32"
},
"serviceAccount": {
"description": "The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the \"default\" service account is used.",
"type": "string"
}
},
"id": "NodeConfig"
},
"MaintenanceWindow": {
"properties": {
"maintenanceExclusions": {
"description": "Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.",
"type": "object",
"additionalProperties": {
"$ref": "TimeWindow"
}
},
"recurringWindow": {
"$ref": "RecurringTimeWindow",
"description": "RecurringWindow specifies some number of recurring time periods for maintenance to occur. The time windows may be overlapping. If no maintenance windows are set, maintenance can occur at any time."
},
"dailyMaintenanceWindow": {
"$ref": "DailyMaintenanceWindow",
"description": "DailyMaintenanceWindow specifies a daily maintenance operation window."
}
},
"id": "MaintenanceWindow",
"description": "MaintenanceWindow defines the maintenance window to be used for the cluster.",
"type": "object"
},
"DatabaseEncryption": {
"properties": {
"state": {
"enumDescriptions": [
"Should never be set",
"Secrets in etcd are encrypted.",
"Secrets in etcd are stored in plain text (at etcd level) - this is unrelated to Compute Engine level full disk encryption."
],
"enum": [
"UNKNOWN",
"ENCRYPTED",
"DECRYPTED"
],
"description": "Denotes the state of etcd encryption.",
"type": "string"
},
"keyName": {
"type": "string",
"description": "Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key"
}
},
"type": "object",
"description": "Configuration of etcd encryption.",
"id": "DatabaseEncryption"
},
"ResourceUsageExportConfig": {
"description": "Configuration for exporting cluster resource usages.",
"id": "ResourceUsageExportConfig",
"properties": {
"enableNetworkEgressMetering": {
"description": "Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic.",
"type": "boolean"
},
"consumptionMeteringConfig": {
"description": "Configuration to enable resource consumption metering.",
"$ref": "ConsumptionMeteringConfig"
},
"bigqueryDestination": {
"$ref": "BigQueryDestination",
"description": "Configuration to use BigQuery as usage export destination."
}
},
"type": "object"
},
"ShieldedInstanceConfig": {
"id": "ShieldedInstanceConfig",
"properties": {
"enableSecureBoot": {
"type": "boolean",
"description": "Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails."
},
"enableIntegrityMonitoring": {
"description": "Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.",
"type": "boolean"
}
},
"type": "object",
"description": "A set of Shielded Instance options."
},
"CloudRunConfig": {
"id": "CloudRunConfig",
"type": "object",
"properties": {
"disabled": {
"type": "boolean",
"description": "Whether Cloud Run addon is enabled for this cluster."
},
"loadBalancerType": {
"enumDescriptions": [
"Load balancer type for Cloud Run is unspecified.",
"Install external load balancer for Cloud Run.",
"Install internal load balancer for Cloud Run."
],
"description": "Which load balancer type is installed for Cloud Run.",
"type": "string",
"enum": [
"LOAD_BALANCER_TYPE_UNSPECIFIED",
"LOAD_BALANCER_TYPE_EXTERNAL",
"LOAD_BALANCER_TYPE_INTERNAL"
]
}
},
"description": "Configuration options for the Cloud Run feature."
},
"CompleteIPRotationRequest": {
"type": "object",
"properties": {
"zone": {
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field."
},
"clusterId": {
"type": "string",
"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field."
},
"projectId": {
"type": "string",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field."
},
"name": {
"description": "The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.",
"type": "string"
}
},
"id": "CompleteIPRotationRequest",
"description": "CompleteIPRotationRequest moves the cluster master back into single-IP mode."
},
"MaxPodsConstraint": {
"id": "MaxPodsConstraint",
"properties": {
"maxPodsPerNode": {
"description": "Constraint enforced on the max num of pods per node.",
"type": "string",
"format": "int64"
}
},
"type": "object",
"description": "Constraints applied to pods."
},
"DailyMaintenanceWindow": {
"type": "object",
"description": "Time window specified for daily maintenance operations.",
"id": "DailyMaintenanceWindow",
"properties": {
"duration": {
"description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format \"PTnHnMnS\".",
"type": "string"
},
"startTime": {
"type": "string",
"description": "Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format \"HH:MM\", where HH : [00-23] and MM : [00-59] GMT."
}
}
},
"SetMonitoringServiceRequest": {
"id": "SetMonitoringServiceRequest",
"description": "SetMonitoringServiceRequest sets the monitoring service of a cluster.",
"properties": {
"monitoringService": {
"description": "Required. The monitoring service the cluster should use to write metrics. Currently available options: * \"monitoring.googleapis.com/kubernetes\" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.",
"type": "string"
},
"name": {
"type": "string",
"description": "The name (project, location, cluster) of the cluster to set monitoring. Specified in the format `projects/*/locations/*/clusters/*`."
},
"clusterId": {
"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.",
"type": "string"
},
"projectId": {
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.",
"type": "string"
},
"zone": {
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
"type": "string"
}
},
"type": "object"
},
"ListOperationsResponse": {
"type": "object",
"description": "ListOperationsResponse is the result of ListOperationsRequest.",
"id": "ListOperationsResponse",
"properties": {
"operations": {
"type": "array",
"description": "A list of operations in the project in the specified zone.",
"items": {
"$ref": "Operation"
}
},
"missingZones": {
"description": "If any zones are listed here, the list of operations returned may be missing the operations from those zones.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"CancelOperationRequest": {
"description": "CancelOperationRequest cancels a single operation.",
"type": "object",
"properties": {
"zone": {
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.",
"type": "string"
},
"name": {
"type": "string",
"description": "The name (project, location, operation id) of the operation to cancel. Specified in the format `projects/*/locations/*/operations/*`."
},
"projectId": {
"type": "string",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field."
},
"operationId": {
"type": "string",
"description": "Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field."
}
},
"id": "CancelOperationRequest"
},
"NetworkPolicyConfig": {
"description": "Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.",
"properties": {
"disabled": {
"description": "Whether NetworkPolicy is enabled for this cluster.",
"type": "boolean"
}
},
"id": "NetworkPolicyConfig",
"type": "object"
},
"ShieldedNodes": {
"type": "object",
"description": "Configuration of Shielded Nodes feature.",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether Shielded Nodes features are enabled on all nodes in this cluster."
}
},
"id": "ShieldedNodes"
},
"ListClustersResponse": {
"type": "object",
"id": "ListClustersResponse",
"properties": {
"clusters": {
"type": "array",
"description": "A list of clusters in the project in the specified zone, or across all ones.",
"items": {
"$ref": "Cluster"
}
},
"missingZones": {
"type": "array",
"description": "If any zones are listed here, the list of clusters returned may be missing those zones.",
"items": {
"type": "string"
}
}
},
"description": "ListClustersResponse is the result of ListClustersRequest."
},
"AutoUpgradeOptions": {
"properties": {
"description": {
"description": "[Output only] This field is set when upgrades are about to commence with the description of the upgrade.",
"type": "string"
},
"autoUpgradeStartTime": {
"type": "string",
"description": "[Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format."
}
},
"id": "AutoUpgradeOptions",
"type": "object",
"description": "AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed."
},
"ReservationAffinity": {
"type": "object",
"id": "ReservationAffinity",
"properties": {
"values": {
"description": "Corresponds to the label value(s) of reservation resource(s).",
"items": {
"type": "string"
},
"type": "array"
},
"key": {
"type": "string",
"description": "Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify \"googleapis.com/reservation-name\" as the key and specify the name of your reservation as its value."
},
"consumeReservationType": {
"type": "string",
"enumDescriptions": [
"Default value. This should not be used.",
"Do not consume from any reserved capacity.",
"Consume any reservation available.",
"Must consume from a specific reservation. Must specify key value fields for specifying the reservations."
],
"description": "Corresponds to the type of reservation consumption.",
"enum": [
"UNSPECIFIED",
"NO_RESERVATION",
"ANY_RESERVATION",
"SPECIFIC_RESERVATION"
]
}
},
"description": "[ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from."
},
"AutoprovisioningNodePoolDefaults": {
"type": "object",
"description": "AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.",
"id": "AutoprovisioningNodePoolDefaults",
"properties": {
"management": {
"$ref": "NodeManagement",
"description": "Specifies the node management options for NAP created node-pools."
},
"upgradeSettings": {
"description": "Specifies the upgrade settings for NAP created node pools",
"$ref": "UpgradeSettings"
},
"minCpuPlatform": {
"type": "string",
"description": "Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) To unset the min cpu platform field pass \"automatic\" as field value."
},
"serviceAccount": {
"description": "The Google Cloud Platform Service Account to be used by the node VMs.",
"type": "string"
},
"shieldedInstanceConfig": {
"$ref": "ShieldedInstanceConfig",
"description": "Shielded Instance options."
},
"bootDiskKmsKey": {
"type": "string",
"description": "The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption"
},
"diskType": {
"type": "string",
"description": "Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard'"
},
"diskSizeGb": {
"format": "int32",
"description": "Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.",
"type": "integer"
},
"oauthScopes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Scopes that are used by NAP when creating node pools."
}
}
},
"HttpLoadBalancing": {
"id": "HttpLoadBalancing",
"description": "Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.",
"properties": {
"disabled": {
"description": "Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.",
"type": "boolean"
}
},
"type": "object"
},
"ReleaseChannel": {
"description": "ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled.",
"type": "object",
"properties": {
"channel": {
"description": "channel specifies which release channel the cluster is subscribed to.",
"enumDescriptions": [
"No channel specified.",
"RAPID channel is offered on an early access basis for customers who want to test new releases. WARNING: Versions available in the RAPID Channel may be subject to unresolved issues with no known workaround and are not subject to any SLAs.",
"Clusters subscribed to REGULAR receive versions that are considered GA quality. REGULAR is intended for production users who want to take advantage of new features.",
"Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production."
],
"enum": [
"UNSPECIFIED",
"RAPID",
"REGULAR",
"STABLE"
],
"type": "string"
}
},
"id": "ReleaseChannel"
},
"SetNodePoolAutoscalingRequest": {
"id": "SetNodePoolAutoscalingRequest",
"type": "object",
"description": "SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.",
"properties": {
"autoscaling": {
"$ref": "NodePoolAutoscaling",
"description": "Required. Autoscaling configuration for the node pool."
},
"clusterId": {
"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.",
"type": "string"
},
"name": {
"type": "string",
"description": "The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`."
},
"projectId": {
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.",
"type": "string"
},
"zone": {
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
"type": "string"
},
"nodePoolId": {
"type": "string",
"description": "Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field."
}
}
},
"NodePoolAutoscaling": {
"properties": {
"autoprovisioned": {
"description": "Can this node pool be deleted automatically.",
"type": "boolean"
},
"minNodeCount": {
"type": "integer",
"format": "int32",
"description": "Minimum number of nodes in the NodePool. Must be \u003e= 1 and \u003c= max_node_count."
},
"enabled": {
"description": "Is autoscaling enabled for this node pool.",
"type": "boolean"
},
"maxNodeCount": {
"type": "integer",
"format": "int32",
"description": "Maximum number of nodes in the NodePool. Must be \u003e= min_node_count. There has to enough quota to scale up the cluster."
}
},
"description": "NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage.",
"type": "object",
"id": "NodePoolAutoscaling"
},
"UsableSubnetwork": {
"description": "UsableSubnetwork resource returns the subnetwork name, its associated network and the primary CIDR range.",
"id": "UsableSubnetwork",
"properties": {
"statusMessage": {
"description": "A human readable status message representing the reasons for cases where the caller cannot use the secondary ranges under the subnet. For example if the secondary_ip_ranges is empty due to a permission issue, an insufficient permission message will be given by status_message.",
"type": "string"
},
"ipCidrRange": {
"type": "string",
"description": "The range of internal addresses that are owned by this subnetwork."
},
"secondaryIpRanges": {
"description": "Secondary IP ranges.",
"items": {
"$ref": "UsableSubnetworkSecondaryRange"
},
"type": "array"
},
"network": {
"description": "Network Name. Example: projects/my-project/global/networks/my-network",
"type": "string"
},
"subnetwork": {
"type": "string",
"description": "Subnetwork Name. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet"
}
},
"type": "object"
},
"BigQueryDestination": {
"id": "BigQueryDestination",
"properties": {
"datasetId": {
"type": "string",
"description": "The ID of a BigQuery Dataset."
}
},
"description": "Parameters for using BigQuery as the destination of resource usage export.",
"type": "object"
},
"CreateNodePoolRequest": {
"type": "object",
"description": "CreateNodePoolRequest creates a node pool for a cluster.",
"properties": {
"parent": {
"description": "The parent (project, location, cluster id) where the node pool will be created. Specified in the format `projects/*/locations/*/clusters/*`.",
"type": "string"
},
"clusterId": {
"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.",
"type": "string"
},
"zone": {
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
"type": "string"
},
"nodePool": {
"$ref": "NodePool",
"description": "Required. The node pool to create."
},
"projectId": {
"type": "string",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field."
}
},
"id": "CreateNodePoolRequest"
},
"UpdateClusterRequest": {
"type": "object",
"id": "UpdateClusterRequest",
"properties": {
"projectId": {
"type": "string",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field."
},
"name": {
"type": "string",
"description": "The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`."
},
"zone": {
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
"type": "string"
},
"clusterId": {
"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.",
"type": "string"
},
"update": {
"description": "Required. A description of the update.",
"$ref": "ClusterUpdate"
}
},
"description": "UpdateClusterRequest updates the settings of a cluster."
},
"SetNetworkPolicyRequest": {
"id": "SetNetworkPolicyRequest",
"type": "object",
"description": "SetNetworkPolicyRequest enables/disables network policy for a cluster.",
"properties": {
"clusterId": {
"type": "string",
"description": "Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field."
},
"zone": {
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field."
},
"networkPolicy": {
"description": "Required. Configuration options for the NetworkPolicy feature.",
"$ref": "NetworkPolicy"
},
"name": {
"description": "The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format `projects/*/locations/*/clusters/*`.",
"type": "string"
},
"projectId": {
"type": "string",
"description": "Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field."
}
}
},
"TimeWindow": {
"description": "Represents an arbitrary window of time.",
"properties": {
"endTime": {
"format": "google-datetime",
"type": "string",
"description": "The time that the window ends. The end time should take place after the start time."
},
"startTime": {
"format": "google-datetime",
"description": "The time that the window first starts.",
"type": "string"
}
},
"type": "object",
"id": "TimeWindow"
},
"GetOpenIDConfigResponse": {
"description": "GetOpenIDConfigResponse is an OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.",
"id": "GetOpenIDConfigResponse",
"properties": {
"subject_types_supported": {
"items": {
"type": "string"
},
"description": "Supported subject types.",
"type": "array"
},
"issuer": {
"description": "OIDC Issuer.",
"type": "string"
},
"jwks_uri": {
"description": "JSON Web Key uri.",
"type": "string"
},
"id_token_signing_alg_values_supported": {
"description": "supported ID Token signing Algorithms.",
"type": "array",
"items": {
"type": "string"
}
},
"cacheHeader": {
"description": "OnePlatform automatically extracts this field and uses it to set the HTTP Cache-Control header.",
"$ref": "HttpCacheControlResponseHeader"
},
"claims_supported": {
"type": "array",
"items": {
"type": "string"
},
"description": "Supported claims."
},
"response_types_supported": {
"items": {
"type": "string"
},
"type": "array",
"description": "Supported response types."
},
"grant_types": {
"items": {
"type": "string"
},
"type": "array",
"description": "Supported grant types."
}
},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
"id": "Empty",
"properties": {}
},
"Jwk": {
"description": "Jwk is a JSON Web Key as specified in RFC 7517",
"type": "object",
"id": "Jwk",
"properties": {
"n": {
"description": "Used for RSA keys.",
"type": "string"
},
"use": {
"description": "Permitted uses for the public keys.",
"type": "string"
},
"kty": {
"description": "Key Type.",
"type": "string"
},
"x": {
"type": "string",
"description": "Used for ECDSA keys."
},
"e": {
"description": "Used for RSA keys.",
"type": "string"
},
"y": {
"type": "string",
"description": "Used for ECDSA keys."
},
"kid": {
"description": "Key ID.",
"type": "string"
},
"crv": {
"type": "string",
"description": "Used for ECDSA keys."
},
"alg": {
"description": "Algorithm.",
"type": "string"
}
}
},
"SetLocationsRequest": {
"type": "object",
"description": "SetLocationsRequest sets the locations of the cluster.",
"id": "SetLocationsRequest",
"properties": {
"zone": {
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
"type": "string"
},
"clusterId": {
"type": "string",
"description": "Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field."
},
"name": {
"type": "string",
"description": "The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`."
},
"projectId": {
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.",
"type": "string"
},
"locations": {
"description": "Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.",
"items": {
"type": "string"
},
"type": "array"
}
}
},
"RecurringTimeWindow": {
"properties": {
"window": {
"description": "The window of the first recurrence.",
"$ref": "TimeWindow"
},
"recurrence": {
"description": "An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.",
"type": "string"
}
},
"id": "RecurringTimeWindow",
"description": "Represents an arbitrary window of time that recurs.",
"type": "object"
},
"SetLegacyAbacRequest": {
"description": "SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.",
"id": "SetLegacyAbacRequest",
"type": "object",
"properties": {
"clusterId": {
"description": "Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.",
"type": "string"
},
"projectId": {
"description": "Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.",
"type": "string"
},
"name": {
"description": "The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format `projects/*/locations/*/clusters/*`.",
"type": "string"
},
"enabled": {
"description": "Required. Whether ABAC authorization will be enabled in the cluster.",
"type": "boolean"
},
"zone": {
"type": "string",
"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field."
}
}
},
"KubernetesDashboard": {
"properties": {
"disabled": {
"description": "Whether the Kubernetes Dashboard is enabled for this cluster.",
"type": "boolean"
}
},
"type": "object",
"description": "Configuration for the Kubernetes Dashboard.",
"id": "KubernetesDashboard"
}
},
"version": "v1",
"description": "Builds and manages container-based applications, powered by the open source Kubernetes technology.",
"batchPath": "batch",
"documentationLink": "https://cloud.google.com/container-engine/"
}