2023-12-06
▼ ▲ discoveryengine.projects.locations.collections.dataStores.getSiteSearchEngine
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine
HTTP Method : GET
Parameters :
name
Description : Required. Resource name of SiteSearchEngine, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the SiteSearchEngine.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.enableAdvancedSiteSearch
Path : v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch
HTTP Method : POST
Parameters :
siteSearchEngine
Description : Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location : path
Required : Yes
Type : string
Parameter Order : siteSearchEngine
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Upgrade from basic site search to advanced site search.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.disableAdvancedSiteSearch
Path : v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch
HTTP Method : POST
Parameters :
siteSearchEngine
Description : Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location : path
Required : Yes
Type : string
Parameter Order : siteSearchEngine
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Downgrade from advanced site search to basic site search.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.batchVerifyTargetSites
Path : v1alpha/{+parent}:batchVerifyTargetSites
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:batchVerifyTargetSites
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource shared by all TargetSites being verified. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.fetchDomainVerificationStatus
Path : v1alpha/{+siteSearchEngine}:fetchDomainVerificationStatus
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:fetchDomainVerificationStatus
HTTP Method : GET
Parameters :
siteSearchEngine
Description : Required. The site search engine resource under which we fetch all the domain verification status. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location : path
Required : Yes
Type : string
pageSize
Description : Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token, received from a previous `FetchDomainVerificationStatus` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchDomainVerificationStatus` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : siteSearchEngine
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.create
Path : v1alpha/{+parent}/targetSites
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites
HTTP Method : POST
Parameters :
parent
Description : Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a TargetSite.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.batchCreate
Path : v1alpha/{+parent}/targetSites:batchCreate
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites:batchCreate
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource shared by all TargetSites being created. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates TargetSite in a batch.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.get
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}
HTTP Method : GET
Parameters :
name
Description : Required. Full resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a TargetSite.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.patch
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a TargetSite.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.delete
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. Full resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a TargetSite.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.list
Path : v1alpha/{+parent}/targetSites
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites
HTTP Method : GET
Parameters :
parent
Description : Required. The parent site search engine resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location : path
Required : Yes
Type : string
pageSize
Description : Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a list of TargetSites.
▼ ▲ discoveryengine.projects.locations.collections.engines.conversations.converse
Path : v1alpha/{+name}:converse
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}:converse
HTTP Method : POST
Parameters :
name
Description : Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Converses a conversation.
▼ ▲ discoveryengine.projects.locations.collections.engines.conversations.create
Path : v1alpha/{+parent}/conversations
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations
HTTP Method : POST
Parameters :
parent
Description : Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.
▼ ▲ discoveryengine.projects.locations.collections.engines.conversations.delete
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the Conversation to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.
▼ ▲ discoveryengine.projects.locations.collections.engines.conversations.patch
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}
HTTP Method : PATCH
Parameters :
name
Description : Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*` or `project/*/locations/global/collections/{collection}/engines/*/conversations/*`.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Indicates which fields in the provided Conversation to update. The following are NOT supported: * conversation.name If not set or empty, 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 Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.
▼ ▲ discoveryengine.projects.locations.collections.engines.conversations.get
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a Conversation.
▼ ▲ discoveryengine.projects.locations.collections.engines.conversations.list
Path : v1alpha/{+parent}/conversations
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations
HTTP Method : GET
Parameters :
parent
Description : Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page.
Location : query
Type : string
filter
Description : A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
Location : query
Type : string
orderBy
Description : A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time"
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all Conversations by their parent DataStore.
▼ ▲ discoveryengine.projects.locations.dataStores.getSiteSearchEngine
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine
HTTP Method : GET
Parameters :
name
Description : Required. Resource name of SiteSearchEngine, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the SiteSearchEngine.
▼ ▲ discoveryengine.projects.locations.dataStores.siteSearchEngine.enableAdvancedSiteSearch
Path : v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch
HTTP Method : POST
Parameters :
siteSearchEngine
Description : Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
Pattern : ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location : path
Required : Yes
Type : string
Parameter Order : siteSearchEngine
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Upgrade from basic site search to advanced site search.
▼ ▲ discoveryengine.projects.locations.dataStores.siteSearchEngine.disableAdvancedSiteSearch
Path : v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch
HTTP Method : POST
Parameters :
siteSearchEngine
Description : Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
Pattern : ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location : path
Required : Yes
Type : string
Parameter Order : siteSearchEngine
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Downgrade from advanced site search to basic site search.
▼ ▲ discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.create
Path : v1alpha/{+parent}/targetSites
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites
HTTP Method : POST
Parameters :
parent
Description : Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
Pattern : ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a TargetSite.
▼ ▲ discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.batchCreate
Path : v1alpha/{+parent}/targetSites:batchCreate
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites:batchCreate
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource shared by all TargetSites being created. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field.
Pattern : ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates TargetSite in a batch.
▼ ▲ discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.get
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}
HTTP Method : GET
Parameters :
name
Description : Required. Full resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a TargetSite.
▼ ▲ discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.patch
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.
Pattern : ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates a TargetSite.
▼ ▲ discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.delete
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. Full resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a TargetSite.
▼ ▲ discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.list
Path : v1alpha/{+parent}/targetSites
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites
HTTP Method : GET
Parameters :
parent
Description : Required. The parent site search engine resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.
Pattern : ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$
Location : path
Required : Yes
Type : string
pageSize
Description : Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.
Location : query
Type : integer
Format : int32
pageToken
Description : A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a list of TargetSites.