GoogleApi.Spanner.V1.Api.Scans (google_api_spanner v0.32.0) View Source

API calls for all endpoints tagged Scans.

Link to this section Summary


Return available scans given a Database-specific resource name.

Link to this section Functions

Link to this function

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

View Source


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

Return available scans given a Database-specific resource name.


  • connection (type: GoogleApi.Spanner.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The unique name of the parent resource, specific to the Database service implementing this interface.
  • 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) - A filter expression to restrict the results based on information present in the available Scan collection. The filter applies to all fields within the Scan message except for data.
    • :pageSize (type: integer()) - The maximum number of items to return.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous List request, if any.
    • :view (type: String.t) - Specifies which parts of the Scan should be returned in the response. Note, only the SUMMARY view (the default) is currently supported for ListScans.
  • opts (type: keyword()) - Call options


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