Discovery Engine API (discoveryengine:v1alpha)

Additions

Methods


• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.servingConfigs.patch

  Path: v1alpha/{+name}

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}

  HTTP Method: PATCH

  Parameters:

  name

  Description: Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`

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

  Location: path

  Required: Yes

  Type: string

  updateMask

  Description: Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.

  Location: query

  Type: string

  Format: google-fieldmask

  Parameter Order: name

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

  Description: Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.

• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.servingConfigs.get

  Path: v1alpha/{+name}

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}

  HTTP Method: GET

  Parameters:

  name

  Description: Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config_id}`

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

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

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

  Description: Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.

• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.servingConfigs.list

  Path: v1alpha/{+parent}/servingConfigs

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs

  HTTP Method: GET

  Parameters:

  parent

  Description: Required. The dataStore resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}`

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

  Location: path

  Required: Yes

  Type: string

  pageSize

  Description: Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.

  Location: query

  Type: integer

  Format: int32

  pageToken

  Description: Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.

  Location: query

  Type: string

  Parameter Order: parent

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

  Description: Lists all ServingConfigs linked to this dataStore.

• ▼ ▲ discoveryengine.projects.locations.collections.engines.servingConfigs.patch

  Path: v1alpha/{+name}

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}

  HTTP Method: PATCH

  Parameters:

  name

  Description: Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$

  Location: path

  Required: Yes

  Type: string

  updateMask

  Description: Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.

  Location: query

  Type: string

  Format: google-fieldmask

  Parameter Order: name

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

  Description: Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.

• ▼ ▲ discoveryengine.projects.locations.collections.engines.servingConfigs.get

  Path: v1alpha/{+name}

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}

  HTTP Method: GET

  Parameters:

  name

  Description: Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config_id}`

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

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

  Description: Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.

• ▼ ▲ discoveryengine.projects.locations.collections.engines.servingConfigs.list

  Path: v1alpha/{+parent}/servingConfigs

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs

  HTTP Method: GET

  Parameters:

  parent

  Description: Required. The dataStore resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}`

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$

  Location: path

  Required: Yes

  Type: string

  pageSize

  Description: Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.

  Location: query

  Type: integer

  Format: int32

  pageToken

  Description: Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.

  Location: query

  Type: string

  Parameter Order: parent

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

  Description: Lists all ServingConfigs linked to this dataStore.

• ▼ ▲ discoveryengine.projects.locations.dataStores.servingConfigs.patch

  Path: v1alpha/{+name}

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}

  HTTP Method: PATCH

  Parameters:

  name

  Description: Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`

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

  Location: path

  Required: Yes

  Type: string

  updateMask

  Description: Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.

  Location: query

  Type: string

  Format: google-fieldmask

  Parameter Order: name

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

  Description: Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.

• ▼ ▲ discoveryengine.projects.locations.dataStores.servingConfigs.get

  Path: v1alpha/{+name}

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}

  HTTP Method: GET

  Parameters:

  name

  Description: Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config_id}`

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

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

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

  Description: Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.

• ▼ ▲ discoveryengine.projects.locations.dataStores.servingConfigs.list

  Path: v1alpha/{+parent}/servingConfigs

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs

  HTTP Method: GET

  Parameters:

  parent

  Description: Required. The dataStore resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}`

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

  Location: path

  Required: Yes

  Type: string

  pageSize

  Description: Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.

  Location: query

  Type: integer

  Format: int32

  pageToken

  Description: Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.

  Location: query

  Type: string

  Parameter Order: parent

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

  Description: Lists all ServingConfigs linked to this dataStore.