GoogleApi.Spanner.V1.Api.Projects.spanner_projects_instances_databases_get_scans

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

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

View Source

Specs

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

Request a specific scan with Database-specific data for Cloud Key Visualizer.

Parameters

  • connection (type: GoogleApi.Spanner.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The unique name of the scan containing the requested information, 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").
    • :endTime (type: DateTime.t) - The upper bound for the time range to retrieve Scan data for.
    • :startTime (type: DateTime.t) - These fields restrict the Database-specific information returned in the Scan.data field. If a View is provided that does not include the Scan.data field, these are ignored. This range of time must be entirely contained within the defined time range of the targeted scan. The lower bound for the time range to retrieve Scan data for.
    • :view (type: String.t) - Specifies which parts of the Scan should be returned in the response. Note, if left unspecified, the FULL view is assumed.
  • opts (type: keyword()) - Call options

Returns

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