Class ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.ListAvailableAgentViewsRequest

Lists the data for displaying the Agents under an Assistant which are available to the caller.

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

Constructors

ListAvailableAgentViewsRequest(IClientService, string)

Constructs a new ListAvailableAgentViews request.

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

Properties

AdminView

Optional. Indicates whether to consider if the caller is an admin. If set, and the caller is an admin, the response will consider admin-only permissions. Otherwise, a caller with admin permissions will get a response as an unprivileged user.

Declaration
[RequestParameter("adminView", RequestParameterType.Query)]
public virtual bool? AdminView { get; set; }
Property Value
Type Description
bool?

AgentOrigin

Optional. The origin of the Agent.

Declaration
[RequestParameter("agentOrigin", RequestParameterType.Query)]
public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.ListAvailableAgentViewsRequest.AgentOriginEnum? AgentOrigin { get; set; }
Property Value
Type Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.ListAvailableAgentViewsRequest.AgentOriginEnum?

Filter

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.

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

LanguageCode

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.

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

MaxSuggestedPrompts

Optional. The maximum number of suggested prompts to return per agent.

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

MethodName

Gets the method name.

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

PageSize

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.

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

PageToken

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.

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

SortBy

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.

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

Methods

InitParameters()

Initializes ListAvailableAgentViews parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements