Discovery Engine API (discoveryengine:v1alpha)

Additions

Methods


• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.batchGetDocumentsMetadata

  Path: v1alpha/{+parent}/batchGetDocumentsMetadata

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata

  HTTP Method: GET

  Parameters:

  parent

  Description: Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$

  Location: path

  Required: Yes

  Type: string

  matcher.urisMatcher.uris

  Description: The exact URIs to match by.

  Location: query

  Repeated: Yes

  Type: string

  Parameter Order: parent

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Gets index freshness metadata for Documents. Supported for website search only.

• ▼ ▲ discoveryengine.projects.locations.userStores.operations.list

  Path: v1alpha/{+name}/operations

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/operations

  HTTP Method: GET

  Parameters:

  name

  Description: The name of the operation's parent resource.

  Pattern: ^projects/[^/]+/locations/[^/]+/userStores/[^/]+$

  Location: path

  Required: Yes

  Type: string

  filter

  Description: The standard list filter.

  Location: query

  Type: string

  pageSize

  Description: The standard list page size.

  Location: query

  Type: integer

  Format: int32

  pageToken

  Description: The standard list page token.

  Location: query

  Type: string

  Parameter Order: name

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

• ▼ ▲ discoveryengine.projects.locations.userStores.operations.get

  Path: v1alpha/{+name}

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/operations/{operationsId}

  HTTP Method: GET

  Parameters:

  name

  Description: The name of the operation resource.

  Pattern: ^projects/[^/]+/locations/[^/]+/userStores/[^/]+/operations/[^/]+$

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

• ▼ ▲ discoveryengine.projects.locations.dataStores.branches.batchGetDocumentsMetadata

  Path: v1alpha/{+parent}/batchGetDocumentsMetadata

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata

  HTTP Method: GET

  Parameters:

  parent

  Description: Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.

  Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$

  Location: path

  Required: Yes

  Type: string

  matcher.urisMatcher.uris

  Description: The exact URIs to match by.

  Location: query

  Repeated: Yes

  Type: string

  Parameter Order: parent

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Gets index freshness metadata for Documents. Supported for website search only.