Document AI Warehouse API . projects . locations . links

Instance Methods

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a link.

delete(name, x__xgafv=None)

Deletes a link between a collection and a document.

get(name, x__xgafv=None)

Gets a link.

patch(name, linksId, body=None, x__xgafv=None)

Updates the link using provided UpdateLinkRequest.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a link.

Args:
  parent: string, Required. The parent name. (required)
  body: object, The request body.
    The object takes the form of:

{ # Defines the structure for content warehouse link proto.
  "attributes": { # Other link attributes.
    "a_key": "", # Properties of the object.
  },
  "collectionId": "A String", # The collection the link connects to. Should have the same project and location with the link.
  "createTime": "A String", # Output only. The create timestamp.
  "creator": "A String", # Output only. Indicates who created this link.
  "documentId": "A String", # The document the link connects to. Should have the same project and location with the link.
  "name": "A String", # The resource name of the link. Format: projects/{project_number}/locations/{location}/links/{link}. The name is ignored when creating a link.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Defines the structure for content warehouse link proto.
  "attributes": { # Other link attributes.
    "a_key": "", # Properties of the object.
  },
  "collectionId": "A String", # The collection the link connects to. Should have the same project and location with the link.
  "createTime": "A String", # Output only. The create timestamp.
  "creator": "A String", # Output only. Indicates who created this link.
  "documentId": "A String", # The document the link connects to. Should have the same project and location with the link.
  "name": "A String", # The resource name of the link. Format: projects/{project_number}/locations/{location}/links/{link}. The name is ignored when creating a link.
}
delete(name, x__xgafv=None)
Deletes a link between a collection and a document.

Args:
  name: string, Required. The name of the link to delete. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
get(name, x__xgafv=None)
Gets a link.

Args:
  name: string, Required. The name of the link to retrieve. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Defines the structure for content warehouse link proto.
  "attributes": { # Other link attributes.
    "a_key": "", # Properties of the object.
  },
  "collectionId": "A String", # The collection the link connects to. Should have the same project and location with the link.
  "createTime": "A String", # Output only. The create timestamp.
  "creator": "A String", # Output only. Indicates who created this link.
  "documentId": "A String", # The document the link connects to. Should have the same project and location with the link.
  "name": "A String", # The resource name of the link. Format: projects/{project_number}/locations/{location}/links/{link}. The name is ignored when creating a link.
}
patch(name, linksId, body=None, x__xgafv=None)
Updates the link using provided UpdateLinkRequest.

Args:
  name: string, The resource name of the link. Format: projects/{project_number}/locations/{location}/links/{link}. The name is ignored when creating a link. (required)
  linksId: string, A parameter (required)
  body: object, The request body.
    The object takes the form of:

{ # Defines the structure for content warehouse link proto.
  "attributes": { # Other link attributes.
    "a_key": "", # Properties of the object.
  },
  "collectionId": "A String", # The collection the link connects to. Should have the same project and location with the link.
  "createTime": "A String", # Output only. The create timestamp.
  "creator": "A String", # Output only. Indicates who created this link.
  "documentId": "A String", # The document the link connects to. Should have the same project and location with the link.
  "name": "A String", # The resource name of the link. Format: projects/{project_number}/locations/{location}/links/{link}. The name is ignored when creating a link.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Defines the structure for content warehouse link proto.
  "attributes": { # Other link attributes.
    "a_key": "", # Properties of the object.
  },
  "collectionId": "A String", # The collection the link connects to. Should have the same project and location with the link.
  "createTime": "A String", # Output only. The create timestamp.
  "creator": "A String", # Output only. Indicates who created this link.
  "documentId": "A String", # The document the link connects to. Should have the same project and location with the link.
  "name": "A String", # The resource name of the link. Format: projects/{project_number}/locations/{location}/links/{link}. The name is ignored when creating a link.
}