Class RuleSetServiceClient
- java.lang.Object
-
- com.google.cloud.contentwarehouse.v1.RuleSetServiceClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class RuleSetServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
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().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RuleSetServiceClient.ListRuleSetsFixedSizeCollection
static class
RuleSetServiceClient.ListRuleSetsPage
static class
RuleSetServiceClient.ListRuleSetsPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
RuleSetServiceClient(RuleSetServiceSettings settings)
Constructs an instance of RuleSetServiceClient, using the given settings.protected
RuleSetServiceClient(RuleSetServiceStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static RuleSetServiceClient
create()
Constructs an instance of RuleSetServiceClient with default settings.static RuleSetServiceClient
create(RuleSetServiceSettings settings)
Constructs an instance of RuleSetServiceClient, using the given settings.static RuleSetServiceClient
create(RuleSetServiceStub stub)
Constructs an instance of RuleSetServiceClient, using the given stub for making calls.RuleSet
createRuleSet(CreateRuleSetRequest request)
Creates a ruleset.RuleSet
createRuleSet(LocationName parent, RuleSet ruleSet)
Creates a ruleset.RuleSet
createRuleSet(String parent, RuleSet ruleSet)
Creates a ruleset.com.google.api.gax.rpc.UnaryCallable<CreateRuleSetRequest,RuleSet>
createRuleSetCallable()
Creates a ruleset.void
deleteRuleSet(DeleteRuleSetRequest request)
Deletes a ruleset.void
deleteRuleSet(RuleSetName name)
Deletes a ruleset.void
deleteRuleSet(String name)
Deletes a ruleset.com.google.api.gax.rpc.UnaryCallable<DeleteRuleSetRequest,com.google.protobuf.Empty>
deleteRuleSetCallable()
Deletes a ruleset.RuleSet
getRuleSet(GetRuleSetRequest request)
Gets a ruleset.RuleSet
getRuleSet(RuleSetName name)
Gets a ruleset.RuleSet
getRuleSet(String name)
Gets a ruleset.com.google.api.gax.rpc.UnaryCallable<GetRuleSetRequest,RuleSet>
getRuleSetCallable()
Gets a ruleset.RuleSetServiceSettings
getSettings()
RuleSetServiceStub
getStub()
boolean
isShutdown()
boolean
isTerminated()
RuleSetServiceClient.ListRuleSetsPagedResponse
listRuleSets(ListRuleSetsRequest request)
Lists rulesets.RuleSetServiceClient.ListRuleSetsPagedResponse
listRuleSets(LocationName parent)
Lists rulesets.RuleSetServiceClient.ListRuleSetsPagedResponse
listRuleSets(String parent)
Lists rulesets.com.google.api.gax.rpc.UnaryCallable<ListRuleSetsRequest,ListRuleSetsResponse>
listRuleSetsCallable()
Lists rulesets.com.google.api.gax.rpc.UnaryCallable<ListRuleSetsRequest,RuleSetServiceClient.ListRuleSetsPagedResponse>
listRuleSetsPagedCallable()
Lists rulesets.void
shutdown()
void
shutdownNow()
RuleSet
updateRuleSet(RuleSetName name, RuleSet ruleSet)
Updates a ruleset.RuleSet
updateRuleSet(UpdateRuleSetRequest request)
Updates a ruleset.RuleSet
updateRuleSet(String name, RuleSet ruleSet)
Updates a ruleset.com.google.api.gax.rpc.UnaryCallable<UpdateRuleSetRequest,RuleSet>
updateRuleSetCallable()
Updates a ruleset.
-
-
-
Constructor Detail
-
RuleSetServiceClient
protected RuleSetServiceClient(RuleSetServiceSettings settings) throws IOException
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.- Throws:
IOException
-
RuleSetServiceClient
protected RuleSetServiceClient(RuleSetServiceStub stub)
-
-
Method Detail
-
create
public static final RuleSetServiceClient create() throws IOException
Constructs an instance of RuleSetServiceClient with default settings.- Throws:
IOException
-
create
public static final RuleSetServiceClient create(RuleSetServiceSettings settings) throws IOException
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.- Throws:
IOException
-
create
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).
-
getSettings
public final RuleSetServiceSettings getSettings()
-
getStub
public RuleSetServiceStub getStub()
-
createRuleSet
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:
parent
- Required. The parent name. Format: projects/{project_number}/locations/{location}.ruleSet
- Required. The rule set to create.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createRuleSet
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:
parent
- Required. The parent name. Format: projects/{project_number}/locations/{location}.ruleSet
- Required. The rule set to create.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createRuleSet
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); }
- 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
-
createRuleSetCallable
public final com.google.api.gax.rpc.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(); }
-
getRuleSet
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); }
- Parameters:
name
- Required. The name of the rule set to retrieve. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getRuleSet
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); }
- Parameters:
name
- Required. The name of the rule set to retrieve. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getRuleSet
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); }
- 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
-
getRuleSetCallable
public final com.google.api.gax.rpc.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(); }
-
updateRuleSet
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
- Required. The name of the rule set to update. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.ruleSet
- Required. The rule set to update.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateRuleSet
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
- Required. The name of the rule set to update. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.ruleSet
- Required. The rule set to update.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateRuleSet
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); }
- 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
-
updateRuleSetCallable
public final com.google.api.gax.rpc.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(); }
-
deleteRuleSet
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); }
- Parameters:
name
- Required. The name of the rule set to delete. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteRuleSet
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); }
- Parameters:
name
- Required. The name of the rule set to delete. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteRuleSet
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); }
- 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
-
deleteRuleSetCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteRuleSetRequest,com.google.protobuf.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(); }
-
listRuleSets
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); } }
- Parameters:
parent
- Required. The parent, which owns this collection of document. Format: projects/{project_number}/locations/{location}.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listRuleSets
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); } }
- Parameters:
parent
- Required. The parent, which owns this collection of document. Format: projects/{project_number}/locations/{location}.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listRuleSets
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); } }
- 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
-
listRuleSetsPagedCallable
public final com.google.api.gax.rpc.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); } }
-
listRuleSetsCallable
public final com.google.api.gax.rpc.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; } } }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-