Googly.DocumentAI.Projects.Locations.ProcessorTypes (googly_document_ai v0.1.0)

Copy Markdown View Source

Endpoints for the Projects.Locations.ProcessorTypes resource.

Summary

Functions

get(name, opts \\ [])

Gets a processor type detail.

list(parent, opts \\ [])

Lists the processor types that exist.

Functions

get(name, opts \\ [])

@spec get(
  String.t(),
  keyword()
) ::
  {:ok, Googly.DocumentAI.Model.GoogleCloudDocumentaiV1ProcessorType.t()}
  | {:error, term()}

Gets a processor type detail.

Parameters

  • name (type: String.t()) - Required. The processor type resource name.
  • opts (type: keyword()) - Query and call options (:token, plus any of the below)
    • 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.
    • pretty_print (type: boolean()) - Returns response with indentations and line breaks.
    • quota_user (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.
    • upload_protocol (type: String.t()) - Upload protocol for media (e.g. "raw", "multipart").
    • upload_type (type: String.t()) - Legacy upload protocol for media (e.g. "media", "multipart").
    • xgafv (type: String.t()) - V1 error format.

Returns

  • {:ok, %Googly.DocumentAI.Model.GoogleCloudDocumentaiV1ProcessorType{}} on success
  • {:error, %Googly.DocumentAI.Error{}} on failure

list(parent, opts \\ [])

@spec list(
  String.t(),
  keyword()
) ::
  {:ok,
   Googly.DocumentAI.Model.GoogleCloudDocumentaiV1ListProcessorTypesResponse.t()}
  | {:error, term()}

Lists the processor types that exist.

Parameters

  • parent (type: String.t()) - Required. The location of processor types to list. Format: projects/{project}/locations/{location}.
  • opts (type: keyword()) - Query and call options (:token, plus any of the below)
    • 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.
    • pretty_print (type: boolean()) - Returns response with indentations and line breaks.
    • quota_user (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.
    • upload_protocol (type: String.t()) - Upload protocol for media (e.g. "raw", "multipart").
    • upload_type (type: String.t()) - Legacy upload protocol for media (e.g. "media", "multipart").
    • xgafv (type: String.t()) - V1 error format.
    • page_size (type: integer()) - The maximum number of processor types to return. If unspecified, at most 100 processor types will be returned. The maximum value is 500. Values above 500 will be coerced to 500.
    • page_token (type: String.t()) - Used to retrieve the next page of results, empty if at the end of the list.

Returns

  • {:ok, %Googly.DocumentAI.Model.GoogleCloudDocumentaiV1ListProcessorTypesResponse{}} on success
  • {:error, %Googly.DocumentAI.Error{}} on failure