Class WebRiskServiceV1Beta1Client (2.45.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

Service Description: Web Risk v1beta1 API defines an interface to detect malicious URLs on your website and in client applications.

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 (WebRiskServiceV1Beta1Client webRiskServiceV1Beta1Client =
     WebRiskServiceV1Beta1Client.create()) {
   ThreatType threatType = ThreatType.forNumber(0);
   ByteString versionToken = ByteString.EMPTY;
   ComputeThreatListDiffRequest.Constraints constraints =
       ComputeThreatListDiffRequest.Constraints.newBuilder().build();
   ComputeThreatListDiffResponse response =
       webRiskServiceV1Beta1Client.computeThreatListDiff(threatType, versionToken, constraints);
 }

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

ComputeThreatListDiff

Gets the most recent threat list diffs.

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

  • computeThreatListDiff(ComputeThreatListDiffRequest request)

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

  • computeThreatListDiff(ThreatType threatType, ByteString versionToken, ComputeThreatListDiffRequest.Constraints constraints)

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

  • computeThreatListDiffCallable()

SearchUris

This method is used to check whether a URI is on a given threatList.

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

  • searchUris(SearchUrisRequest request)

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

  • searchUris(String uri, List<ThreatType> threatTypes)

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

  • searchUrisCallable()

SearchHashes

Gets the full hashes that match the requested hash prefix. This is used after a hash prefix is looked up in a threatList and there is a match. The client side threatList only holds partial hashes so the client must query this method to determine if there is a full hash match of a threat.

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

  • searchHashes(SearchHashesRequest request)

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

  • searchHashes(ByteString hashPrefix, List<ThreatType> threatTypes)

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

  • searchHashesCallable()

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 WebRiskServiceV1Beta1Settings 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
 WebRiskServiceV1Beta1Settings webRiskServiceV1Beta1Settings =
     WebRiskServiceV1Beta1Settings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 WebRiskServiceV1Beta1Client webRiskServiceV1Beta1Client =
     WebRiskServiceV1Beta1Client.create(webRiskServiceV1Beta1Settings);

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
 WebRiskServiceV1Beta1Settings webRiskServiceV1Beta1Settings =
     WebRiskServiceV1Beta1Settings.newBuilder().setEndpoint(myEndpoint).build();
 WebRiskServiceV1Beta1Client webRiskServiceV1Beta1Client =
     WebRiskServiceV1Beta1Client.create(webRiskServiceV1Beta1Settings);

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
 WebRiskServiceV1Beta1Settings webRiskServiceV1Beta1Settings =
     WebRiskServiceV1Beta1Settings.newHttpJsonBuilder().build();
 WebRiskServiceV1Beta1Client webRiskServiceV1Beta1Client =
     WebRiskServiceV1Beta1Client.create(webRiskServiceV1Beta1Settings);

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

Inheritance

java.lang.Object > WebRiskServiceV1Beta1Client

Static Methods

create()

public static final WebRiskServiceV1Beta1Client create()

Constructs an instance of WebRiskServiceV1Beta1Client with default settings.

Returns
Type Description
WebRiskServiceV1Beta1Client
Exceptions
Type Description
IOException

create(WebRiskServiceV1Beta1Settings settings)

public static final WebRiskServiceV1Beta1Client create(WebRiskServiceV1Beta1Settings settings)

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

create(WebRiskServiceV1Beta1Stub stub)

public static final WebRiskServiceV1Beta1Client create(WebRiskServiceV1Beta1Stub stub)

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

Parameter
Name Description
stub WebRiskServiceV1Beta1Stub
Returns
Type Description
WebRiskServiceV1Beta1Client

Constructors

WebRiskServiceV1Beta1Client(WebRiskServiceV1Beta1Settings settings)

protected WebRiskServiceV1Beta1Client(WebRiskServiceV1Beta1Settings settings)

Constructs an instance of WebRiskServiceV1Beta1Client, 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 WebRiskServiceV1Beta1Settings

WebRiskServiceV1Beta1Client(WebRiskServiceV1Beta1Stub stub)

protected WebRiskServiceV1Beta1Client(WebRiskServiceV1Beta1Stub stub)
Parameter
Name Description
stub WebRiskServiceV1Beta1Stub

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

computeThreatListDiff(ComputeThreatListDiffRequest request)

public final ComputeThreatListDiffResponse computeThreatListDiff(ComputeThreatListDiffRequest request)

Gets the most recent threat list diffs.

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 (WebRiskServiceV1Beta1Client webRiskServiceV1Beta1Client =
     WebRiskServiceV1Beta1Client.create()) {
   ComputeThreatListDiffRequest request =
       ComputeThreatListDiffRequest.newBuilder()
           .setThreatType(ThreatType.forNumber(0))
           .setVersionToken(ByteString.EMPTY)
           .setConstraints(ComputeThreatListDiffRequest.Constraints.newBuilder().build())
           .build();
   ComputeThreatListDiffResponse response =
       webRiskServiceV1Beta1Client.computeThreatListDiff(request);
 }
Parameter
Name Description
request ComputeThreatListDiffRequest

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

computeThreatListDiff(ThreatType threatType, ByteString versionToken, ComputeThreatListDiffRequest.Constraints constraints)

public final ComputeThreatListDiffResponse computeThreatListDiff(ThreatType threatType, ByteString versionToken, ComputeThreatListDiffRequest.Constraints constraints)

Gets the most recent threat list diffs.

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 (WebRiskServiceV1Beta1Client webRiskServiceV1Beta1Client =
     WebRiskServiceV1Beta1Client.create()) {
   ThreatType threatType = ThreatType.forNumber(0);
   ByteString versionToken = ByteString.EMPTY;
   ComputeThreatListDiffRequest.Constraints constraints =
       ComputeThreatListDiffRequest.Constraints.newBuilder().build();
   ComputeThreatListDiffResponse response =
       webRiskServiceV1Beta1Client.computeThreatListDiff(threatType, versionToken, constraints);
 }
Parameters
Name Description
threatType ThreatType

The ThreatList to update.
versionToken ByteString

The current version token of the client for the requested list (the client version that was received from the last successful diff).
constraints ComputeThreatListDiffRequest.Constraints

Required. The constraints associated with this request.
Returns
Type Description
ComputeThreatListDiffResponse

computeThreatListDiffCallable()

public final UnaryCallable<ComputeThreatListDiffRequest,ComputeThreatListDiffResponse> computeThreatListDiffCallable()

Gets the most recent threat list diffs.

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 (WebRiskServiceV1Beta1Client webRiskServiceV1Beta1Client =
     WebRiskServiceV1Beta1Client.create()) {
   ComputeThreatListDiffRequest request =
       ComputeThreatListDiffRequest.newBuilder()
           .setThreatType(ThreatType.forNumber(0))
           .setVersionToken(ByteString.EMPTY)
           .setConstraints(ComputeThreatListDiffRequest.Constraints.newBuilder().build())
           .build();
   ApiFuture<ComputeThreatListDiffResponse> future =
       webRiskServiceV1Beta1Client.computeThreatListDiffCallable().futureCall(request);
   // Do something.
   ComputeThreatListDiffResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<ComputeThreatListDiffRequest,ComputeThreatListDiffResponse>

getSettings()

public final WebRiskServiceV1Beta1Settings getSettings()
Returns
Type Description
WebRiskServiceV1Beta1Settings

getStub()

public WebRiskServiceV1Beta1Stub getStub()
Returns
Type Description
WebRiskServiceV1Beta1Stub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

searchHashes(ByteString hashPrefix, List<ThreatType> threatTypes)

public final SearchHashesResponse searchHashes(ByteString hashPrefix, List<ThreatType> threatTypes)

Gets the full hashes that match the requested hash prefix. This is used after a hash prefix is looked up in a threatList and there is a match. The client side threatList only holds partial hashes so the client must query this method to determine if there is a full hash match of a threat.

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 (WebRiskServiceV1Beta1Client webRiskServiceV1Beta1Client =
     WebRiskServiceV1Beta1Client.create()) {
   ByteString hashPrefix = ByteString.EMPTY;
   List<ThreatType> threatTypes = new ArrayList<>();
   SearchHashesResponse response =
       webRiskServiceV1Beta1Client.searchHashes(hashPrefix, threatTypes);
 }
Parameters
Name Description
hashPrefix ByteString

A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. For JSON requests, this field is base64-encoded.
threatTypes List<ThreatType>

Required. The ThreatLists to search in.
Returns
Type Description
SearchHashesResponse

searchHashes(SearchHashesRequest request)

public final SearchHashesResponse searchHashes(SearchHashesRequest request)

Gets the full hashes that match the requested hash prefix. This is used after a hash prefix is looked up in a threatList and there is a match. The client side threatList only holds partial hashes so the client must query this method to determine if there is a full hash match of a threat.

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 (WebRiskServiceV1Beta1Client webRiskServiceV1Beta1Client =
     WebRiskServiceV1Beta1Client.create()) {
   SearchHashesRequest request =
       SearchHashesRequest.newBuilder()
           .setHashPrefix(ByteString.EMPTY)
           .addAllThreatTypes(new ArrayList<ThreatType>())
           .build();
   SearchHashesResponse response = webRiskServiceV1Beta1Client.searchHashes(request);
 }
Parameter
Name Description
request SearchHashesRequest

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

searchHashesCallable()

public final UnaryCallable<SearchHashesRequest,SearchHashesResponse> searchHashesCallable()

Gets the full hashes that match the requested hash prefix. This is used after a hash prefix is looked up in a threatList and there is a match. The client side threatList only holds partial hashes so the client must query this method to determine if there is a full hash match of a threat.

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 (WebRiskServiceV1Beta1Client webRiskServiceV1Beta1Client =
     WebRiskServiceV1Beta1Client.create()) {
   SearchHashesRequest request =
       SearchHashesRequest.newBuilder()
           .setHashPrefix(ByteString.EMPTY)
           .addAllThreatTypes(new ArrayList<ThreatType>())
           .build();
   ApiFuture<SearchHashesResponse> future =
       webRiskServiceV1Beta1Client.searchHashesCallable().futureCall(request);
   // Do something.
   SearchHashesResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<SearchHashesRequest,SearchHashesResponse>

searchUris(SearchUrisRequest request)

public final SearchUrisResponse searchUris(SearchUrisRequest request)

This method is used to check whether a URI is on a given threatList.

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 (WebRiskServiceV1Beta1Client webRiskServiceV1Beta1Client =
     WebRiskServiceV1Beta1Client.create()) {
   SearchUrisRequest request =
       SearchUrisRequest.newBuilder()
           .setUri("uri116076")
           .addAllThreatTypes(new ArrayList<ThreatType>())
           .build();
   SearchUrisResponse response = webRiskServiceV1Beta1Client.searchUris(request);
 }
Parameter
Name Description
request SearchUrisRequest

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

searchUris(String uri, List<ThreatType> threatTypes)

public final SearchUrisResponse searchUris(String uri, List<ThreatType> threatTypes)

This method is used to check whether a URI is on a given threatList.

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 (WebRiskServiceV1Beta1Client webRiskServiceV1Beta1Client =
     WebRiskServiceV1Beta1Client.create()) {
   String uri = "uri116076";
   List<ThreatType> threatTypes = new ArrayList<>();
   SearchUrisResponse response = webRiskServiceV1Beta1Client.searchUris(uri, threatTypes);
 }
Parameters
Name Description
uri String

Required. The URI to be checked for matches.
threatTypes List<ThreatType>

Required. The ThreatLists to search in.
Returns
Type Description
SearchUrisResponse

searchUrisCallable()

public final UnaryCallable<SearchUrisRequest,SearchUrisResponse> searchUrisCallable()

This method is used to check whether a URI is on a given threatList.

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 (WebRiskServiceV1Beta1Client webRiskServiceV1Beta1Client =
     WebRiskServiceV1Beta1Client.create()) {
   SearchUrisRequest request =
       SearchUrisRequest.newBuilder()
           .setUri("uri116076")
           .addAllThreatTypes(new ArrayList<ThreatType>())
           .build();
   ApiFuture<SearchUrisResponse> future =
       webRiskServiceV1Beta1Client.searchUrisCallable().futureCall(request);
   // Do something.
   SearchUrisResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<SearchUrisRequest,SearchUrisResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()