GoogleApi.Spanner.V1.Api.Projects.spanner_projects_instances_list

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

spanner_projects_instances_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

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

Lists all instances in the given project.

Parameters

  • connection (type: GoogleApi.Spanner.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the project for which a list of instances is requested. Values are of the form projects/.
  • 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) - An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: name display_name labels.key where key is the name of a label Some examples of using filters are: name:* --> The instance has a name. name:Howl --> The instance's name contains the string "howl". name:HOWL --> Equivalent to above. NAME:howl --> Equivalent to above. labels.env:* --> The instance has the label "env". labels.env:dev --> The instance has the label "env" and the value of the label contains the string "dev". name:howl labels.env:dev --> The instance's name contains "howl" and it has the label "env" with its value containing "dev".
    • :instanceDeadline (type: DateTime.t) - Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.
    • :pageSize (type: integer()) - Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
    • :pageToken (type: String.t) - If non-empty, page_token should contain a next_page_token from a previous ListInstancesResponse.
  • opts (type: keyword()) - Call options

Returns

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