com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.Collections.Engines.Controls

java.lang.Object

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

Enclosing class:

DiscoveryEngine.Projects.Locations.Collections.Engines

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

The "controls" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Controls.Create
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Controls.Delete
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Controls.Get
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Controls.List
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Controls.Patch

Constructor Summary

Constructors

Constructor and Description
Controls()

Method Summary

Modifier and Type	Method and Description
DiscoveryEngine.Projects.Locations.Collections.Engines.Controls.Create	create(String parent, GoogleCloudDiscoveryengineV1Control content) Creates a Control.
DiscoveryEngine.Projects.Locations.Collections.Engines.Controls.Delete	delete(String name) Deletes a Control.
DiscoveryEngine.Projects.Locations.Collections.Engines.Controls.Get	get(String name) Gets a Control.
DiscoveryEngine.Projects.Locations.Collections.Engines.Controls.List	list(String parent) Lists all Controls by their parent DataStore.
DiscoveryEngine.Projects.Locations.Collections.Engines.Controls.Patch	patch(String name, GoogleCloudDiscoveryengineV1Control content) Updates a Control.

Methods inherited from class java.lang.Object

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

Constructor Detail

Controls

public Controls()

Method Detail

create

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

Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. Create a request for the method "controls.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. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_stor e_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.

content - the GoogleCloudDiscoveryengineV1Control

Returns:

the request

Throws:

IOException

delete

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

Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. Create a request for the method "controls.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. The resource name of the Control to delete. Format: `projects/{project}/locations/{locatio n}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`

Returns:

the request

Throws:

IOException

get

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

Gets a Control. Create a request for the method "controls.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. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/ collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`

Returns:

the request

Throws:

IOException

list

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

Lists all Controls by their parent DataStore. Create a request for the method "controls.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 data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_stor e_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.

Returns:

the request

Throws:

IOException

patch

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

Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. Create a request for the method "controls.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. Fully qualified name `projects/locations/global/dataStore/controls`

content - the GoogleCloudDiscoveryengineV1Control

Returns:

the request

Throws:

IOException