Class RuleSetServiceClient (0.45.0)

GitHub RepositoryProduct Reference

Service Description: Service to manage customer specific RuleSets.

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 (RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   RuleSet ruleSet = RuleSet.newBuilder().build();
   RuleSet response = ruleSetServiceClient.createRuleSet(parent, ruleSet);
 }

Note: close() needs to be called on the RuleSetServiceClient 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

CreateRuleSet

Creates a ruleset.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createRuleSet(CreateRuleSetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createRuleSet(LocationName parent, RuleSet ruleSet)

  • createRuleSet(String parent, RuleSet ruleSet)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createRuleSetCallable()

GetRuleSet

Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getRuleSet(GetRuleSetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getRuleSet(RuleSetName name)

  • getRuleSet(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.

  • getRuleSetCallable()

UpdateRuleSet

Updates a ruleset. Returns INVALID_ARGUMENT if the name of the ruleset is non-empty and does not equal the existing name.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateRuleSet(UpdateRuleSetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateRuleSet(RuleSetName name, RuleSet ruleSet)

  • updateRuleSet(String name, RuleSet ruleSet)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateRuleSetCallable()

DeleteRuleSet

Deletes a ruleset. Returns NOT_FOUND if the document does not exist.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteRuleSet(DeleteRuleSetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteRuleSet(RuleSetName name)

  • deleteRuleSet(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.

  • deleteRuleSetCallable()

ListRuleSets

Lists rulesets.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listRuleSets(ListRuleSetsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listRuleSets(LocationName parent)

  • listRuleSets(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.

  • listRuleSetsPagedCallable()

  • listRuleSetsCallable()

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 RuleSetServiceSettings 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
 RuleSetServiceSettings ruleSetServiceSettings =
     RuleSetServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create(ruleSetServiceSettings);

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
 RuleSetServiceSettings ruleSetServiceSettings =
     RuleSetServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create(ruleSetServiceSettings);

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
 RuleSetServiceSettings ruleSetServiceSettings =
     RuleSetServiceSettings.newHttpJsonBuilder().build();
 RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create(ruleSetServiceSettings);

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

Inheritance

java.lang.Object > RuleSetServiceClient

Static Methods

create()

public static final RuleSetServiceClient create()

Constructs an instance of RuleSetServiceClient with default settings.

Returns
Type Description
RuleSetServiceClient
Exceptions
Type Description
IOException

create(RuleSetServiceSettings settings)

public static final RuleSetServiceClient create(RuleSetServiceSettings settings)

Constructs an instance of RuleSetServiceClient, 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 RuleSetServiceSettings
Returns
Type Description
RuleSetServiceClient
Exceptions
Type Description
IOException

create(RuleSetServiceStub stub)

public static final RuleSetServiceClient create(RuleSetServiceStub stub)

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

Parameter
Name Description
stub RuleSetServiceStub
Returns
Type Description
RuleSetServiceClient

Constructors

RuleSetServiceClient(RuleSetServiceSettings settings)

protected RuleSetServiceClient(RuleSetServiceSettings settings)

Constructs an instance of RuleSetServiceClient, 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 RuleSetServiceSettings

RuleSetServiceClient(RuleSetServiceStub stub)

protected RuleSetServiceClient(RuleSetServiceStub stub)
Parameter
Name Description
stub RuleSetServiceStub

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

createRuleSet(CreateRuleSetRequest request)

public final RuleSet createRuleSet(CreateRuleSetRequest request)

Creates a ruleset.

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 (RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create()) {
   CreateRuleSetRequest request =
       CreateRuleSetRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRuleSet(RuleSet.newBuilder().build())
           .build();
   RuleSet response = ruleSetServiceClient.createRuleSet(request);
 }
Parameter
Name Description
request CreateRuleSetRequest

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

createRuleSet(LocationName parent, RuleSet ruleSet)

public final RuleSet createRuleSet(LocationName parent, RuleSet ruleSet)

Creates a ruleset.

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 (RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   RuleSet ruleSet = RuleSet.newBuilder().build();
   RuleSet response = ruleSetServiceClient.createRuleSet(parent, ruleSet);
 }
Parameters
Name Description
parent LocationName

Required. The parent name. Format: projects/{project_number}/locations/{location}.
ruleSet RuleSet

Required. The rule set to create.
Returns
Type Description
RuleSet

createRuleSet(String parent, RuleSet ruleSet)

public final RuleSet createRuleSet(String parent, RuleSet ruleSet)

Creates a ruleset.

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 (RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   RuleSet ruleSet = RuleSet.newBuilder().build();
   RuleSet response = ruleSetServiceClient.createRuleSet(parent, ruleSet);
 }
Parameters
Name Description
parent String

Required. The parent name. Format: projects/{project_number}/locations/{location}.
ruleSet RuleSet

Required. The rule set to create.
Returns
Type Description
RuleSet

createRuleSetCallable()

public final UnaryCallable<CreateRuleSetRequest,RuleSet> createRuleSetCallable()

Creates a ruleset.

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 (RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create()) {
   CreateRuleSetRequest request =
       CreateRuleSetRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRuleSet(RuleSet.newBuilder().build())
           .build();
   ApiFuture<RuleSet> future = ruleSetServiceClient.createRuleSetCallable().futureCall(request);
   // Do something.
   RuleSet response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateRuleSetRequest,RuleSet>

deleteRuleSet(DeleteRuleSetRequest request)

public final void deleteRuleSet(DeleteRuleSetRequest request)

Deletes a ruleset. Returns NOT_FOUND if the document does not exist.

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 (RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create()) {
   DeleteRuleSetRequest request =
       DeleteRuleSetRequest.newBuilder()
           .setName(RuleSetName.of("[PROJECT]", "[LOCATION]", "[RULE_SET]").toString())
           .build();
   ruleSetServiceClient.deleteRuleSet(request);
 }
Parameter
Name Description
request DeleteRuleSetRequest

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

deleteRuleSet(RuleSetName name)

public final void deleteRuleSet(RuleSetName name)

Deletes a ruleset. Returns NOT_FOUND if the document does not exist.

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 (RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create()) {
   RuleSetName name = RuleSetName.of("[PROJECT]", "[LOCATION]", "[RULE_SET]");
   ruleSetServiceClient.deleteRuleSet(name);
 }
Parameter
Name Description
name RuleSetName

Required. The name of the rule set to delete. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.

deleteRuleSet(String name)

public final void deleteRuleSet(String name)

Deletes a ruleset. Returns NOT_FOUND if the document does not exist.

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 (RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create()) {
   String name = RuleSetName.of("[PROJECT]", "[LOCATION]", "[RULE_SET]").toString();
   ruleSetServiceClient.deleteRuleSet(name);
 }
Parameter
Name Description
name String

Required. The name of the rule set to delete. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.

deleteRuleSetCallable()

public final UnaryCallable<DeleteRuleSetRequest,Empty> deleteRuleSetCallable()

Deletes a ruleset. Returns NOT_FOUND if the document does not exist.

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 (RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create()) {
   DeleteRuleSetRequest request =
       DeleteRuleSetRequest.newBuilder()
           .setName(RuleSetName.of("[PROJECT]", "[LOCATION]", "[RULE_SET]").toString())
           .build();
   ApiFuture<Empty> future = ruleSetServiceClient.deleteRuleSetCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteRuleSetRequest,Empty>

getRuleSet(GetRuleSetRequest request)

public final RuleSet getRuleSet(GetRuleSetRequest request)

Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist.

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 (RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create()) {
   GetRuleSetRequest request =
       GetRuleSetRequest.newBuilder()
           .setName(RuleSetName.of("[PROJECT]", "[LOCATION]", "[RULE_SET]").toString())
           .build();
   RuleSet response = ruleSetServiceClient.getRuleSet(request);
 }
Parameter
Name Description
request GetRuleSetRequest

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

getRuleSet(RuleSetName name)

public final RuleSet getRuleSet(RuleSetName name)

Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist.

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 (RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create()) {
   RuleSetName name = RuleSetName.of("[PROJECT]", "[LOCATION]", "[RULE_SET]");
   RuleSet response = ruleSetServiceClient.getRuleSet(name);
 }
Parameter
Name Description
name RuleSetName

Required. The name of the rule set to retrieve. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.
Returns
Type Description
RuleSet

getRuleSet(String name)

public final RuleSet getRuleSet(String name)

Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist.

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 (RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create()) {
   String name = RuleSetName.of("[PROJECT]", "[LOCATION]", "[RULE_SET]").toString();
   RuleSet response = ruleSetServiceClient.getRuleSet(name);
 }
Parameter
Name Description
name String

Required. The name of the rule set to retrieve. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.
Returns
Type Description
RuleSet

getRuleSetCallable()

public final UnaryCallable<GetRuleSetRequest,RuleSet> getRuleSetCallable()

Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist.

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 (RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create()) {
   GetRuleSetRequest request =
       GetRuleSetRequest.newBuilder()
           .setName(RuleSetName.of("[PROJECT]", "[LOCATION]", "[RULE_SET]").toString())
           .build();
   ApiFuture<RuleSet> future = ruleSetServiceClient.getRuleSetCallable().futureCall(request);
   // Do something.
   RuleSet response = future.get();
 }
Returns
Type Description
UnaryCallable<GetRuleSetRequest,RuleSet>

getSettings()

public final RuleSetServiceSettings getSettings()
Returns
Type Description
RuleSetServiceSettings

getStub()

public RuleSetServiceStub getStub()
Returns
Type Description
RuleSetServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listRuleSets(ListRuleSetsRequest request)

public final RuleSetServiceClient.ListRuleSetsPagedResponse listRuleSets(ListRuleSetsRequest request)

Lists rulesets.

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 (RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create()) {
   ListRuleSetsRequest request =
       ListRuleSetsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (RuleSet element : ruleSetServiceClient.listRuleSets(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListRuleSetsRequest

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

listRuleSets(LocationName parent)

public final RuleSetServiceClient.ListRuleSetsPagedResponse listRuleSets(LocationName parent)

Lists rulesets.

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 (RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (RuleSet element : ruleSetServiceClient.listRuleSets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. The parent, which owns this collection of document. Format: projects/{project_number}/locations/{location}.
Returns
Type Description
RuleSetServiceClient.ListRuleSetsPagedResponse

listRuleSets(String parent)

public final RuleSetServiceClient.ListRuleSetsPagedResponse listRuleSets(String parent)

Lists rulesets.

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 (RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (RuleSet element : ruleSetServiceClient.listRuleSets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The parent, which owns this collection of document. Format: projects/{project_number}/locations/{location}.
Returns
Type Description
RuleSetServiceClient.ListRuleSetsPagedResponse

listRuleSetsCallable()

public final UnaryCallable<ListRuleSetsRequest,ListRuleSetsResponse> listRuleSetsCallable()

Lists rulesets.

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 (RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create()) {
   ListRuleSetsRequest request =
       ListRuleSetsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListRuleSetsResponse response = ruleSetServiceClient.listRuleSetsCallable().call(request);
     for (RuleSet element : response.getRuleSetsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListRuleSetsRequest,ListRuleSetsResponse>

listRuleSetsPagedCallable()

public final UnaryCallable<ListRuleSetsRequest,RuleSetServiceClient.ListRuleSetsPagedResponse> listRuleSetsPagedCallable()

Lists rulesets.

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 (RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create()) {
   ListRuleSetsRequest request =
       ListRuleSetsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<RuleSet> future =
       ruleSetServiceClient.listRuleSetsPagedCallable().futureCall(request);
   // Do something.
   for (RuleSet element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListRuleSetsRequest,ListRuleSetsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateRuleSet(RuleSetName name, RuleSet ruleSet)

public final RuleSet updateRuleSet(RuleSetName name, RuleSet ruleSet)

Updates a ruleset. Returns INVALID_ARGUMENT if the name of the ruleset is non-empty and does not equal the existing name.

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 (RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create()) {
   RuleSetName name = RuleSetName.of("[PROJECT]", "[LOCATION]", "[RULE_SET]");
   RuleSet ruleSet = RuleSet.newBuilder().build();
   RuleSet response = ruleSetServiceClient.updateRuleSet(name, ruleSet);
 }
Parameters
Name Description
name RuleSetName

Required. The name of the rule set to update. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.
ruleSet RuleSet

Required. The rule set to update.
Returns
Type Description
RuleSet

updateRuleSet(UpdateRuleSetRequest request)

public final RuleSet updateRuleSet(UpdateRuleSetRequest request)

Updates a ruleset. Returns INVALID_ARGUMENT if the name of the ruleset is non-empty and does not equal the existing name.

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 (RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create()) {
   UpdateRuleSetRequest request =
       UpdateRuleSetRequest.newBuilder()
           .setName(RuleSetName.of("[PROJECT]", "[LOCATION]", "[RULE_SET]").toString())
           .setRuleSet(RuleSet.newBuilder().build())
           .build();
   RuleSet response = ruleSetServiceClient.updateRuleSet(request);
 }
Parameter
Name Description
request UpdateRuleSetRequest

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

updateRuleSet(String name, RuleSet ruleSet)

public final RuleSet updateRuleSet(String name, RuleSet ruleSet)

Updates a ruleset. Returns INVALID_ARGUMENT if the name of the ruleset is non-empty and does not equal the existing name.

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 (RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create()) {
   String name = RuleSetName.of("[PROJECT]", "[LOCATION]", "[RULE_SET]").toString();
   RuleSet ruleSet = RuleSet.newBuilder().build();
   RuleSet response = ruleSetServiceClient.updateRuleSet(name, ruleSet);
 }
Parameters
Name Description
name String

Required. The name of the rule set to update. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.
ruleSet RuleSet

Required. The rule set to update.
Returns
Type Description
RuleSet

updateRuleSetCallable()

public final UnaryCallable<UpdateRuleSetRequest,RuleSet> updateRuleSetCallable()

Updates a ruleset. Returns INVALID_ARGUMENT if the name of the ruleset is non-empty and does not equal the existing name.

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 (RuleSetServiceClient ruleSetServiceClient = RuleSetServiceClient.create()) {
   UpdateRuleSetRequest request =
       UpdateRuleSetRequest.newBuilder()
           .setName(RuleSetName.of("[PROJECT]", "[LOCATION]", "[RULE_SET]").toString())
           .setRuleSet(RuleSet.newBuilder().build())
           .build();
   ApiFuture<RuleSet> future = ruleSetServiceClient.updateRuleSetCallable().futureCall(request);
   // Do something.
   RuleSet response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateRuleSetRequest,RuleSet>