com.google.cloud.discoveryengine.v1

Class ControlServiceClient

java.lang.Object

com.google.cloud.discoveryengine.v1.ControlServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class ControlServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service for performing CRUD operations on Controls. Controls allow for custom logic to be implemented in the serving path. Controls need to be attached to a Serving Config to be considered during a request.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   DataStoreName parent =
       DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]");
   Control control = Control.newBuilder().build();
   String controlId = "controlId-395080872";
   Control response = controlServiceClient.createControl(parent, control, controlId);
 }
 

Note: close() needs to be called on the ControlServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods

Method	Description	Method Variants
CreateControl	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][google.cloud.discoveryengine.v1.Control] to create already exists, an ALREADY_EXISTS error is returned.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createControl(CreateControlRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createControl(DataStoreName parent, Control control, String controlId) createControl(EngineName parent, Control control, String controlId) createControl(String parent, Control control, String controlId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createControlCallable()
DeleteControl	Deletes a Control. If the [Control][google.cloud.discoveryengine.v1.Control] to delete does not exist, a NOT_FOUND error is returned.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteControl(DeleteControlRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteControl(ControlName name) deleteControl(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteControlCallable()
UpdateControl	Updates a Control. [Control][google.cloud.discoveryengine.v1.Control] action type cannot be changed. If the [Control][google.cloud.discoveryengine.v1.Control] to update does not exist, a NOT_FOUND error is returned.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateControl(UpdateControlRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateControl(Control control, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateControlCallable()
GetControl	Gets a Control.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getControl(GetControlRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getControl(ControlName name) getControl(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getControlCallable()
ListControls	Lists all Controls by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].	Request object method variants only take one parameter, a request object, which must be constructed before the call. listControls(ListControlsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listControls(DataStoreName parent) listControls(EngineName parent) listControls(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listControlsPagedCallable() listControlsCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ControlServiceSettings to create(). For example:

To customize credentials:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ControlServiceSettings controlServiceSettings =
     ControlServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ControlServiceClient controlServiceClient = ControlServiceClient.create(controlServiceSettings);
 

To customize the endpoint:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ControlServiceSettings controlServiceSettings =
     ControlServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ControlServiceClient controlServiceClient = ControlServiceClient.create(controlServiceSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ControlServiceSettings controlServiceSettings =
     ControlServiceSettings.newHttpJsonBuilder().build();
 ControlServiceClient controlServiceClient = ControlServiceClient.create(controlServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ControlServiceClient.ListControlsFixedSizeCollection
static class	ControlServiceClient.ListControlsPage
static class	ControlServiceClient.ListControlsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ControlServiceClient(ControlServiceSettings settings) Constructs an instance of ControlServiceClient, using the given settings.
protected	ControlServiceClient(ControlServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static ControlServiceClient	create() Constructs an instance of ControlServiceClient with default settings.
static ControlServiceClient	create(ControlServiceSettings settings) Constructs an instance of ControlServiceClient, using the given settings.
static ControlServiceClient	create(ControlServiceStub stub) Constructs an instance of ControlServiceClient, using the given stub for making calls.
Control	createControl(CreateControlRequest request) Creates a Control.
Control	createControl(DataStoreName parent, Control control, String controlId) Creates a Control.
Control	createControl(EngineName parent, Control control, String controlId) Creates a Control.
Control	createControl(String parent, Control control, String controlId) Creates a Control.
com.google.api.gax.rpc.UnaryCallable<CreateControlRequest,Control>	createControlCallable() Creates a Control.
void	deleteControl(ControlName name) Deletes a Control.
void	deleteControl(DeleteControlRequest request) Deletes a Control.
void	deleteControl(String name) Deletes a Control.
com.google.api.gax.rpc.UnaryCallable<DeleteControlRequest,com.google.protobuf.Empty>	deleteControlCallable() Deletes a Control.
Control	getControl(ControlName name) Gets a Control.
Control	getControl(GetControlRequest request) Gets a Control.
Control	getControl(String name) Gets a Control.
com.google.api.gax.rpc.UnaryCallable<GetControlRequest,Control>	getControlCallable() Gets a Control.
ControlServiceSettings	getSettings()
ControlServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
ControlServiceClient.ListControlsPagedResponse	listControls(DataStoreName parent) Lists all Controls by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].
ControlServiceClient.ListControlsPagedResponse	listControls(EngineName parent) Lists all Controls by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].
ControlServiceClient.ListControlsPagedResponse	listControls(ListControlsRequest request) Lists all Controls by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].
ControlServiceClient.ListControlsPagedResponse	listControls(String parent) Lists all Controls by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].
com.google.api.gax.rpc.UnaryCallable<ListControlsRequest,ListControlsResponse>	listControlsCallable() Lists all Controls by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].
com.google.api.gax.rpc.UnaryCallable<ListControlsRequest,ControlServiceClient.ListControlsPagedResponse>	listControlsPagedCallable() Lists all Controls by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].
void	shutdown()
void	shutdownNow()
Control	updateControl(Control control, com.google.protobuf.FieldMask updateMask) Updates a Control.
Control	updateControl(UpdateControlRequest request) Updates a Control.
com.google.api.gax.rpc.UnaryCallable<UpdateControlRequest,Control>	updateControlCallable() Updates a Control.

Methods inherited from class java.lang.Object

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

Constructor Detail

ControlServiceClient

protected ControlServiceClient(ControlServiceSettings settings)
                        throws IOException

Constructs an instance of ControlServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

ControlServiceClient

protected ControlServiceClient(ControlServiceStub stub)

Method Detail

create

public static final ControlServiceClient create()
                                         throws IOException

Constructs an instance of ControlServiceClient with default settings.

Throws:

IOException

create

public static final ControlServiceClient create(ControlServiceSettings settings)
                                         throws IOException

Constructs an instance of ControlServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

public static final ControlServiceClient create(ControlServiceStub stub)

Constructs an instance of ControlServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ControlServiceSettings).

getSettings

public final ControlServiceSettings getSettings()

getStub

public ControlServiceStub getStub()

createControl

public final Control createControl(DataStoreName parent,
                                   Control control,
                                   String controlId)

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][google.cloud.discoveryengine.v1.Control] to create already exists, an ALREADY_EXISTS error is returned.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   DataStoreName parent =
       DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]");
   Control control = Control.newBuilder().build();
   String controlId = "controlId-395080872";
   Control response = controlServiceClient.createControl(parent, control, controlId);
 }
 

Parameters:

parent - Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.

control - Required. The Control to create.

controlId - Required. The ID to use for the Control, which will become the final component of the Control's resource name.

This value must be within 1-63 characters. Valid characters are /[a-z][0-9]-_/.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createControl

public final Control createControl(EngineName parent,
                                   Control control,
                                   String controlId)

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][google.cloud.discoveryengine.v1.Control] to create already exists, an ALREADY_EXISTS error is returned.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   EngineName parent = EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]");
   Control control = Control.newBuilder().build();
   String controlId = "controlId-395080872";
   Control response = controlServiceClient.createControl(parent, control, controlId);
 }
 

Parameters:

parent - Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.

control - Required. The Control to create.

controlId - Required. The ID to use for the Control, which will become the final component of the Control's resource name.

This value must be within 1-63 characters. Valid characters are /[a-z][0-9]-_/.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createControl

public final Control createControl(String parent,
                                   Control control,
                                   String controlId)

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][google.cloud.discoveryengine.v1.Control] to create already exists, an ALREADY_EXISTS error is returned.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   String parent =
       DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]")
           .toString();
   Control control = Control.newBuilder().build();
   String controlId = "controlId-395080872";
   Control response = controlServiceClient.createControl(parent, control, controlId);
 }
 

Parameters:

parent - Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.

control - Required. The Control to create.

controlId - Required. The ID to use for the Control, which will become the final component of the Control's resource name.

This value must be within 1-63 characters. Valid characters are /[a-z][0-9]-_/.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createControl

public final Control createControl(CreateControlRequest request)

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][google.cloud.discoveryengine.v1.Control] to create already exists, an ALREADY_EXISTS error is returned.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   CreateControlRequest request =
       CreateControlRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setControl(Control.newBuilder().build())
           .setControlId("controlId-395080872")
           .build();
   Control response = controlServiceClient.createControl(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createControlCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateControlRequest,Control> createControlCallable()

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][google.cloud.discoveryengine.v1.Control] to create already exists, an ALREADY_EXISTS error is returned.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   CreateControlRequest request =
       CreateControlRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setControl(Control.newBuilder().build())
           .setControlId("controlId-395080872")
           .build();
   ApiFuture<Control> future = controlServiceClient.createControlCallable().futureCall(request);
   // Do something.
   Control response = future.get();
 }
 

deleteControl

public final void deleteControl(ControlName name)

Deletes a Control.

If the [Control][google.cloud.discoveryengine.v1.Control] to delete does not exist, a NOT_FOUND error is returned.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   ControlName name =
       ControlName.ofProjectLocationDataStoreControlName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONTROL]");
   controlServiceClient.deleteControl(name);
 }
 

Parameters:

name - Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteControl

public final void deleteControl(String name)

Deletes a Control.

If the [Control][google.cloud.discoveryengine.v1.Control] to delete does not exist, a NOT_FOUND error is returned.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   String name =
       ControlName.ofProjectLocationDataStoreControlName(
               "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONTROL]")
           .toString();
   controlServiceClient.deleteControl(name);
 }
 

Parameters:

name - Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteControl

public final void deleteControl(DeleteControlRequest request)

Deletes a Control.

If the [Control][google.cloud.discoveryengine.v1.Control] to delete does not exist, a NOT_FOUND error is returned.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   DeleteControlRequest request =
       DeleteControlRequest.newBuilder()
           .setName(
               ControlName.ofProjectLocationDataStoreControlName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONTROL]")
                   .toString())
           .build();
   controlServiceClient.deleteControl(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteControlCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteControlRequest,com.google.protobuf.Empty> deleteControlCallable()

Deletes a Control.

If the [Control][google.cloud.discoveryengine.v1.Control] to delete does not exist, a NOT_FOUND error is returned.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   DeleteControlRequest request =
       DeleteControlRequest.newBuilder()
           .setName(
               ControlName.ofProjectLocationDataStoreControlName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONTROL]")
                   .toString())
           .build();
   ApiFuture<Empty> future = controlServiceClient.deleteControlCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

updateControl

public final Control updateControl(Control control,
                                   com.google.protobuf.FieldMask updateMask)

Updates a Control.

[Control][google.cloud.discoveryengine.v1.Control] action type cannot be changed. If the [Control][google.cloud.discoveryengine.v1.Control] to update does not exist, a NOT_FOUND error is returned.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   Control control = Control.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Control response = controlServiceClient.updateControl(control, updateMask);
 }
 

Parameters:

control - Required. The Control to update.

updateMask - Optional. Indicates which fields in the provided [Control][google.cloud.discoveryengine.v1.Control] to update. The following are NOT supported:

• [Control.name][google.cloud.discoveryengine.v1.Control.name]
• [Control.solution_type][google.cloud.discoveryengine.v1.Control.solution_type]

If not set or empty, all supported fields are updated.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateControl

public final Control updateControl(UpdateControlRequest request)

Updates a Control.

[Control][google.cloud.discoveryengine.v1.Control] action type cannot be changed. If the [Control][google.cloud.discoveryengine.v1.Control] to update does not exist, a NOT_FOUND error is returned.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   UpdateControlRequest request =
       UpdateControlRequest.newBuilder()
           .setControl(Control.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Control response = controlServiceClient.updateControl(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateControlCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateControlRequest,Control> updateControlCallable()

Updates a Control.

[Control][google.cloud.discoveryengine.v1.Control] action type cannot be changed. If the [Control][google.cloud.discoveryengine.v1.Control] to update does not exist, a NOT_FOUND error is returned.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   UpdateControlRequest request =
       UpdateControlRequest.newBuilder()
           .setControl(Control.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Control> future = controlServiceClient.updateControlCallable().futureCall(request);
   // Do something.
   Control response = future.get();
 }
 

getControl

public final Control getControl(ControlName name)

Gets a Control.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   ControlName name =
       ControlName.ofProjectLocationDataStoreControlName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONTROL]");
   Control response = controlServiceClient.getControl(name);
 }
 

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}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getControl

public final Control getControl(String name)

Gets a Control.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   String name =
       ControlName.ofProjectLocationDataStoreControlName(
               "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONTROL]")
           .toString();
   Control response = controlServiceClient.getControl(name);
 }
 

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}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getControl

public final Control getControl(GetControlRequest request)

Gets a Control.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   GetControlRequest request =
       GetControlRequest.newBuilder()
           .setName(
               ControlName.ofProjectLocationDataStoreControlName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONTROL]")
                   .toString())
           .build();
   Control response = controlServiceClient.getControl(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getControlCallable

public final com.google.api.gax.rpc.UnaryCallable<GetControlRequest,Control> getControlCallable()

Gets a Control.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   GetControlRequest request =
       GetControlRequest.newBuilder()
           .setName(
               ControlName.ofProjectLocationDataStoreControlName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONTROL]")
                   .toString())
           .build();
   ApiFuture<Control> future = controlServiceClient.getControlCallable().futureCall(request);
   // Do something.
   Control response = future.get();
 }
 

listControls

public final ControlServiceClient.ListControlsPagedResponse listControls(DataStoreName parent)

Lists all Controls by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   DataStoreName parent =
       DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]");
   for (Control element : controlServiceClient.listControls(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listControls

public final ControlServiceClient.ListControlsPagedResponse listControls(EngineName parent)

Lists all Controls by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   EngineName parent = EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]");
   for (Control element : controlServiceClient.listControls(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listControls

public final ControlServiceClient.ListControlsPagedResponse listControls(String parent)

Lists all Controls by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   String parent =
       DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]")
           .toString();
   for (Control element : controlServiceClient.listControls(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listControls

public final ControlServiceClient.ListControlsPagedResponse listControls(ListControlsRequest request)

Lists all Controls by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   ListControlsRequest request =
       ListControlsRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (Control element : controlServiceClient.listControls(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listControlsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListControlsRequest,ControlServiceClient.ListControlsPagedResponse> listControlsPagedCallable()

Lists all Controls by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   ListControlsRequest request =
       ListControlsRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<Control> future =
       controlServiceClient.listControlsPagedCallable().futureCall(request);
   // Do something.
   for (Control element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listControlsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListControlsRequest,ListControlsResponse> listControlsCallable()

Lists all Controls by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
   ListControlsRequest request =
       ListControlsRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListControlsResponse response = controlServiceClient.listControlsCallable().call(request);
     for (Control element : response.getControlsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException