Class AuthorizedDomainsClient (2.11.0) 

publicclass AuthorizedDomainsClientimplementsBackgroundResource

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:


// 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(AuthorizedDomainsClientauthorizedDomainsClient=AuthorizedDomainsClient.create()){
ListAuthorizedDomainsRequestrequest=
ListAuthorizedDomainsRequest.newBuilder()
.setParent("parent-995424086")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for(AuthorizedDomainelement:
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:


// 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
AuthorizedDomainsSettingsauthorizedDomainsSettings=
AuthorizedDomainsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AuthorizedDomainsClientauthorizedDomainsClient=
AuthorizedDomainsClient.create(authorizedDomainsSettings);

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
AuthorizedDomainsSettingsauthorizedDomainsSettings=
AuthorizedDomainsSettings.newBuilder().setEndpoint(myEndpoint).build();
AuthorizedDomainsClientauthorizedDomainsClient=
AuthorizedDomainsClient.create(authorizedDomainsSettings);

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
AuthorizedDomainsSettingsauthorizedDomainsSettings=
AuthorizedDomainsSettings.newHttpJsonBuilder().build();
AuthorizedDomainsClientauthorizedDomainsClient=
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()

publicstaticfinalAuthorizedDomainsClientcreate()

Constructs an instance of AuthorizedDomainsClient with default settings.

Returns
Type Description
AuthorizedDomainsClient
Exceptions
Type Description
IOException

create(AuthorizedDomainsSettings settings)

publicstaticfinalAuthorizedDomainsClientcreate(AuthorizedDomainsSettingssettings)

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
Name Description
settings AuthorizedDomainsSettings
Returns
Type Description
AuthorizedDomainsClient
Exceptions
Type Description
IOException

create(AuthorizedDomainsStub stub)

publicstaticfinalAuthorizedDomainsClientcreate(AuthorizedDomainsStubstub)

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

Parameter
Name Description
stub AuthorizedDomainsStub
Returns
Type Description
AuthorizedDomainsClient

Constructors

AuthorizedDomainsClient(AuthorizedDomainsSettings settings)

protectedAuthorizedDomainsClient(AuthorizedDomainsSettingssettings)

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
Name Description
settings AuthorizedDomainsSettings

AuthorizedDomainsClient(AuthorizedDomainsStub stub)

protectedAuthorizedDomainsClient(AuthorizedDomainsStubstub)
Parameter
Name Description
stub AuthorizedDomainsStub

Methods

awaitTermination(long duration, TimeUnit unit)

publicbooleanawaitTermination(longduration,TimeUnitunit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

publicfinalvoidclose()

getSettings()

publicfinalAuthorizedDomainsSettingsgetSettings()
Returns
Type Description
AuthorizedDomainsSettings

getStub()

publicAuthorizedDomainsStubgetStub()
Returns
Type Description
AuthorizedDomainsStub

isShutdown()

publicbooleanisShutdown()
Returns
Type Description
boolean

isTerminated()

publicbooleanisTerminated()
Returns
Type Description
boolean

listAuthorizedDomains(ListAuthorizedDomainsRequest request)

publicfinalAuthorizedDomainsClient.ListAuthorizedDomainsPagedResponselistAuthorizedDomains(ListAuthorizedDomainsRequestrequest)

Lists all domains the user is authorized to administer.

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

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

Returns
Type Description
AuthorizedDomainsClient.ListAuthorizedDomainsPagedResponse

listAuthorizedDomainsCallable()

publicfinalUnaryCallable<ListAuthorizedDomainsRequest,ListAuthorizedDomainsResponse>listAuthorizedDomainsCallable()

Lists all domains the user is authorized to administer.

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(AuthorizedDomainsClientauthorizedDomainsClient=AuthorizedDomainsClient.create()){
ListAuthorizedDomainsRequestrequest=
ListAuthorizedDomainsRequest.newBuilder()
.setParent("parent-995424086")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while(true){
ListAuthorizedDomainsResponseresponse=
authorizedDomainsClient.listAuthorizedDomainsCallable().call(request);
for(AuthorizedDomainelement:response.getDomainsList()){
// doThingsWith(element);
}
StringnextPageToken=response.getNextPageToken();
if(!Strings.isNullOrEmpty(nextPageToken)){
request=request.toBuilder().setPageToken(nextPageToken).build();
}else{
break;
}
}
}
Returns
Type Description
UnaryCallable<ListAuthorizedDomainsRequest,ListAuthorizedDomainsResponse>

listAuthorizedDomainsPagedCallable()

publicfinalUnaryCallable<ListAuthorizedDomainsRequest,AuthorizedDomainsClient.ListAuthorizedDomainsPagedResponse>listAuthorizedDomainsPagedCallable()

Lists all domains the user is authorized to administer.

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(AuthorizedDomainsClientauthorizedDomainsClient=AuthorizedDomainsClient.create()){
ListAuthorizedDomainsRequestrequest=
ListAuthorizedDomainsRequest.newBuilder()
.setParent("parent-995424086")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<AuthorizedDomain>future=
authorizedDomainsClient.listAuthorizedDomainsPagedCallable().futureCall(request);
// Do something.
for(AuthorizedDomainelement:future.get().iterateAll()){
// doThingsWith(element);
}
}
Returns
Type Description
UnaryCallable<ListAuthorizedDomainsRequest,ListAuthorizedDomainsPagedResponse>

shutdown()

publicvoidshutdown()

shutdownNow()

publicvoidshutdownNow()

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.