2025-11-11
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.listAvailableAgentViews
Path : v1alpha/{+parent}:listAvailableAgentViews
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}:listAvailableAgentViews
HTTP Method : POST
Parameters :
parent
Description : Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$
Location : path
Required : Yes
Type : string
agentOrigin
Description : Optional. The origin of the Agent.
Location : query
Type : string
Enum Descriptions :
Enum :
sortBy
Description : Optional. The field to sort by. Can have the following values: - display-name: The display name of the agent. - description: The description of the agent. - create-time: The creation time of the agent. - state: The state of the agent.
Location : query
Type : string
pageSize
Description : Optional. Maximum number of AgentViewss to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A page token ListAvailableAgentViewsResponse.next_page_token, received from a previous AgentService.ListAvailableAgentViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAvailableAgentViews must match the call that provided the page token.
Location : query
Type : string
languageCode
Description : Optional. The UI language currently shown to the user. Specifying this field request that the texts in the AgentViews in the response should be translated to this language.
Location : query
Type : string
maxSuggestedPrompts
Description : Optional. The maximum number of suggested prompts to return per agent.
Location : query
Type : integer
Format : int32
filter
Description : Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the files being filtered. Filter expression is case-sensitive. Allowed fields are: * `display_name` * `state` Some examples of filters would be: * `display_name = 'agent_1'` * `display_name = 'agent_1' AND state = ENABLED` For a full description of the filter format, please see https://google.aip.dev/160.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Lists the data for displaying the Agents under an Assistant which are available to the caller.
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.getIamPolicy
Path : v1alpha/{+resource}:getIamPolicy
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}:getIamPolicy
HTTP Method : GET
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Location : path
Required : Yes
Type : string
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location : query
Type : integer
Format : int32
Parameter Order : resource
Scopes :
Description : Gets the access control policy for an agent resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.setIamPolicy
Path : v1alpha/{+resource}:setIamPolicy
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}:setIamPolicy
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : resource
Scopes :
Description : Sets the access control policy for an agent resource. A `NOT_FOUND` error is returned if the resource does not exist. Policy can only contain `roles/discoveryengine.agentUser`, `roles/discoveryengine.agentViewer` and `roles/discoveryengine.agentEditor` roles.
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.enableAgent
Path : v1alpha/{+name}:enableAgent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}:enableAgent
HTTP Method : POST
Parameters :
name
Description : Required. The name of the Agent to enable. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Enables an Agent. The `state` of the Agent becomes `ENABLED`. Can be called on an Agent in the state `DISABLED` or 'SUSPENDED', otherwise it returns an error.
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.disableAgent
Path : v1alpha/{+name}:disableAgent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}:disableAgent
HTTP Method : POST
Parameters :
name
Description : Required. The name of the Agent to disable. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Disables an Agent. The `state` of the Agent becomes `DISABLED`. Can be called on an Agent in the state `ENABLED` or`SUSPENDED`, otherwise it returns an error.
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.suspendAgent
Path : v1alpha/{+name}:suspendAgent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}:suspendAgent
HTTP Method : POST
Parameters :
name
Description : Required. The name of the Agent to suspend. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Location : path
Required : Yes
Type : string
suspensionReason
Description : Required. The reason for suspending the Agent. This will be shown to the users of the Agent.
Location : query
Type : string
Parameter Order : name
Scopes :
Description : Suspends an Agent. It is still available for viewing but not for use. The `state` of the Agent becomes `SUSPENDED`. Can be called on an Agent in the state `ENABLED`, otherwise it returns an error.
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.getAgentView
Path : v1alpha/{+name}:getAgentView
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}:getAgentView
HTTP Method : GET
Parameters :
name
Description : Required. The name of the Agent to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Location : path
Required : Yes
Type : string
languageCode
Description : Optional. The UI language currently shown to the user. Specifying this field request that the texts in the AgentView in the response should be translated to this language.
Location : query
Type : string
maxSuggestedPrompts
Description : Optional. The maximum number of suggested prompts to return per agent.
Location : query
Type : integer
Format : int32
Parameter Order : name
Scopes :
Description : Returns a AgentView for a given Agent, which contains additional information about the Agent.
▼ ▲ discoveryengine.projects.locations.userStores.licenseConfigsUsageStats.list
Path : v1alpha/{+parent}/licenseConfigsUsageStats
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/licenseConfigsUsageStats
HTTP Method : GET
Parameters :
parent
Description : Required. The parent branch resource name, such as `projects/{project}/locations/{location}/userStores/{user_store_id}`.
Pattern : ^projects/[^/]+/locations/[^/]+/userStores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes :
Description : Lists all the LicenseConfigUsageStatss associated with the project.