Class ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.ListRequest

Lists all Agents under an Assistant which were created by the caller.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GoogleCloudDiscoveryengineV1alphaListAgentsResponse>
DiscoveryEngineBaseServiceRequest<GoogleCloudDiscoveryengineV1alphaListAgentsResponse>
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1alpha
Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll
Syntax
public class ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.ListRequest : DiscoveryEngineBaseServiceRequest<GoogleCloudDiscoveryengineV1alphaListAgentsResponse>, IClientServiceRequest<GoogleCloudDiscoveryengineV1alphaListAgentsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string parent)
Parameters
Type Name Description
IClientService service
string parent

Properties

Filter

Optional. Filters the Agents list. Supported fields: * display_name: display name of the agent. Supports =, :. * id: ID of the agent. Supports =. * state: state of the agent. Supports =. * create_time: timestamp when the agent was created. Supports =, &gt;, &lt;, &gt;=, &lt;=. * update_time: timestamp when the agent was last updated. Supports =, &gt;, &lt;, &gt;=, &lt;=. Examples: * display_name = "My Agent" * create_time &gt; "2023-01-01T00:00:00Z"

Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

OrderBy

Optional. 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 * is_pinned Example: * "update_time desc" * "is_pinned desc,update_time desc": list agents by is_pinned first, then by update_time.

Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
Property Value
Type Description
string

PageSize

Optional. Maximum number of Agents to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

Optional. A page token ListAgentsResponse.next_page_token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAgents must match the call that provided the page token.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Parent

Required. The parent resource name. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements