com.google.cloud.discoveryengine.v1alpha

Class EstimateBillingServiceClient

java.lang.Object

com.google.cloud.discoveryengine.v1alpha.EstimateBillingServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class EstimateBillingServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service for managing billing estimations resources.

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 (EstimateBillingServiceClient estimateBillingServiceClient =
     EstimateBillingServiceClient.create()) {
   EstimateDataSizeRequest request =
       EstimateDataSizeRequest.newBuilder()
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   EstimateDataSizeResponse response =
       estimateBillingServiceClient.estimateDataSizeAsync(request).get();
 }
 

Note: close() needs to be called on the EstimateBillingServiceClient 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
EstimateDataSize	Estimates the data size to be used by a customer.	Request object method variants only take one parameter, a request object, which must be constructed before the call. estimateDataSizeAsync(EstimateDataSizeRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. estimateDataSizeOperationCallable() estimateDataSizeCallable()

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 EstimateBillingServiceSettings 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
 EstimateBillingServiceSettings estimateBillingServiceSettings =
     EstimateBillingServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EstimateBillingServiceClient estimateBillingServiceClient =
     EstimateBillingServiceClient.create(estimateBillingServiceSettings);
 

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
 EstimateBillingServiceSettings estimateBillingServiceSettings =
     EstimateBillingServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 EstimateBillingServiceClient estimateBillingServiceClient =
     EstimateBillingServiceClient.create(estimateBillingServiceSettings);
 

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
 EstimateBillingServiceSettings estimateBillingServiceSettings =
     EstimateBillingServiceSettings.newHttpJsonBuilder().build();
 EstimateBillingServiceClient estimateBillingServiceClient =
     EstimateBillingServiceClient.create(estimateBillingServiceSettings);
 

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EstimateBillingServiceClient(EstimateBillingServiceSettings settings) Constructs an instance of EstimateBillingServiceClient, using the given settings.
protected	EstimateBillingServiceClient(EstimateBillingServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static EstimateBillingServiceClient	create() Constructs an instance of EstimateBillingServiceClient with default settings.
static EstimateBillingServiceClient	create(EstimateBillingServiceSettings settings) Constructs an instance of EstimateBillingServiceClient, using the given settings.
static EstimateBillingServiceClient	create(EstimateBillingServiceStub stub) Constructs an instance of EstimateBillingServiceClient, using the given stub for making calls.
com.google.api.gax.longrunning.OperationFuture<EstimateDataSizeResponse,EstimateDataSizeMetadata>	estimateDataSizeAsync(EstimateDataSizeRequest request) Estimates the data size to be used by a customer.
com.google.api.gax.rpc.UnaryCallable<EstimateDataSizeRequest,com.google.longrunning.Operation>	estimateDataSizeCallable() Estimates the data size to be used by a customer.
com.google.api.gax.rpc.OperationCallable<EstimateDataSizeRequest,EstimateDataSizeResponse,EstimateDataSizeMetadata>	estimateDataSizeOperationCallable() Estimates the data size to be used by a customer.
com.google.api.gax.httpjson.longrunning.OperationsClient	getHttpJsonOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
com.google.longrunning.OperationsClient	getOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
EstimateBillingServiceSettings	getSettings()
EstimateBillingServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EstimateBillingServiceClient

protected EstimateBillingServiceClient(EstimateBillingServiceSettings settings)
                                throws IOException

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

EstimateBillingServiceClient

protected EstimateBillingServiceClient(EstimateBillingServiceStub stub)

Method Detail

create

public static final EstimateBillingServiceClient create()
                                                 throws IOException

Constructs an instance of EstimateBillingServiceClient with default settings.

Throws:

IOException

create

public static final EstimateBillingServiceClient create(EstimateBillingServiceSettings settings)
                                                 throws IOException

Constructs an instance of EstimateBillingServiceClient, 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 EstimateBillingServiceClient create(EstimateBillingServiceStub stub)

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

getSettings

public final EstimateBillingServiceSettings getSettings()

getStub

public EstimateBillingServiceStub getStub()

getOperationsClient

public final com.google.longrunning.OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getHttpJsonOperationsClient

@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

estimateDataSizeAsync

public final com.google.api.gax.longrunning.OperationFuture<EstimateDataSizeResponse,EstimateDataSizeMetadata> estimateDataSizeAsync(EstimateDataSizeRequest request)

Estimates the data size to be used by a customer.

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 (EstimateBillingServiceClient estimateBillingServiceClient =
     EstimateBillingServiceClient.create()) {
   EstimateDataSizeRequest request =
       EstimateDataSizeRequest.newBuilder()
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   EstimateDataSizeResponse response =
       estimateBillingServiceClient.estimateDataSizeAsync(request).get();
 }
 

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

estimateDataSizeOperationCallable

public final com.google.api.gax.rpc.OperationCallable<EstimateDataSizeRequest,EstimateDataSizeResponse,EstimateDataSizeMetadata> estimateDataSizeOperationCallable()

Estimates the data size to be used by a customer.

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 (EstimateBillingServiceClient estimateBillingServiceClient =
     EstimateBillingServiceClient.create()) {
   EstimateDataSizeRequest request =
       EstimateDataSizeRequest.newBuilder()
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   OperationFuture<EstimateDataSizeResponse, EstimateDataSizeMetadata> future =
       estimateBillingServiceClient.estimateDataSizeOperationCallable().futureCall(request);
   // Do something.
   EstimateDataSizeResponse response = future.get();
 }
 

estimateDataSizeCallable

public final com.google.api.gax.rpc.UnaryCallable<EstimateDataSizeRequest,com.google.longrunning.Operation> estimateDataSizeCallable()

Estimates the data size to be used by a customer.

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 (EstimateBillingServiceClient estimateBillingServiceClient =
     EstimateBillingServiceClient.create()) {
   EstimateDataSizeRequest request =
       EstimateDataSizeRequest.newBuilder()
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ApiFuture<Operation> future =
       estimateBillingServiceClient.estimateDataSizeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException