com.google.ads.googleads.v17.services.IdentityVerificationServiceClient Maven / Gradle / Ivy
Show all versions of google-ads-stubs-v17 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.ads.googleads.v17.services;
import com.google.ads.googleads.v17.enums.IdentityVerificationProgramEnum;
import com.google.ads.googleads.v17.services.stub.IdentityVerificationServiceStub;
import com.google.ads.googleads.v17.services.stub.IdentityVerificationServiceStubSettings;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.protobuf.Empty;
import java.io.IOException;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: A service for managing Identity Verification Service.
*
* 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 (IdentityVerificationServiceClient identityVerificationServiceClient =
* IdentityVerificationServiceClient.create()) {
* String customerId = "customerId-1581184615";
* IdentityVerificationProgramEnum.IdentityVerificationProgram verificationProgram =
* IdentityVerificationProgramEnum.IdentityVerificationProgram.forNumber(0);
* identityVerificationServiceClient.startIdentityVerification(customerId, verificationProgram);
* }
* }
*
* Note: close() needs to be called on the IdentityVerificationServiceClient 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
*
*
* StartIdentityVerification
Starts Identity Verification for a given verification program type. Statuses are returned.
*
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* startIdentityVerification(StartIdentityVerificationRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* startIdentityVerification(String customerId, IdentityVerificationProgramEnum.IdentityVerificationProgram verificationProgram)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* startIdentityVerificationCallable()
*
*
*
*
* GetIdentityVerification
Returns Identity Verification information.
*
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getIdentityVerification(GetIdentityVerificationRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getIdentityVerification(String customerId)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getIdentityVerificationCallable()
*
*
*
*
*
* 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
* IdentityVerificationServiceSettings 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
* IdentityVerificationServiceSettings identityVerificationServiceSettings =
* IdentityVerificationServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* IdentityVerificationServiceClient identityVerificationServiceClient =
* IdentityVerificationServiceClient.create(identityVerificationServiceSettings);
* }
*
* 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
* IdentityVerificationServiceSettings identityVerificationServiceSettings =
* IdentityVerificationServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* IdentityVerificationServiceClient identityVerificationServiceClient =
* IdentityVerificationServiceClient.create(identityVerificationServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class IdentityVerificationServiceClient implements BackgroundResource {
private final IdentityVerificationServiceSettings settings;
private final IdentityVerificationServiceStub stub;
/** Constructs an instance of IdentityVerificationServiceClient with default settings. */
public static final IdentityVerificationServiceClient create() throws IOException {
return create(IdentityVerificationServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of IdentityVerificationServiceClient, 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 IdentityVerificationServiceClient create(
IdentityVerificationServiceSettings settings) throws IOException {
return new IdentityVerificationServiceClient(settings);
}
/**
* Constructs an instance of IdentityVerificationServiceClient, using the given stub for making
* calls. This is for advanced usage - prefer using create(IdentityVerificationServiceSettings).
*/
public static final IdentityVerificationServiceClient create(
IdentityVerificationServiceStub stub) {
return new IdentityVerificationServiceClient(stub);
}
/**
* Constructs an instance of IdentityVerificationServiceClient, 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 IdentityVerificationServiceClient(IdentityVerificationServiceSettings settings)
throws IOException {
this.settings = settings;
this.stub = ((IdentityVerificationServiceStubSettings) settings.getStubSettings()).createStub();
}
protected IdentityVerificationServiceClient(IdentityVerificationServiceStub stub) {
this.settings = null;
this.stub = stub;
}
public final IdentityVerificationServiceSettings getSettings() {
return settings;
}
public IdentityVerificationServiceStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Starts Identity Verification for a given verification program type. Statuses are returned.
*
*
List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
* [InternalError]() [QuotaError]() [RequestError]()
*
*
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 (IdentityVerificationServiceClient identityVerificationServiceClient =
* IdentityVerificationServiceClient.create()) {
* String customerId = "customerId-1581184615";
* IdentityVerificationProgramEnum.IdentityVerificationProgram verificationProgram =
* IdentityVerificationProgramEnum.IdentityVerificationProgram.forNumber(0);
* identityVerificationServiceClient.startIdentityVerification(customerId, verificationProgram);
* }
* }
*
* @param customerId Required. The Id of the customer for whom we are creating this verification.
* @param verificationProgram Required. The verification program type for which we want to start
* the verification.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void startIdentityVerification(
String customerId,
IdentityVerificationProgramEnum.IdentityVerificationProgram verificationProgram) {
StartIdentityVerificationRequest request =
StartIdentityVerificationRequest.newBuilder()
.setCustomerId(customerId)
.setVerificationProgram(verificationProgram)
.build();
startIdentityVerification(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Starts Identity Verification for a given verification program type. Statuses are returned.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
* [InternalError]() [QuotaError]() [RequestError]()
*
*
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 (IdentityVerificationServiceClient identityVerificationServiceClient =
* IdentityVerificationServiceClient.create()) {
* StartIdentityVerificationRequest request =
* StartIdentityVerificationRequest.newBuilder()
* .setCustomerId("customerId-1581184615")
* .build();
* identityVerificationServiceClient.startIdentityVerification(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 void startIdentityVerification(StartIdentityVerificationRequest request) {
startIdentityVerificationCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Starts Identity Verification for a given verification program type. Statuses are returned.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
* [InternalError]() [QuotaError]() [RequestError]()
*
*
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 (IdentityVerificationServiceClient identityVerificationServiceClient =
* IdentityVerificationServiceClient.create()) {
* StartIdentityVerificationRequest request =
* StartIdentityVerificationRequest.newBuilder()
* .setCustomerId("customerId-1581184615")
* .build();
* ApiFuture future =
* identityVerificationServiceClient.startIdentityVerificationCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable
startIdentityVerificationCallable() {
return stub.startIdentityVerificationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns Identity Verification information.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
* [InternalError]() [QuotaError]() [RequestError]()
*
*
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 (IdentityVerificationServiceClient identityVerificationServiceClient =
* IdentityVerificationServiceClient.create()) {
* String customerId = "customerId-1581184615";
* GetIdentityVerificationResponse response =
* identityVerificationServiceClient.getIdentityVerification(customerId);
* }
* }
*
* @param customerId Required. The ID of the customer for whom we are requesting verification
* information.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final GetIdentityVerificationResponse getIdentityVerification(String customerId) {
GetIdentityVerificationRequest request =
GetIdentityVerificationRequest.newBuilder().setCustomerId(customerId).build();
return getIdentityVerification(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns Identity Verification information.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
* [InternalError]() [QuotaError]() [RequestError]()
*
*
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 (IdentityVerificationServiceClient identityVerificationServiceClient =
* IdentityVerificationServiceClient.create()) {
* GetIdentityVerificationRequest request =
* GetIdentityVerificationRequest.newBuilder()
* .setCustomerId("customerId-1581184615")
* .build();
* GetIdentityVerificationResponse response =
* identityVerificationServiceClient.getIdentityVerification(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 GetIdentityVerificationResponse getIdentityVerification(
GetIdentityVerificationRequest request) {
return getIdentityVerificationCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns Identity Verification information.
*
* List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]()
* [InternalError]() [QuotaError]() [RequestError]()
*
*
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 (IdentityVerificationServiceClient identityVerificationServiceClient =
* IdentityVerificationServiceClient.create()) {
* GetIdentityVerificationRequest request =
* GetIdentityVerificationRequest.newBuilder()
* .setCustomerId("customerId-1581184615")
* .build();
* ApiFuture future =
* identityVerificationServiceClient.getIdentityVerificationCallable().futureCall(request);
* // Do something.
* GetIdentityVerificationResponse response = future.get();
* }
* }
*/
public final UnaryCallable
getIdentityVerificationCallable() {
return stub.getIdentityVerificationCallable();
}
@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);
}
}