GoogleApi.Redis.V1.Api.Projects.redis_projects_locations_instances_list

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

redis_projects_locations_instances_list(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])

View Source

Specs

redis_projects_locations_instances_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Redis.V1.Model.ListInstancesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * projects/{project_id}/locations/{location_id} If location_id is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.

Parameters

  • connection (type: GoogleApi.Redis.V1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.
  • locations_id (type: String.t) - Part of parent. See documentation of projectsId.
  • 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").
    • :pageSize (type: integer()) - The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous ListInstances request, if any.
  • opts (type: keyword()) - Call options

Returns

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