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

The "agents" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.DiscoveryEngine.v1alpha

Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll

Syntax

public class ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource

Constructors

AgentsResource(IClientService)

Constructs a new resource.

Declaration

public AgentsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

Files

Gets the Files resource.

Declaration

public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.FilesResource Files { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.FilesResource

Operations

Gets the Operations resource.

Declaration

public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.OperationsResource Operations { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.OperationsResource

Methods

Create(GoogleCloudDiscoveryengineV1alphaAgent, string)

Creates an Agent.

Declaration

public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.CreateRequest Create(GoogleCloudDiscoveryengineV1alphaAgent body, string parent)

Parameters

Type	Name	Description
GoogleCloudDiscoveryengineV1alphaAgent	body	The body of the request.
string	parent	Required. The parent resource name. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.CreateRequest

Delete(string)

Deletes an Agent.

Declaration

public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. Resource name of Agent. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent} If the caller does not have permission to delete the agent, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the agent to delete does not exist, a NOT_FOUND error is returned.

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.DeleteRequest

DisableAgent(string)

Disables an Agent. The state of the Agent becomes DISABLED. Can be called on an Agent in the state ENABLED orSUSPENDED, otherwise it returns an error.

Declaration

public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.DisableAgentRequest DisableAgent(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the Agent to disable. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.DisableAgentRequest

EnableAgent(string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.EnableAgentRequest EnableAgent(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the Agent to enable. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.EnableAgentRequest

Get(string)

Gets an Agent.

Declaration

public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. Resource name of Agent. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.GetRequest

GetAgentView(string)

Returns a AgentView for a given Agent, which contains additional information about the Agent.

Declaration

public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.GetAgentViewRequest GetAgentView(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the Agent to get. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.GetAgentViewRequest

GetIamPolicy(string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.GetIamPolicyRequest GetIamPolicy(string resource)

Parameters

Type	Name	Description
string	resource	REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.GetIamPolicyRequest

List(string)

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

Declaration

public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.ListRequest List(string parent)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.ListRequest

Patch(GoogleCloudDiscoveryengineV1alphaAgent, string)

Updates an Agent

Declaration

public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.PatchRequest Patch(GoogleCloudDiscoveryengineV1alphaAgent body, string name)

Parameters

Type	Name	Description
GoogleCloudDiscoveryengineV1alphaAgent	body	The body of the request.
string	name	Identifier. Resource name of the agent. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.PatchRequest

SetIamPolicy(GoogleIamV1SetIamPolicyRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.SetIamPolicyRequest SetIamPolicy(GoogleIamV1SetIamPolicyRequest body, string resource)

Parameters

Type	Name	Description
GoogleIamV1SetIamPolicyRequest	body	The body of the request.
string	resource	REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.SetIamPolicyRequest

SuspendAgent(string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.SuspendAgentRequest SuspendAgent(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the Agent to suspend. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.AssistantsResource.AgentsResource.SuspendAgentRequest