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

Copy Markdown View Source

Endpoints for the Projects.Locations.Schemas resource.

Summary

Functions

create(parent, opts \\ [])

Creates a schema.

delete(name, opts \\ [])

Deletes a schema.

get(name, opts \\ [])

Gets a schema.

list(parent, opts \\ [])

Lists Schemas.

patch(name, opts \\ [])

Updates a schema. Editable fields are: - display_name - labels

Functions

create(parent, opts \\ [])

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

Creates a schema.

Parameters

  • parent (type: String.t()) - Required. The parent (project and location) under which to create the Schema. 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.
    • body (type: Googly.DocumentAI.Model.GoogleCloudDocumentaiV1NextSchema.t()) -

Returns

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

delete(name, opts \\ [])

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

Deletes a schema.

Parameters

  • name (type: String.t()) - Required. The name of the Schema to be deleted. Format: projects/{project}/locations/{location}/schemas/{schema}
  • 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.
    • force (type: boolean()) - Optional. If set to true, any child resources of this Schema will also be deleted. (Otherwise, the request will only work if the Schema has no child resources.)

Returns

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

get(name, opts \\ [])

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

Gets a schema.

Parameters

  • name (type: String.t()) - Required. The name of the Schema to get. Format: projects/{project}/locations/{location}/schemas/{schema}
  • 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.GoogleCloudDocumentaiV1NextSchema{}} on success
  • {:error, %Googly.DocumentAI.Error{}} on failure

list(parent, opts \\ [])

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

Lists Schemas.

Parameters

  • parent (type: String.t()) - Required. 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()) - Optional. The maximum number of schema groups to return. If unspecified, at most 10 Schema will be returned. The maximum value is 20. Values above 20 will be coerced to 20.
    • page_token (type: String.t()) - Optional. Returns the schema groups sorted by creation time. The page token will point to the next Schema.

Returns

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

patch(name, opts \\ [])

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

Updates a schema. Editable fields are: - display_name - labels

Parameters

  • name (type: String.t()) - Identifier. The resource name of the Schema. Format: projects/{project}/locations/{location}/schemas/{schema}
  • 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.
    • update_mask (type: String.t()) - Optional. The update mask to apply to the resource. Note: Only the following fields can be updated: - display_name - labels
    • body (type: Googly.DocumentAI.Model.GoogleCloudDocumentaiV1NextSchema.t()) -

Returns

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