Package com.google.ads.googleads.v9.services

Class DomainCategoryServiceClient

java.lang.Object

com.google.ads.googleads.v9.services.DomainCategoryServiceClient

All Implemented Interfaces:

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

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

Service Description: Service to fetch domain categories.

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 (DomainCategoryServiceClient domainCategoryServiceClient =
     DomainCategoryServiceClient.create()) {
   DomainCategoryName resourceName =
       DomainCategoryName.of(
           "[CUSTOMER_ID]", "[CAMPAIGN_ID]", "[BASE64_CATEGORY]", "[LANGUAGE_CODE]");
   DomainCategory response = domainCategoryServiceClient.getDomainCategory(resourceName);
 }
 

Note: close() needs to be called on the DomainCategoryServiceClient 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 DomainCategoryServiceSettings to create(). For example:

To customize credentials:

 DomainCategoryServiceSettings domainCategoryServiceSettings =
     DomainCategoryServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DomainCategoryServiceClient domainCategoryServiceClient =
     DomainCategoryServiceClient.create(domainCategoryServiceSettings);
 

To customize the endpoint:

 DomainCategoryServiceSettings domainCategoryServiceSettings =
     DomainCategoryServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DomainCategoryServiceClient domainCategoryServiceClient =
     DomainCategoryServiceClient.create(domainCategoryServiceSettings);
 

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DomainCategoryServiceClient(DomainCategoryServiceSettings settings)	Constructs an instance of DomainCategoryServiceClient, using the given settings.
protected	DomainCategoryServiceClient(DomainCategoryServiceStub stub)

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long duration, java.util.concurrent.TimeUnit unit)
void	close()
static DomainCategoryServiceClient	create()	Constructs an instance of DomainCategoryServiceClient with default settings.
static DomainCategoryServiceClient	create(DomainCategoryServiceSettings settings)	Constructs an instance of DomainCategoryServiceClient, using the given settings.
static DomainCategoryServiceClient	create(DomainCategoryServiceStub stub)	Constructs an instance of DomainCategoryServiceClient, using the given stub for making calls.
DomainCategory	getDomainCategory(DomainCategoryName resourceName)	Returns the requested domain category.
DomainCategory	getDomainCategory(GetDomainCategoryRequest request)	Returns the requested domain category.
DomainCategory	getDomainCategory(java.lang.String resourceName)	Returns the requested domain category.
com.google.api.gax.rpc.UnaryCallable<GetDomainCategoryRequest,DomainCategory>	getDomainCategoryCallable()	Returns the requested domain category.
DomainCategoryServiceSettings	getSettings()
DomainCategoryServiceStub	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

DomainCategoryServiceClient

protected DomainCategoryServiceClient(DomainCategoryServiceSettings settings)
                               throws java.io.IOException

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

DomainCategoryServiceClient

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

Method Detail

create

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

Constructs an instance of DomainCategoryServiceClient with default settings.

Throws:

java.io.IOException

create

public static final DomainCategoryServiceClient create(DomainCategoryServiceSettings settings)
                                                throws java.io.IOException

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

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

getSettings

public final DomainCategoryServiceSettings getSettings()

getStub

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

getDomainCategory

public final DomainCategory getDomainCategory(DomainCategoryName resourceName)

Returns the requested domain category.

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

Sample code:

 try (DomainCategoryServiceClient domainCategoryServiceClient =
     DomainCategoryServiceClient.create()) {
   DomainCategoryName resourceName =
       DomainCategoryName.of(
           "[CUSTOMER_ID]", "[CAMPAIGN_ID]", "[BASE64_CATEGORY]", "[LANGUAGE_CODE]");
   DomainCategory response = domainCategoryServiceClient.getDomainCategory(resourceName);
 }
 

Parameters:

resourceName - Required. Resource name of the domain category to fetch.

Throws:

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

getDomainCategory

public final DomainCategory getDomainCategory(java.lang.String resourceName)

Returns the requested domain category.

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

Sample code:

 try (DomainCategoryServiceClient domainCategoryServiceClient =
     DomainCategoryServiceClient.create()) {
   String resourceName =
       DomainCategoryName.of(
               "[CUSTOMER_ID]", "[CAMPAIGN_ID]", "[BASE64_CATEGORY]", "[LANGUAGE_CODE]")
           .toString();
   DomainCategory response = domainCategoryServiceClient.getDomainCategory(resourceName);
 }
 

Parameters:

resourceName - Required. Resource name of the domain category to fetch.

Throws:

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

getDomainCategory

public final DomainCategory getDomainCategory(GetDomainCategoryRequest request)

Returns the requested domain category.

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

Sample code:

 try (DomainCategoryServiceClient domainCategoryServiceClient =
     DomainCategoryServiceClient.create()) {
   GetDomainCategoryRequest request =
       GetDomainCategoryRequest.newBuilder()
           .setResourceName(
               DomainCategoryName.of(
                       "[CUSTOMER_ID]", "[CAMPAIGN_ID]", "[BASE64_CATEGORY]", "[LANGUAGE_CODE]")
                   .toString())
           .build();
   DomainCategory response = domainCategoryServiceClient.getDomainCategory(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

getDomainCategoryCallable

public final com.google.api.gax.rpc.UnaryCallable<GetDomainCategoryRequest,DomainCategory> getDomainCategoryCallable()

Returns the requested domain category.

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

Sample code:

 try (DomainCategoryServiceClient domainCategoryServiceClient =
     DomainCategoryServiceClient.create()) {
   GetDomainCategoryRequest request =
       GetDomainCategoryRequest.newBuilder()
           .setResourceName(
               DomainCategoryName.of(
                       "[CUSTOMER_ID]", "[CAMPAIGN_ID]", "[BASE64_CATEGORY]", "[LANGUAGE_CODE]")
                   .toString())
           .build();
   ApiFuture<DomainCategory> future =
       domainCategoryServiceClient.getDomainCategoryCallable().futureCall(request);
   // Do something.
   DomainCategory 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