GoogleApi.Dataproc.V1.Api.Projects.dataproc_projects_regions_clusters_list

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

dataproc_projects_regions_clusters_list(connection, project_id, region, optional_params \\ [], opts \\ [])

View Source

Specs

dataproc_projects_regions_clusters_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Dataproc.V1.Model.ListClustersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all regions/{region}/clusters in a project alphabetically.

Parameters

  • connection (type: GoogleApi.Dataproc.V1.Connection.t) - Connection to server
  • project_id (type: String.t) - Required. The ID of the Google Cloud Platform project that the cluster belongs to.
  • region (type: String.t) - Required. The Dataproc region in which to handle the request.
  • 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").
    • :filter (type: String.t) - Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred =
    • :pageSize (type: integer()) - Optional. The standard List page size.
    • :pageToken (type: String.t) - Optional. The standard List page token.
  • opts (type: keyword()) - Call options

Returns

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