com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Agents.A2a.V1.Tasks

java.lang.Object

com.google.api.services.discoveryengine.v1.DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Agents.A2a.V1.Tasks

Enclosing class:

DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Agents.A2a.V1

public class DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Agents.A2a.V1.Tasks
extends Object

The "tasks" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Agents.A2a.V1.Tasks.Cancel
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Agents.A2a.V1.Tasks.Get
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Agents.A2a.V1.Tasks.PushNotificationConfigs The "pushNotificationConfigs" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Agents.A2a.V1.Tasks.Subscribe

Constructor Summary

Constructors

Constructor and Description
Tasks()

Method Summary

Modifier and Type	Method and Description
DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Agents.A2a.V1.Tasks.Cancel	cancel(String tenant, String name, A2aV1CancelTaskRequest content) Cancel a task from the agent.
DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Agents.A2a.V1.Tasks.Get	get(String tenant, String name) Get the current state of a task from the agent.
DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Agents.A2a.V1.Tasks.PushNotificationConfigs	pushNotificationConfigs() An accessor for creating requests from the PushNotificationConfigs collection.
DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Agents.A2a.V1.Tasks.Subscribe	subscribe(String tenant, String name) TaskSubscription is a streaming call that will return a stream of task update events.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Tasks

public Tasks()

Method Detail

cancel

public DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Agents.A2a.V1.Tasks.Cancel cancel(String tenant,
                                                                                                           String name,
                                                                                                           A2aV1CancelTaskRequest content)
                                                                                                    throws IOException

Cancel a task from the agent. If supported one should expect no more task updates for the task. Create a request for the method "tasks.cancel". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

tenant - Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.

name - The resource name of the task to cancel. Format: tasks/{task_id}

content - the A2aV1CancelTaskRequest

Returns:

the request

Throws:

IOException

get

public DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Agents.A2a.V1.Tasks.Get get(String tenant,
                                                                                                     String name)
                                                                                              throws IOException

Get the current state of a task from the agent. Create a request for the method "tasks.get". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

tenant - Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.

name - Required. The resource name of the task. Format: tasks/{task_id}

Returns:

the request

Throws:

IOException

subscribe

public DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Agents.A2a.V1.Tasks.Subscribe subscribe(String tenant,
                                                                                                                 String name)
                                                                                                          throws IOException

TaskSubscription is a streaming call that will return a stream of task update events. This attaches the stream to an existing in process task. If the task is complete the stream will return the completed task (like GetTask) and close the stream. Create a request for the method "tasks.subscribe". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

tenant - Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.

name - The resource name of the task to subscribe to. Format: tasks/{task_id}

Returns:

the request

Throws:

IOException

pushNotificationConfigs

public DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants.Agents.A2a.V1.Tasks.PushNotificationConfigs pushNotificationConfigs()

An accessor for creating requests from the PushNotificationConfigs collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.PushNotificationConfigs.List request = discoveryengine.pushNotificationConfigs().list(parameters ...)
 

Returns:

the resource collection