GoogleApi.Container.V1.Api.Projects.container_projects_locations_clusters_delete

You're seeing just the function container_projects_locations_clusters_delete, go back to GoogleApi.Container.V1.Api.Projects module for more information.
Link to this function

container_projects_locations_clusters_delete(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

container_projects_locations_clusters_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Container.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.Container.V1.Connection.t) - Connection to server
  • name (type: String.t) - The name (project, location, cluster) of the cluster to delete. Specified in the format projects/*/locations/*/clusters/*.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :clusterId (type: String.t) - Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field.
    • :projectId (type: String.t) - Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
    • :zone (type: String.t) - Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Container.V1.Model.Operation{}} on success
  • {:error, info} on failure