Class ControlServiceClient (0.51.0)

GitHub RepositoryProduct Reference

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 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 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 action type cannot be changed. If the 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.

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.

Inheritance

java.lang.Object > ControlServiceClient

Static Methods

create()

public static final ControlServiceClient create()

Constructs an instance of ControlServiceClient with default settings.

Returns
Type Description
ControlServiceClient
Exceptions
Type Description
IOException

create(ControlServiceSettings settings)

public static final ControlServiceClient create(ControlServiceSettings settings)

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.

Parameter
Name Description
settings ControlServiceSettings
Returns
Type Description
ControlServiceClient
Exceptions
Type Description
IOException

create(ControlServiceStub stub)

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).

Parameter
Name Description
stub ControlServiceStub
Returns
Type Description
ControlServiceClient

Constructors

ControlServiceClient(ControlServiceSettings settings)

protected ControlServiceClient(ControlServiceSettings settings)

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.

Parameter
Name Description
settings ControlServiceSettings

ControlServiceClient(ControlServiceStub stub)

protected ControlServiceClient(ControlServiceStub stub)
Parameter
Name Description
stub ControlServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createControl(CreateControlRequest request)

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 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);
 }
Parameter
Name Description
request CreateControlRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Control

createControl(DataStoreName parent, Control control, String controlId)

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 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
Name Description
parent DataStoreName

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 Control

Required. The Control to create.
controlId String

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-_/.
Returns
Type Description
Control

createControl(EngineName parent, Control control, String controlId)

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 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
Name Description
parent EngineName

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 Control

Required. The Control to create.
controlId String

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-_/.
Returns
Type Description
Control

createControl(String parent, Control control, String controlId)

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 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
Name Description
parent String

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 Control

Required. The Control to create.
controlId String

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-_/.
Returns
Type Description
Control

createControlCallable()

public final 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 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();
 }
Returns
Type Description
UnaryCallable<CreateControlRequest,Control>

deleteControl(ControlName name)

public final void deleteControl(ControlName name)

Deletes a Control.

If the 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);
 }
Parameter
Name Description
name ControlName

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

deleteControl(DeleteControlRequest request)

public final void deleteControl(DeleteControlRequest request)

Deletes a Control.

If the 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);
 }
Parameter
Name Description
request DeleteControlRequest

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

deleteControl(String name)

public final void deleteControl(String name)

Deletes a Control.

If the 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);
 }
Parameter
Name Description
name String

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

deleteControlCallable()

public final UnaryCallable<DeleteControlRequest,Empty> deleteControlCallable()

Deletes a Control.

If the 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();
 }
Returns
Type Description
UnaryCallable<DeleteControlRequest,Empty>

getControl(ControlName name)

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);
 }
Parameter
Name Description
name ControlName

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
Type Description
Control

getControl(GetControlRequest request)

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);
 }
Parameter
Name Description
request GetControlRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Control

getControl(String name)

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);
 }
Parameter
Name Description
name String

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
Type Description
Control

getControlCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<GetControlRequest,Control>

getSettings()

public final ControlServiceSettings getSettings()
Returns
Type Description
ControlServiceSettings

getStub()

public ControlServiceStub getStub()
Returns
Type Description
ControlServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listControls(DataStoreName parent)

public final ControlServiceClient.ListControlsPagedResponse listControls(DataStoreName parent)

Lists all Controls by their parent 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);
   }
 }
Parameter
Name Description
parent DataStoreName

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}.
Returns
Type Description
ControlServiceClient.ListControlsPagedResponse

listControls(EngineName parent)

public final ControlServiceClient.ListControlsPagedResponse listControls(EngineName parent)

Lists all Controls by their parent 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);
   }
 }
Parameter
Name Description
parent EngineName

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}.
Returns
Type Description
ControlServiceClient.ListControlsPagedResponse

listControls(ListControlsRequest request)

public final ControlServiceClient.ListControlsPagedResponse listControls(ListControlsRequest request)

Lists all Controls by their parent 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);
   }
 }
Parameter
Name Description
request ListControlsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ControlServiceClient.ListControlsPagedResponse

listControls(String parent)

public final ControlServiceClient.ListControlsPagedResponse listControls(String parent)

Lists all Controls by their parent 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);
   }
 }
Parameter
Name Description
parent String

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}.
Returns
Type Description
ControlServiceClient.ListControlsPagedResponse

listControlsCallable()

public final UnaryCallable<ListControlsRequest,ListControlsResponse> listControlsCallable()

Lists all Controls by their parent 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;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListControlsRequest,ListControlsResponse>

listControlsPagedCallable()

public final UnaryCallable<ListControlsRequest,ControlServiceClient.ListControlsPagedResponse> listControlsPagedCallable()

Lists all Controls by their parent 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);
   }
 }
Returns
Type Description
UnaryCallable<ListControlsRequest,ListControlsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateControl(Control control, FieldMask updateMask)

public final Control updateControl(Control control, FieldMask updateMask)

Updates a Control.

Control action type cannot be changed. If the 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
Name Description
control Control

Required. The Control to update.
updateMask FieldMask

Optional. Indicates which fields in the provided Control to update. The following are NOT supported:

  • Control.name
  • Control.solution_type

If not set or empty, all supported fields are updated.
Returns
Type Description
Control

updateControl(UpdateControlRequest request)

public final Control updateControl(UpdateControlRequest request)

Updates a Control.

Control action type cannot be changed. If the 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);
 }
Parameter
Name Description
request UpdateControlRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Control

updateControlCallable()

public final UnaryCallable<UpdateControlRequest,Control> updateControlCallable()

Updates a Control.

Control action type cannot be changed. If the 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();
 }
Returns
Type Description
UnaryCallable<UpdateControlRequest,Control>