GoogleApi.Vault.V1.Api.Matters.vault_matters_holds_list

You're seeing just the function vault_matters_holds_list, go back to GoogleApi.Vault.V1.Api.Matters module for more information.
Link to this function

vault_matters_holds_list(connection, matter_id, optional_params \\ [], opts \\ [])

View Source

Specs

vault_matters_holds_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Vault.V1.Model.ListHoldsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the holds in a matter.

Parameters

  • connection (type: GoogleApi.Vault.V1.Connection.t) - Connection to server
  • matter_id (type: String.t) - The matter ID.
  • 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 number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as page_size = 100.
    • :pageToken (type: String.t) - The pagination token as returned in the response. An empty token means start from the beginning.
    • :view (type: String.t) - The amount of detail to return for a hold.
  • opts (type: keyword()) - Call options

Returns

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