Package com.google.ads.googleads.v10.services

Class PaymentsAccountServiceClient

java.lang.Object

com.google.ads.googleads.v10.services.PaymentsAccountServiceClient

All Implemented Interfaces:

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

@Generated("by gapic-generator-java")
public class PaymentsAccountServiceClient
extends java.lang.Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service to provide payments accounts that can be used to set up consolidated billing.

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:

 try (PaymentsAccountServiceClient paymentsAccountServiceClient =
     PaymentsAccountServiceClient.create()) {
   String customerId = "customerId-1581184615";
   ListPaymentsAccountsResponse response =
       paymentsAccountServiceClient.listPaymentsAccounts(customerId);
 }
 

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

1. 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.
2. 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.
3. 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 PaymentsAccountServiceSettings to create(). For example:

To customize credentials:

 PaymentsAccountServiceSettings paymentsAccountServiceSettings =
     PaymentsAccountServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PaymentsAccountServiceClient paymentsAccountServiceClient =
     PaymentsAccountServiceClient.create(paymentsAccountServiceSettings);
 

To customize the endpoint:

 PaymentsAccountServiceSettings paymentsAccountServiceSettings =
     PaymentsAccountServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 PaymentsAccountServiceClient paymentsAccountServiceClient =
     PaymentsAccountServiceClient.create(paymentsAccountServiceSettings);
 

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PaymentsAccountServiceClient(PaymentsAccountServiceSettings settings)	Constructs an instance of PaymentsAccountServiceClient, using the given settings.
protected	PaymentsAccountServiceClient(PaymentsAccountServiceStub stub)

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long duration, java.util.concurrent.TimeUnit unit)
void	close()
static PaymentsAccountServiceClient	create()	Constructs an instance of PaymentsAccountServiceClient with default settings.
static PaymentsAccountServiceClient	create(PaymentsAccountServiceSettings settings)	Constructs an instance of PaymentsAccountServiceClient, using the given settings.
static PaymentsAccountServiceClient	create(PaymentsAccountServiceStub stub)	Constructs an instance of PaymentsAccountServiceClient, using the given stub for making calls.
PaymentsAccountServiceSettings	getSettings()
PaymentsAccountServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
ListPaymentsAccountsResponse	listPaymentsAccounts(ListPaymentsAccountsRequest request)	Returns all payments accounts associated with all managers between the login customer ID and specified serving customer in the hierarchy, inclusive.
ListPaymentsAccountsResponse	listPaymentsAccounts(java.lang.String customerId)	Returns all payments accounts associated with all managers between the login customer ID and specified serving customer in the hierarchy, inclusive.
com.google.api.gax.rpc.UnaryCallable<ListPaymentsAccountsRequest,ListPaymentsAccountsResponse>	listPaymentsAccountsCallable()	Returns all payments accounts associated with all managers between the login customer ID and specified serving customer in the hierarchy, inclusive.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

PaymentsAccountServiceClient

protected PaymentsAccountServiceClient(PaymentsAccountServiceSettings settings)
                                throws java.io.IOException

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

java.io.IOException

PaymentsAccountServiceClient

@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected PaymentsAccountServiceClient(PaymentsAccountServiceStub stub)

Method Detail

create

public static final PaymentsAccountServiceClient create()
                                                 throws java.io.IOException

Constructs an instance of PaymentsAccountServiceClient with default settings.

Throws:

java.io.IOException

create

public static final PaymentsAccountServiceClient create(PaymentsAccountServiceSettings settings)
                                                 throws java.io.IOException

Constructs an instance of PaymentsAccountServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

java.io.IOException

create

@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final PaymentsAccountServiceClient create(PaymentsAccountServiceStub stub)

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

getSettings

public final PaymentsAccountServiceSettings getSettings()

getStub

@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public PaymentsAccountServiceStub getStub()

listPaymentsAccounts

public final ListPaymentsAccountsResponse listPaymentsAccounts(java.lang.String customerId)

Returns all payments accounts associated with all managers between the login customer ID and specified serving customer in the hierarchy, inclusive.

List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [PaymentsAccountError]() [QuotaError]() [RequestError]()

Sample code:

 try (PaymentsAccountServiceClient paymentsAccountServiceClient =
     PaymentsAccountServiceClient.create()) {
   String customerId = "customerId-1581184615";
   ListPaymentsAccountsResponse response =
       paymentsAccountServiceClient.listPaymentsAccounts(customerId);
 }
 

Parameters:

customerId - Required. The ID of the customer to apply the PaymentsAccount list operation to.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listPaymentsAccounts

public final ListPaymentsAccountsResponse listPaymentsAccounts(ListPaymentsAccountsRequest request)

Returns all payments accounts associated with all managers between the login customer ID and specified serving customer in the hierarchy, inclusive.

List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [PaymentsAccountError]() [QuotaError]() [RequestError]()

Sample code:

 try (PaymentsAccountServiceClient paymentsAccountServiceClient =
     PaymentsAccountServiceClient.create()) {
   ListPaymentsAccountsRequest request =
       ListPaymentsAccountsRequest.newBuilder().setCustomerId("customerId-1581184615").build();
   ListPaymentsAccountsResponse response =
       paymentsAccountServiceClient.listPaymentsAccounts(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

listPaymentsAccountsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListPaymentsAccountsRequest,ListPaymentsAccountsResponse> listPaymentsAccountsCallable()

Returns all payments accounts associated with all managers between the login customer ID and specified serving customer in the hierarchy, inclusive.

List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [PaymentsAccountError]() [QuotaError]() [RequestError]()

Sample code:

 try (PaymentsAccountServiceClient paymentsAccountServiceClient =
     PaymentsAccountServiceClient.create()) {
   ListPaymentsAccountsRequest request =
       ListPaymentsAccountsRequest.newBuilder().setCustomerId("customerId-1581184615").build();
   ApiFuture<ListPaymentsAccountsResponse> future =
       paymentsAccountServiceClient.listPaymentsAccountsCallable().futureCall(request);
   // Do something.
   ListPaymentsAccountsResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface java.lang.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,
                                java.util.concurrent.TimeUnit unit)
                         throws java.lang.InterruptedException

Specified by:

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

Throws:

java.lang.InterruptedException