com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.Collections.Engines

java.lang.Object

com.google.api.services.discoveryengine.v1.DiscoveryEngine.Projects.Locations.Collections.Engines

Enclosing class:

DiscoveryEngine.Projects.Locations.Collections

public class DiscoveryEngine.Projects.Locations.Collections.Engines
extends Object

The "engines" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants The "assistants" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.Engines.CompletionConfig The "completionConfig" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Controls The "controls" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations The "conversations" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Create
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Delete
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Get
class	DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy
class	DiscoveryEngine.Projects.Locations.Collections.Engines.List
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Operations The "operations" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Patch
class	DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs The "servingConfigs" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Sessions The "sessions" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.Engines.SetIamPolicy
class	DiscoveryEngine.Projects.Locations.Collections.Engines.WidgetConfigs The "widgetConfigs" collection of methods.

Constructor Summary

Constructors

Constructor and Description
Engines()

Method Summary

Modifier and Type	Method and Description
DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants	assistants() An accessor for creating requests from the Assistants collection.
DiscoveryEngine.Projects.Locations.Collections.Engines.CompletionConfig	completionConfig() An accessor for creating requests from the CompletionConfig collection.
DiscoveryEngine.Projects.Locations.Collections.Engines.Controls	controls() An accessor for creating requests from the Controls collection.
DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations	conversations() An accessor for creating requests from the Conversations collection.
DiscoveryEngine.Projects.Locations.Collections.Engines.Create	create(String parent, GoogleCloudDiscoveryengineV1Engine content) Creates an Engine.
DiscoveryEngine.Projects.Locations.Collections.Engines.Delete	delete(String name) Deletes an Engine.
DiscoveryEngine.Projects.Locations.Collections.Engines.Get	get(String name) Gets an Engine.
DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy	getIamPolicy(String resource) Gets the IAM access control policy for an Engine.
DiscoveryEngine.Projects.Locations.Collections.Engines.List	list(String parent) Lists all the Engines associated with the project.
DiscoveryEngine.Projects.Locations.Collections.Engines.Operations	operations() An accessor for creating requests from the Operations collection.
DiscoveryEngine.Projects.Locations.Collections.Engines.Patch	patch(String name, GoogleCloudDiscoveryengineV1Engine content) Updates an Engine Create a request for the method "engines.patch".
DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs	servingConfigs() An accessor for creating requests from the ServingConfigs collection.
DiscoveryEngine.Projects.Locations.Collections.Engines.Sessions	sessions() An accessor for creating requests from the Sessions collection.
DiscoveryEngine.Projects.Locations.Collections.Engines.SetIamPolicy	setIamPolicy(String resource, GoogleIamV1SetIamPolicyRequest content) Sets the IAM access control policy for an Engine.
DiscoveryEngine.Projects.Locations.Collections.Engines.WidgetConfigs	widgetConfigs() An accessor for creating requests from the WidgetConfigs collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

Engines

public Engines()

Method Detail

create

public DiscoveryEngine.Projects.Locations.Collections.Engines.Create create(String parent,
                                                                            GoogleCloudDiscoveryengineV1Engine content)
                                                                     throws IOException

Creates an Engine. Create a request for the method "engines.create". 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:

parent - Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.

content - the GoogleCloudDiscoveryengineV1Engine

Returns:

the request

Throws:

IOException

delete

public DiscoveryEngine.Projects.Locations.Collections.Engines.Delete delete(String name)
                                                                     throws IOException

Deletes an Engine. Create a request for the method "engines.delete". 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:

name - Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned.

Returns:

the request

Throws:

IOException

get

public DiscoveryEngine.Projects.Locations.Collections.Engines.Get get(String name)
                                                               throws IOException

Gets an Engine. Create a request for the method "engines.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:

name - Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.

Returns:

the request

Throws:

IOException

getIamPolicy

public DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy getIamPolicy(String resource)
                                                                                 throws IOException

Gets the IAM access control policy for an Engine. 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. Create a request for the method "engines.getIamPolicy". 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:

resource - REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

Returns:

the request

Throws:

IOException

list

public DiscoveryEngine.Projects.Locations.Collections.Engines.List list(String parent)
                                                                 throws IOException

Lists all the Engines associated with the project. Create a request for the method "engines.list". 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:

parent - Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`.

Returns:

the request

Throws:

IOException

patch

public DiscoveryEngine.Projects.Locations.Collections.Engines.Patch patch(String name,
                                                                          GoogleCloudDiscoveryengineV1Engine content)
                                                                   throws IOException

Updates an Engine Create a request for the method "engines.patch". 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:

name - Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9. Otherwise, an INVALID_ARGUMENT error is returned.

content - the GoogleCloudDiscoveryengineV1Engine

Returns:

the request

Throws:

IOException

setIamPolicy

public DiscoveryEngine.Projects.Locations.Collections.Engines.SetIamPolicy setIamPolicy(String resource,
                                                                                        GoogleIamV1SetIamPolicyRequest content)
                                                                                 throws IOException

Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.user` and `roles/discoveryengine.agentspaceUser`. Attempting to grant any other role will result in a warning in logging. Create a request for the method "engines.setIamPolicy". 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:

resource - REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the GoogleIamV1SetIamPolicyRequest

Returns:

the request

Throws:

IOException

assistants

public DiscoveryEngine.Projects.Locations.Collections.Engines.Assistants assistants()

An accessor for creating requests from the Assistants collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.Assistants.List request = discoveryengine.assistants().list(parameters ...)
 

Returns:

the resource collection

completionConfig

public DiscoveryEngine.Projects.Locations.Collections.Engines.CompletionConfig completionConfig()

An accessor for creating requests from the CompletionConfig collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.CompletionConfig.List request = discoveryengine.completionConfig().list(parameters ...)
 

Returns:

the resource collection

controls

public DiscoveryEngine.Projects.Locations.Collections.Engines.Controls controls()

An accessor for creating requests from the Controls collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.Controls.List request = discoveryengine.controls().list(parameters ...)
 

Returns:

the resource collection

conversations

public DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations conversations()

An accessor for creating requests from the Conversations collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.Conversations.List request = discoveryengine.conversations().list(parameters ...)
 

Returns:

the resource collection

operations

public DiscoveryEngine.Projects.Locations.Collections.Engines.Operations operations()

An accessor for creating requests from the Operations collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.Operations.List request = discoveryengine.operations().list(parameters ...)
 

Returns:

the resource collection

servingConfigs

public DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs servingConfigs()

An accessor for creating requests from the ServingConfigs collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.ServingConfigs.List request = discoveryengine.servingConfigs().list(parameters ...)
 

Returns:

the resource collection

sessions

public DiscoveryEngine.Projects.Locations.Collections.Engines.Sessions sessions()

An accessor for creating requests from the Sessions collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.Sessions.List request = discoveryengine.sessions().list(parameters ...)
 

Returns:

the resource collection

widgetConfigs

public DiscoveryEngine.Projects.Locations.Collections.Engines.WidgetConfigs widgetConfigs()

An accessor for creating requests from the WidgetConfigs collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.WidgetConfigs.List request = discoveryengine.widgetConfigs().list(parameters ...)
 

Returns:

the resource collection