Class ManagedRulesetsClient (1.109.0)

GitHub RepositoryProduct Reference

Service Description: The ManagedRulesets API.

This client uses ManagedRulesets version 2026-09-01.

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 (ManagedRulesetsClient managedRulesetsClient = ManagedRulesetsClient.create()) {
   String project = "project-309310695";
   String managedRuleset = "managedRuleset1612348231";
   ManagedRuleset response = managedRulesetsClient.get(project, managedRuleset);
 }

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

Get

Gets the details for the specified managed ruleset name.

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

  • get(GetManagedRulesetRequest request)

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

  • get(String project, String managedRuleset)

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

  • getCallable()

List

Retrieves the list of all the managed rulesets available.

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

  • list(ListManagedRulesetsRequest request)

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

  • list(String project)

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

  • listPagedCallable()

  • listCallable()

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 ManagedRulesetsSettings 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
 ManagedRulesetsSettings managedRulesetsSettings =
     ManagedRulesetsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ManagedRulesetsClient managedRulesetsClient =
     ManagedRulesetsClient.create(managedRulesetsSettings);

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
 ManagedRulesetsSettings managedRulesetsSettings =
     ManagedRulesetsSettings.newBuilder().setEndpoint(myEndpoint).build();
 ManagedRulesetsClient managedRulesetsClient =
     ManagedRulesetsClient.create(managedRulesetsSettings);

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

Inheritance

java.lang.Object > ManagedRulesetsClient

Static Methods

create()

public static final ManagedRulesetsClient create()

Constructs an instance of ManagedRulesetsClient with default settings.

Returns
Type Description
ManagedRulesetsClient
Exceptions
Type Description
IOException

create(ManagedRulesetsSettings settings)

public static final ManagedRulesetsClient create(ManagedRulesetsSettings settings)

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

create(ManagedRulesetsStub stub)

public static final ManagedRulesetsClient create(ManagedRulesetsStub stub)

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

Parameter
Name Description
stub ManagedRulesetsStub
Returns
Type Description
ManagedRulesetsClient

Constructors

ManagedRulesetsClient(ManagedRulesetsSettings settings)

protected ManagedRulesetsClient(ManagedRulesetsSettings settings)

Constructs an instance of ManagedRulesetsClient, 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 ManagedRulesetsSettings

ManagedRulesetsClient(ManagedRulesetsStub stub)

protected ManagedRulesetsClient(ManagedRulesetsStub stub)
Parameter
Name Description
stub ManagedRulesetsStub

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

get(GetManagedRulesetRequest request)

public final ManagedRuleset get(GetManagedRulesetRequest request)

Gets the details for the specified managed ruleset 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 (ManagedRulesetsClient managedRulesetsClient = ManagedRulesetsClient.create()) {
   GetManagedRulesetRequest request =
       GetManagedRulesetRequest.newBuilder()
           .setManagedRuleset("managedRuleset1612348231")
           .setProject("project-309310695")
           .build();
   ManagedRuleset response = managedRulesetsClient.get(request);
 }
Parameter
Name Description
request GetManagedRulesetRequest

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

get(String project, String managedRuleset)

public final ManagedRuleset get(String project, String managedRuleset)

Gets the details for the specified managed ruleset 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 (ManagedRulesetsClient managedRulesetsClient = ManagedRulesetsClient.create()) {
   String project = "project-309310695";
   String managedRuleset = "managedRuleset1612348231";
   ManagedRuleset response = managedRulesetsClient.get(project, managedRuleset);
 }
Parameters
Name Description
project String

Project ID for this request.
managedRuleset String

Name of the managed ruleset to return.
Returns
Type Description
ManagedRuleset

getCallable()

public final UnaryCallable<GetManagedRulesetRequest,ManagedRuleset> getCallable()

Gets the details for the specified managed ruleset 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 (ManagedRulesetsClient managedRulesetsClient = ManagedRulesetsClient.create()) {
   GetManagedRulesetRequest request =
       GetManagedRulesetRequest.newBuilder()
           .setManagedRuleset("managedRuleset1612348231")
           .setProject("project-309310695")
           .build();
   ApiFuture<ManagedRuleset> future = managedRulesetsClient.getCallable().futureCall(request);
   // Do something.
   ManagedRuleset response = future.get();
 }
Returns
Type Description
UnaryCallable<GetManagedRulesetRequest,ManagedRuleset>

getSettings()

public final @Nullable ManagedRulesetsSettings getSettings()
Returns
Type Description
@org.jspecify.annotations.Nullable com.google.cloud.compute.v1.ManagedRulesetsSettings

getStub()

public ManagedRulesetsStub getStub()
Returns
Type Description
ManagedRulesetsStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

list(ListManagedRulesetsRequest request)

public final ManagedRulesetsClient.ListPagedResponse list(ListManagedRulesetsRequest request)

Retrieves the list of all the managed rulesets available.

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 (ManagedRulesetsClient managedRulesetsClient = ManagedRulesetsClient.create()) {
   ListManagedRulesetsRequest request =
       ListManagedRulesetsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .build();
   for (ManagedRuleset element : managedRulesetsClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListManagedRulesetsRequest

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

list(String project)

public final ManagedRulesetsClient.ListPagedResponse list(String project)

Retrieves the list of all the managed rulesets available.

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 (ManagedRulesetsClient managedRulesetsClient = ManagedRulesetsClient.create()) {
   String project = "project-309310695";
   for (ManagedRuleset element : managedRulesetsClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
project String

Project ID for this request.
Returns
Type Description
ManagedRulesetsClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListManagedRulesetsRequest,ManagedRulesetList> listCallable()

Retrieves the list of all the managed rulesets available.

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 (ManagedRulesetsClient managedRulesetsClient = ManagedRulesetsClient.create()) {
   ListManagedRulesetsRequest request =
       ListManagedRulesetsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .build();
   while (true) {
     ManagedRulesetList response = managedRulesetsClient.listCallable().call(request);
     for (ManagedRuleset element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListManagedRulesetsRequest,ManagedRulesetList>

listPagedCallable()

public final UnaryCallable<ListManagedRulesetsRequest,ManagedRulesetsClient.ListPagedResponse> listPagedCallable()

Retrieves the list of all the managed rulesets available.

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 (ManagedRulesetsClient managedRulesetsClient = ManagedRulesetsClient.create()) {
   ListManagedRulesetsRequest request =
       ListManagedRulesetsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .build();
   ApiFuture<ManagedRuleset> future =
       managedRulesetsClient.listPagedCallable().futureCall(request);
   // Do something.
   for (ManagedRuleset element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListManagedRulesetsRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()