Class AuthorizedDomainsClient (2.1.10) 

public class AuthorizedDomainsClient implements BackgroundResource

Service Description: Manages domains a user is authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central.

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 (AuthorizedDomainsClient authorizedDomainsClient = AuthorizedDomainsClient.create()) {
   ListAuthorizedDomainsRequest request =
       ListAuthorizedDomainsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (AuthorizedDomain element :
       authorizedDomainsClient.listAuthorizedDomains(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

To customize credentials:


 AuthorizedDomainsSettings authorizedDomainsSettings =
     AuthorizedDomainsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AuthorizedDomainsClient authorizedDomainsClient =
     AuthorizedDomainsClient.create(authorizedDomainsSettings);

To customize the endpoint:


 AuthorizedDomainsSettings authorizedDomainsSettings =
     AuthorizedDomainsSettings.newBuilder().setEndpoint(myEndpoint).build();
 AuthorizedDomainsClient authorizedDomainsClient =
     AuthorizedDomainsClient.create(authorizedDomainsSettings);

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

Inheritance

java.lang.Object > AuthorizedDomainsClient

Implements

BackgroundResource

Static Methods

create()

public static final AuthorizedDomainsClient create()

Constructs an instance of AuthorizedDomainsClient with default settings.

Returns
TypeDescription
AuthorizedDomainsClient
Exceptions
TypeDescription
IOException

create(AuthorizedDomainsSettings settings)

public static final AuthorizedDomainsClient create(AuthorizedDomainsSettings settings)

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

Parameter
NameDescription
settingsAuthorizedDomainsSettings
Returns
TypeDescription
AuthorizedDomainsClient
Exceptions
TypeDescription
IOException

create(AuthorizedDomainsStub stub)

public static final AuthorizedDomainsClient create(AuthorizedDomainsStub stub)

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

Parameter
NameDescription
stubAuthorizedDomainsStub
Returns
TypeDescription
AuthorizedDomainsClient

Constructors

AuthorizedDomainsClient(AuthorizedDomainsSettings settings)

protected AuthorizedDomainsClient(AuthorizedDomainsSettings settings)

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

Parameter
NameDescription
settingsAuthorizedDomainsSettings

AuthorizedDomainsClient(AuthorizedDomainsStub stub)

protected AuthorizedDomainsClient(AuthorizedDomainsStub stub)
Parameter
NameDescription
stubAuthorizedDomainsStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

getSettings()

public final AuthorizedDomainsSettings getSettings()
Returns
TypeDescription
AuthorizedDomainsSettings

getStub()

public AuthorizedDomainsStub getStub()
Returns
TypeDescription
AuthorizedDomainsStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

listAuthorizedDomains(ListAuthorizedDomainsRequest request)

public final AuthorizedDomainsClient.ListAuthorizedDomainsPagedResponse listAuthorizedDomains(ListAuthorizedDomainsRequest request)

Lists all domains the user is authorized to administer.

Sample code:


 try (AuthorizedDomainsClient authorizedDomainsClient = AuthorizedDomainsClient.create()) {
   ListAuthorizedDomainsRequest request =
       ListAuthorizedDomainsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (AuthorizedDomain element :
       authorizedDomainsClient.listAuthorizedDomains(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
NameDescription
requestListAuthorizedDomainsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
AuthorizedDomainsClient.ListAuthorizedDomainsPagedResponse

listAuthorizedDomainsCallable()

public final UnaryCallable<ListAuthorizedDomainsRequest,ListAuthorizedDomainsResponse> listAuthorizedDomainsCallable()

Lists all domains the user is authorized to administer.

Sample code:


 try (AuthorizedDomainsClient authorizedDomainsClient = AuthorizedDomainsClient.create()) {
   ListAuthorizedDomainsRequest request =
       ListAuthorizedDomainsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAuthorizedDomainsResponse response =
         authorizedDomainsClient.listAuthorizedDomainsCallable().call(request);
     for (AuthorizedDomain element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
TypeDescription
UnaryCallable<ListAuthorizedDomainsRequest,ListAuthorizedDomainsResponse>

listAuthorizedDomainsPagedCallable()

public final UnaryCallable<ListAuthorizedDomainsRequest,AuthorizedDomainsClient.ListAuthorizedDomainsPagedResponse> listAuthorizedDomainsPagedCallable()

Lists all domains the user is authorized to administer.

Sample code:


 try (AuthorizedDomainsClient authorizedDomainsClient = AuthorizedDomainsClient.create()) {
   ListAuthorizedDomainsRequest request =
       ListAuthorizedDomainsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture
Returns
TypeDescription
UnaryCallable<ListAuthorizedDomainsRequest,ListAuthorizedDomainsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()