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

Class TopicViewServiceClient

java.lang.Object

com.google.ads.googleads.v9.services.TopicViewServiceClient

All Implemented Interfaces:

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

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

Service Description: Service to manage topic views.

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 (TopicViewServiceClient topicViewServiceClient = TopicViewServiceClient.create()) {
   TopicViewName resourceName =
       TopicViewName.of("[CUSTOMER_ID]", "[AD_GROUP_ID]", "[CRITERION_ID]");
   TopicView response = topicViewServiceClient.getTopicView(resourceName);
 }
 

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

To customize credentials:

 TopicViewServiceSettings topicViewServiceSettings =
     TopicViewServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TopicViewServiceClient topicViewServiceClient =
     TopicViewServiceClient.create(topicViewServiceSettings);
 

To customize the endpoint:

 TopicViewServiceSettings topicViewServiceSettings =
     TopicViewServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 TopicViewServiceClient topicViewServiceClient =
     TopicViewServiceClient.create(topicViewServiceSettings);
 

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TopicViewServiceClient(TopicViewServiceStub stub)
protected	TopicViewServiceClient(TopicViewServiceSettings settings)	Constructs an instance of TopicViewServiceClient, using the given settings.

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long duration, java.util.concurrent.TimeUnit unit)
void	close()
static TopicViewServiceClient	create()	Constructs an instance of TopicViewServiceClient with default settings.
static TopicViewServiceClient	create(TopicViewServiceStub stub)	Constructs an instance of TopicViewServiceClient, using the given stub for making calls.
static TopicViewServiceClient	create(TopicViewServiceSettings settings)	Constructs an instance of TopicViewServiceClient, using the given settings.
TopicViewServiceSettings	getSettings()
TopicViewServiceStub	getStub()
TopicView	getTopicView(TopicViewName resourceName)	Returns the requested topic view in full detail.
TopicView	getTopicView(GetTopicViewRequest request)	Returns the requested topic view in full detail.
TopicView	getTopicView(java.lang.String resourceName)	Returns the requested topic view in full detail.
com.google.api.gax.rpc.UnaryCallable<GetTopicViewRequest,TopicView>	getTopicViewCallable()	Returns the requested topic view in full detail.
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

TopicViewServiceClient

protected TopicViewServiceClient(TopicViewServiceSettings settings)
                          throws java.io.IOException

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

TopicViewServiceClient

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

Method Detail

create

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

Constructs an instance of TopicViewServiceClient with default settings.

Throws:

java.io.IOException

create

public static final TopicViewServiceClient create(TopicViewServiceSettings settings)
                                           throws java.io.IOException

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

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

getSettings

public final TopicViewServiceSettings getSettings()

getStub

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

getTopicView

public final TopicView getTopicView(TopicViewName resourceName)

Returns the requested topic view in full detail.

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

Sample code:

 try (TopicViewServiceClient topicViewServiceClient = TopicViewServiceClient.create()) {
   TopicViewName resourceName =
       TopicViewName.of("[CUSTOMER_ID]", "[AD_GROUP_ID]", "[CRITERION_ID]");
   TopicView response = topicViewServiceClient.getTopicView(resourceName);
 }
 

Parameters:

resourceName - Required. The resource name of the topic view to fetch.

Throws:

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

getTopicView

public final TopicView getTopicView(java.lang.String resourceName)

Returns the requested topic view in full detail.

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

Sample code:

 try (TopicViewServiceClient topicViewServiceClient = TopicViewServiceClient.create()) {
   String resourceName =
       TopicViewName.of("[CUSTOMER_ID]", "[AD_GROUP_ID]", "[CRITERION_ID]").toString();
   TopicView response = topicViewServiceClient.getTopicView(resourceName);
 }
 

Parameters:

resourceName - Required. The resource name of the topic view to fetch.

Throws:

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

getTopicView

public final TopicView getTopicView(GetTopicViewRequest request)

Returns the requested topic view in full detail.

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

Sample code:

 try (TopicViewServiceClient topicViewServiceClient = TopicViewServiceClient.create()) {
   GetTopicViewRequest request =
       GetTopicViewRequest.newBuilder()
           .setResourceName(
               TopicViewName.of("[CUSTOMER_ID]", "[AD_GROUP_ID]", "[CRITERION_ID]").toString())
           .build();
   TopicView response = topicViewServiceClient.getTopicView(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

getTopicViewCallable

public final com.google.api.gax.rpc.UnaryCallable<GetTopicViewRequest,TopicView> getTopicViewCallable()

Returns the requested topic view in full detail.

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

Sample code:

 try (TopicViewServiceClient topicViewServiceClient = TopicViewServiceClient.create()) {
   GetTopicViewRequest request =
       GetTopicViewRequest.newBuilder()
           .setResourceName(
               TopicViewName.of("[CUSTOMER_ID]", "[AD_GROUP_ID]", "[CRITERION_ID]").toString())
           .build();
   ApiFuture<TopicView> future =
       topicViewServiceClient.getTopicViewCallable().futureCall(request);
   // Do something.
   TopicView 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