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

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.

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

Constructors

SuspendAgentRequest(IClientService, string)

Constructs a new SuspendAgent request.

Declaration
public SuspendAgentRequest(IClientService service, string name)
Parameters
Type Name Description
IClientService service
string name

Properties

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

Name

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

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

RestPath

Gets the REST path.

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

SuspensionReason

Required. The reason for suspending the Agent. This will be shown to the users of the Agent.

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

Methods

InitParameters()

Initializes SuspendAgent parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements