com.google.cloud.webrisk.v1beta1.WebRiskServiceV1Beta1Client Maven / Gradle / Ivy
Show all versions of google-cloud-webrisk Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.webrisk.v1beta1;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.webrisk.v1beta1.stub.WebRiskServiceV1Beta1Stub;
import com.google.cloud.webrisk.v1beta1.stub.WebRiskServiceV1Beta1StubSettings;
import com.google.protobuf.ByteString;
import com.google.webrisk.v1beta1.ComputeThreatListDiffRequest;
import com.google.webrisk.v1beta1.ComputeThreatListDiffResponse;
import com.google.webrisk.v1beta1.SearchHashesRequest;
import com.google.webrisk.v1beta1.SearchHashesResponse;
import com.google.webrisk.v1beta1.SearchUrisRequest;
import com.google.webrisk.v1beta1.SearchUrisResponse;
import com.google.webrisk.v1beta1.ThreatType;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* 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:
*
*
{@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);
* }
* }
*
* 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:
*
*
{@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
* WebRiskServiceV1Beta1Settings webRiskServiceV1Beta1Settings =
* WebRiskServiceV1Beta1Settings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* WebRiskServiceV1Beta1Client webRiskServiceV1Beta1Client =
* WebRiskServiceV1Beta1Client.create(webRiskServiceV1Beta1Settings);
* }
*
* To customize the endpoint:
*
*
{@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
* 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:
*
*
{@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
* WebRiskServiceV1Beta1Settings webRiskServiceV1Beta1Settings =
* WebRiskServiceV1Beta1Settings.newHttpJsonBuilder().build();
* WebRiskServiceV1Beta1Client webRiskServiceV1Beta1Client =
* WebRiskServiceV1Beta1Client.create(webRiskServiceV1Beta1Settings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@BetaApi
@Generated("by gapic-generator-java")
public class WebRiskServiceV1Beta1Client implements BackgroundResource {
private final WebRiskServiceV1Beta1Settings settings;
private final WebRiskServiceV1Beta1Stub stub;
/** Constructs an instance of WebRiskServiceV1Beta1Client with default settings. */
public static final WebRiskServiceV1Beta1Client create() throws IOException {
return create(WebRiskServiceV1Beta1Settings.newBuilder().build());
}
/**
* 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.
*/
public static final WebRiskServiceV1Beta1Client create(WebRiskServiceV1Beta1Settings settings)
throws IOException {
return new WebRiskServiceV1Beta1Client(settings);
}
/**
* Constructs an instance of WebRiskServiceV1Beta1Client, using the given stub for making calls.
* This is for advanced usage - prefer using create(WebRiskServiceV1Beta1Settings).
*/
public static final WebRiskServiceV1Beta1Client create(WebRiskServiceV1Beta1Stub stub) {
return new WebRiskServiceV1Beta1Client(stub);
}
/**
* 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.
*/
protected WebRiskServiceV1Beta1Client(WebRiskServiceV1Beta1Settings settings) throws IOException {
this.settings = settings;
this.stub = ((WebRiskServiceV1Beta1StubSettings) settings.getStubSettings()).createStub();
}
protected WebRiskServiceV1Beta1Client(WebRiskServiceV1Beta1Stub stub) {
this.settings = null;
this.stub = stub;
}
public final WebRiskServiceV1Beta1Settings getSettings() {
return settings;
}
public WebRiskServiceV1Beta1Stub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the most recent threat list diffs.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param threatType The ThreatList to update.
* @param versionToken The current version token of the client for the requested list (the client
* version that was received from the last successful diff).
* @param constraints Required. The constraints associated with this request.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ComputeThreatListDiffResponse computeThreatListDiff(
ThreatType threatType,
ByteString versionToken,
ComputeThreatListDiffRequest.Constraints constraints) {
ComputeThreatListDiffRequest request =
ComputeThreatListDiffRequest.newBuilder()
.setThreatType(threatType)
.setVersionToken(versionToken)
.setConstraints(constraints)
.build();
return computeThreatListDiff(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the most recent threat list diffs.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param 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
*/
public final ComputeThreatListDiffResponse computeThreatListDiff(
ComputeThreatListDiffRequest request) {
return computeThreatListDiffCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the most recent threat list diffs.
*
* Sample code:
*
*
{@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 future =
* webRiskServiceV1Beta1Client.computeThreatListDiffCallable().futureCall(request);
* // Do something.
* ComputeThreatListDiffResponse response = future.get();
* }
* }
*/
public final UnaryCallable
computeThreatListDiffCallable() {
return stub.computeThreatListDiffCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* This method is used to check whether a URI is on a given threatList.
*
* Sample code:
*
*
{@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 threatTypes = new ArrayList<>();
* SearchUrisResponse response = webRiskServiceV1Beta1Client.searchUris(uri, threatTypes);
* }
* }
*
* @param uri Required. The URI to be checked for matches.
* @param threatTypes Required. The ThreatLists to search in.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SearchUrisResponse searchUris(String uri, List threatTypes) {
SearchUrisRequest request =
SearchUrisRequest.newBuilder().setUri(uri).addAllThreatTypes(threatTypes).build();
return searchUris(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* This method is used to check whether a URI is on a given threatList.
*
* Sample code:
*
*
{@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())
* .build();
* SearchUrisResponse response = webRiskServiceV1Beta1Client.searchUris(request);
* }
* }
*
* @param 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
*/
public final SearchUrisResponse searchUris(SearchUrisRequest request) {
return searchUrisCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* This method is used to check whether a URI is on a given threatList.
*
* Sample code:
*
*
{@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())
* .build();
* ApiFuture future =
* webRiskServiceV1Beta1Client.searchUrisCallable().futureCall(request);
* // Do something.
* SearchUrisResponse response = future.get();
* }
* }
*/
public final UnaryCallable searchUrisCallable() {
return stub.searchUrisCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@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 threatTypes = new ArrayList<>();
* SearchHashesResponse response =
* webRiskServiceV1Beta1Client.searchHashes(hashPrefix, threatTypes);
* }
* }
*
* @param hashPrefix A hash prefix, consisting of the most significant 4-32 bytes of a SHA256
* hash. For JSON requests, this field is base64-encoded.
* @param threatTypes Required. The ThreatLists to search in.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SearchHashesResponse searchHashes(
ByteString hashPrefix, List threatTypes) {
SearchHashesRequest request =
SearchHashesRequest.newBuilder()
.setHashPrefix(hashPrefix)
.addAllThreatTypes(threatTypes)
.build();
return searchHashes(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@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())
* .build();
* SearchHashesResponse response = webRiskServiceV1Beta1Client.searchHashes(request);
* }
* }
*
* @param 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
*/
public final SearchHashesResponse searchHashes(SearchHashesRequest request) {
return searchHashesCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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:
*
*
{@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())
* .build();
* ApiFuture future =
* webRiskServiceV1Beta1Client.searchHashesCallable().futureCall(request);
* // Do something.
* SearchHashesResponse response = future.get();
* }
* }
*/
public final UnaryCallable searchHashesCallable() {
return stub.searchHashesCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
}