- 1.44.0 (latest)
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.6
- 0.7.0
- 0.6.1
- 0.5.4
public class DomainsClient implements BackgroundResource
Service Description: The Cloud Domains API enables management and configuration of domain names.
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 (DomainsClient domainsClient = DomainsClient.create()) {
LocationName location = LocationName.of("[PROJECT]", "[LOCATION]");
String query = "query107944136";
SearchDomainsResponse response = domainsClient.searchDomains(location, query);
}
Note: close() needs to be called on the DomainsClient 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:
- 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.
- 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.
- 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 DomainsSettings 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
DomainsSettings domainsSettings =
DomainsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
DomainsClient domainsClient = DomainsClient.create(domainsSettings);
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
DomainsSettings domainsSettings = DomainsSettings.newBuilder().setEndpoint(myEndpoint).build();
DomainsClient domainsClient = DomainsClient.create(domainsSettings);
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
DomainsSettings domainsSettings = DomainsSettings.newHttpJsonBuilder().build();
DomainsClient domainsClient = DomainsClient.create(domainsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final DomainsClient create()
Constructs an instance of DomainsClient with default settings.
Type | Description |
DomainsClient |
Type | Description |
IOException |
create(DomainsSettings settings)
public static final DomainsClient create(DomainsSettings settings)
Constructs an instance of DomainsClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Name | Description |
settings | DomainsSettings |
Type | Description |
DomainsClient |
Type | Description |
IOException |
create(DomainsStub stub)
public static final DomainsClient create(DomainsStub stub)
Constructs an instance of DomainsClient, using the given stub for making calls. This is for advanced usage - prefer using create(DomainsSettings).
Name | Description |
stub | DomainsStub |
Type | Description |
DomainsClient |
Constructors
DomainsClient(DomainsSettings settings)
protected DomainsClient(DomainsSettings settings)
Constructs an instance of DomainsClient, 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.
Name | Description |
settings | DomainsSettings |
DomainsClient(DomainsStub stub)
protected DomainsClient(DomainsStub stub)
Name | Description |
stub | DomainsStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
Type | Description |
InterruptedException |
close()
public final void close()
configureContactSettingsAsync(ConfigureContactSettingsRequest request)
public final OperationFuture<Registration,OperationMetadata> configureContactSettingsAsync(ConfigureContactSettingsRequest request)
Updates a Registration
's contact settings. Some changes require confirmation by the domain's
registrant contact .
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 (DomainsClient domainsClient = DomainsClient.create()) {
ConfigureContactSettingsRequest request =
ConfigureContactSettingsRequest.newBuilder()
.setRegistration(
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString())
.setContactSettings(ContactSettings.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.addAllContactNotices(new ArrayList<ContactNotice>())
.setValidateOnly(true)
.build();
Registration response = domainsClient.configureContactSettingsAsync(request).get();
}
Name | Description |
request | ConfigureContactSettingsRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Registration,OperationMetadata> |
configureContactSettingsAsync(RegistrationName registration, ContactSettings contactSettings, FieldMask updateMask)
public final OperationFuture<Registration,OperationMetadata> configureContactSettingsAsync(RegistrationName registration, ContactSettings contactSettings, FieldMask updateMask)
Updates a Registration
's contact settings. Some changes require confirmation by the domain's
registrant contact .
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 (DomainsClient domainsClient = DomainsClient.create()) {
RegistrationName registration =
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
ContactSettings contactSettings = ContactSettings.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Registration response =
domainsClient
.configureContactSettingsAsync(registration, contactSettings, updateMask)
.get();
}
Name | Description |
registration | RegistrationName Required. The name of the |
contactSettings | ContactSettings Fields of the |
updateMask | FieldMask Required. The field mask describing which fields to update as a
comma-separated list. For example, if only the registrant contact is being updated, the
|
Type | Description |
OperationFuture<Registration,OperationMetadata> |
configureContactSettingsAsync(String registration, ContactSettings contactSettings, FieldMask updateMask)
public final OperationFuture<Registration,OperationMetadata> configureContactSettingsAsync(String registration, ContactSettings contactSettings, FieldMask updateMask)
Updates a Registration
's contact settings. Some changes require confirmation by the domain's
registrant contact .
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 (DomainsClient domainsClient = DomainsClient.create()) {
String registration =
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString();
ContactSettings contactSettings = ContactSettings.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Registration response =
domainsClient
.configureContactSettingsAsync(registration, contactSettings, updateMask)
.get();
}
Name | Description |
registration | String Required. The name of the |
contactSettings | ContactSettings Fields of the |
updateMask | FieldMask Required. The field mask describing which fields to update as a
comma-separated list. For example, if only the registrant contact is being updated, the
|
Type | Description |
OperationFuture<Registration,OperationMetadata> |
configureContactSettingsCallable()
public final UnaryCallable<ConfigureContactSettingsRequest,Operation> configureContactSettingsCallable()
Updates a Registration
's contact settings. Some changes require confirmation by the domain's
registrant contact .
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 (DomainsClient domainsClient = DomainsClient.create()) {
ConfigureContactSettingsRequest request =
ConfigureContactSettingsRequest.newBuilder()
.setRegistration(
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString())
.setContactSettings(ContactSettings.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.addAllContactNotices(new ArrayList<ContactNotice>())
.setValidateOnly(true)
.build();
ApiFuture<Operation> future =
domainsClient.configureContactSettingsCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<ConfigureContactSettingsRequest,Operation> |
configureContactSettingsOperationCallable()
public final OperationCallable<ConfigureContactSettingsRequest,Registration,OperationMetadata> configureContactSettingsOperationCallable()
Updates a Registration
's contact settings. Some changes require confirmation by the domain's
registrant contact .
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 (DomainsClient domainsClient = DomainsClient.create()) {
ConfigureContactSettingsRequest request =
ConfigureContactSettingsRequest.newBuilder()
.setRegistration(
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString())
.setContactSettings(ContactSettings.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.addAllContactNotices(new ArrayList<ContactNotice>())
.setValidateOnly(true)
.build();
OperationFuture<Registration, OperationMetadata> future =
domainsClient.configureContactSettingsOperationCallable().futureCall(request);
// Do something.
Registration response = future.get();
}
Type | Description |
OperationCallable<ConfigureContactSettingsRequest,Registration,OperationMetadata> |
configureDnsSettingsAsync(ConfigureDnsSettingsRequest request)
public final OperationFuture<Registration,OperationMetadata> configureDnsSettingsAsync(ConfigureDnsSettingsRequest request)
Updates a Registration
's DNS settings.
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 (DomainsClient domainsClient = DomainsClient.create()) {
ConfigureDnsSettingsRequest request =
ConfigureDnsSettingsRequest.newBuilder()
.setRegistration(
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString())
.setDnsSettings(DnsSettings.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.setValidateOnly(true)
.build();
Registration response = domainsClient.configureDnsSettingsAsync(request).get();
}
Name | Description |
request | ConfigureDnsSettingsRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Registration,OperationMetadata> |
configureDnsSettingsAsync(RegistrationName registration, DnsSettings dnsSettings, FieldMask updateMask)
public final OperationFuture<Registration,OperationMetadata> configureDnsSettingsAsync(RegistrationName registration, DnsSettings dnsSettings, FieldMask updateMask)
Updates a Registration
's DNS settings.
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 (DomainsClient domainsClient = DomainsClient.create()) {
RegistrationName registration =
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
DnsSettings dnsSettings = DnsSettings.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Registration response =
domainsClient.configureDnsSettingsAsync(registration, dnsSettings, updateMask).get();
}
Name | Description |
registration | RegistrationName Required. The name of the |
dnsSettings | DnsSettings Fields of the |
updateMask | FieldMask Required. The field mask describing which fields to update as a
comma-separated list. For example, if only the name servers are being updated for an
existing Custom DNS configuration, the When changing the DNS provider from one type to another, pass the new provider's field
name as part of the field mask. For example, when changing from a Google Domains DNS
configuration to a Custom DNS configuration, the |
Type | Description |
OperationFuture<Registration,OperationMetadata> |
configureDnsSettingsAsync(String registration, DnsSettings dnsSettings, FieldMask updateMask)
public final OperationFuture<Registration,OperationMetadata> configureDnsSettingsAsync(String registration, DnsSettings dnsSettings, FieldMask updateMask)
Updates a Registration
's DNS settings.
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 (DomainsClient domainsClient = DomainsClient.create()) {
String registration =
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString();
DnsSettings dnsSettings = DnsSettings.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Registration response =
domainsClient.configureDnsSettingsAsync(registration, dnsSettings, updateMask).get();
}
Name | Description |
registration | String Required. The name of the |
dnsSettings | DnsSettings Fields of the |
updateMask | FieldMask Required. The field mask describing which fields to update as a
comma-separated list. For example, if only the name servers are being updated for an
existing Custom DNS configuration, the When changing the DNS provider from one type to another, pass the new provider's field
name as part of the field mask. For example, when changing from a Google Domains DNS
configuration to a Custom DNS configuration, the |
Type | Description |
OperationFuture<Registration,OperationMetadata> |
configureDnsSettingsCallable()
public final UnaryCallable<ConfigureDnsSettingsRequest,Operation> configureDnsSettingsCallable()
Updates a Registration
's DNS settings.
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 (DomainsClient domainsClient = DomainsClient.create()) {
ConfigureDnsSettingsRequest request =
ConfigureDnsSettingsRequest.newBuilder()
.setRegistration(
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString())
.setDnsSettings(DnsSettings.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.setValidateOnly(true)
.build();
ApiFuture<Operation> future =
domainsClient.configureDnsSettingsCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<ConfigureDnsSettingsRequest,Operation> |
configureDnsSettingsOperationCallable()
public final OperationCallable<ConfigureDnsSettingsRequest,Registration,OperationMetadata> configureDnsSettingsOperationCallable()
Updates a Registration
's DNS settings.
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 (DomainsClient domainsClient = DomainsClient.create()) {
ConfigureDnsSettingsRequest request =
ConfigureDnsSettingsRequest.newBuilder()
.setRegistration(
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString())
.setDnsSettings(DnsSettings.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.setValidateOnly(true)
.build();
OperationFuture<Registration, OperationMetadata> future =
domainsClient.configureDnsSettingsOperationCallable().futureCall(request);
// Do something.
Registration response = future.get();
}
Type | Description |
OperationCallable<ConfigureDnsSettingsRequest,Registration,OperationMetadata> |
configureManagementSettingsAsync(ConfigureManagementSettingsRequest request)
public final OperationFuture<Registration,OperationMetadata> configureManagementSettingsAsync(ConfigureManagementSettingsRequest request)
Updates a Registration
's management settings.
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 (DomainsClient domainsClient = DomainsClient.create()) {
ConfigureManagementSettingsRequest request =
ConfigureManagementSettingsRequest.newBuilder()
.setRegistration(
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString())
.setManagementSettings(ManagementSettings.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Registration response = domainsClient.configureManagementSettingsAsync(request).get();
}
Name | Description |
request | ConfigureManagementSettingsRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Registration,OperationMetadata> |
configureManagementSettingsAsync(RegistrationName registration, ManagementSettings managementSettings, FieldMask updateMask)
public final OperationFuture<Registration,OperationMetadata> configureManagementSettingsAsync(RegistrationName registration, ManagementSettings managementSettings, FieldMask updateMask)
Updates a Registration
's management settings.
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 (DomainsClient domainsClient = DomainsClient.create()) {
RegistrationName registration =
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
ManagementSettings managementSettings = ManagementSettings.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Registration response =
domainsClient
.configureManagementSettingsAsync(registration, managementSettings, updateMask)
.get();
}
Name | Description |
registration | RegistrationName Required. The name of the |
managementSettings | ManagementSettings Fields of the |
updateMask | FieldMask Required. The field mask describing which fields to update as a
comma-separated list. For example, if only the transfer lock is being updated, the
|
Type | Description |
OperationFuture<Registration,OperationMetadata> |
configureManagementSettingsAsync(String registration, ManagementSettings managementSettings, FieldMask updateMask)
public final OperationFuture<Registration,OperationMetadata> configureManagementSettingsAsync(String registration, ManagementSettings managementSettings, FieldMask updateMask)
Updates a Registration
's management settings.
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 (DomainsClient domainsClient = DomainsClient.create()) {
String registration =
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString();
ManagementSettings managementSettings = ManagementSettings.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Registration response =
domainsClient
.configureManagementSettingsAsync(registration, managementSettings, updateMask)
.get();
}
Name | Description |
registration | String Required. The name of the |
managementSettings | ManagementSettings Fields of the |
updateMask | FieldMask Required. The field mask describing which fields to update as a
comma-separated list. For example, if only the transfer lock is being updated, the
|
Type | Description |
OperationFuture<Registration,OperationMetadata> |
configureManagementSettingsCallable()
public final UnaryCallable<ConfigureManagementSettingsRequest,Operation> configureManagementSettingsCallable()
Updates a Registration
's management settings.
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 (DomainsClient domainsClient = DomainsClient.create()) {
ConfigureManagementSettingsRequest request =
ConfigureManagementSettingsRequest.newBuilder()
.setRegistration(
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString())
.setManagementSettings(ManagementSettings.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Operation> future =
domainsClient.configureManagementSettingsCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<ConfigureManagementSettingsRequest,Operation> |
configureManagementSettingsOperationCallable()
public final OperationCallable<ConfigureManagementSettingsRequest,Registration,OperationMetadata> configureManagementSettingsOperationCallable()
Updates a Registration
's management settings.
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 (DomainsClient domainsClient = DomainsClient.create()) {
ConfigureManagementSettingsRequest request =
ConfigureManagementSettingsRequest.newBuilder()
.setRegistration(
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString())
.setManagementSettings(ManagementSettings.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
OperationFuture<Registration, OperationMetadata> future =
domainsClient.configureManagementSettingsOperationCallable().futureCall(request);
// Do something.
Registration response = future.get();
}
Type | Description |
OperationCallable<ConfigureManagementSettingsRequest,Registration,OperationMetadata> |
deleteRegistrationAsync(DeleteRegistrationRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteRegistrationAsync(DeleteRegistrationRequest request)
Deletes a Registration
resource.
This method works on any Registration
resource using Subscription or Commitment
billing, provided that the resource was created at least 1
day in the past.
For Registration
resources using Monthly billing, this
method works if:
state
isEXPORTED
withexpire_time
in the paststate
isREGISTRATION_FAILED
state
isTRANSFER_FAILED
When an active registration is successfully deleted, you can continue to use the domain in Google Domains until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.
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 (DomainsClient domainsClient = DomainsClient.create()) {
DeleteRegistrationRequest request =
DeleteRegistrationRequest.newBuilder()
.setName(RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString())
.build();
domainsClient.deleteRegistrationAsync(request).get();
}
Name | Description |
request | DeleteRegistrationRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteRegistrationAsync(RegistrationName name)
public final OperationFuture<Empty,OperationMetadata> deleteRegistrationAsync(RegistrationName name)
Deletes a Registration
resource.
This method works on any Registration
resource using Subscription or Commitment
billing, provided that the resource was created at least 1
day in the past.
For Registration
resources using Monthly billing, this
method works if:
state
isEXPORTED
withexpire_time
in the paststate
isREGISTRATION_FAILED
state
isTRANSFER_FAILED
When an active registration is successfully deleted, you can continue to use the domain in Google Domains until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.
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 (DomainsClient domainsClient = DomainsClient.create()) {
RegistrationName name = RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
domainsClient.deleteRegistrationAsync(name).get();
}
Name | Description |
name | RegistrationName Required. The name of the |
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteRegistrationAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteRegistrationAsync(String name)
Deletes a Registration
resource.
This method works on any Registration
resource using Subscription or Commitment
billing, provided that the resource was created at least 1
day in the past.
For Registration
resources using Monthly billing, this
method works if:
state
isEXPORTED
withexpire_time
in the paststate
isREGISTRATION_FAILED
state
isTRANSFER_FAILED
When an active registration is successfully deleted, you can continue to use the domain in Google Domains until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.
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 (DomainsClient domainsClient = DomainsClient.create()) {
String name = RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString();
domainsClient.deleteRegistrationAsync(name).get();
}
Name | Description |
name | String Required. The name of the |
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteRegistrationCallable()
public final UnaryCallable<DeleteRegistrationRequest,Operation> deleteRegistrationCallable()
Deletes a Registration
resource.
This method works on any Registration
resource using Subscription or Commitment
billing, provided that the resource was created at least 1
day in the past.
For Registration
resources using Monthly billing, this
method works if:
state
isEXPORTED
withexpire_time
in the paststate
isREGISTRATION_FAILED
state
isTRANSFER_FAILED
When an active registration is successfully deleted, you can continue to use the domain in Google Domains until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.
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 (DomainsClient domainsClient = DomainsClient.create()) {
DeleteRegistrationRequest request =
DeleteRegistrationRequest.newBuilder()
.setName(RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString())
.build();
ApiFuture<Operation> future = domainsClient.deleteRegistrationCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
UnaryCallable<DeleteRegistrationRequest,Operation> |
deleteRegistrationOperationCallable()
public final OperationCallable<DeleteRegistrationRequest,Empty,OperationMetadata> deleteRegistrationOperationCallable()
Deletes a Registration
resource.
This method works on any Registration
resource using Subscription or Commitment
billing, provided that the resource was created at least 1
day in the past.
For Registration
resources using Monthly billing, this
method works if:
state
isEXPORTED
withexpire_time
in the paststate
isREGISTRATION_FAILED
state
isTRANSFER_FAILED
When an active registration is successfully deleted, you can continue to use the domain in Google Domains until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.
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 (DomainsClient domainsClient = DomainsClient.create()) {
DeleteRegistrationRequest request =
DeleteRegistrationRequest.newBuilder()
.setName(RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString())
.build();
OperationFuture<Empty, OperationMetadata> future =
domainsClient.deleteRegistrationOperationCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
OperationCallable<DeleteRegistrationRequest,Empty,OperationMetadata> |
exportRegistrationAsync(ExportRegistrationRequest request)
public final OperationFuture<Registration,OperationMetadata> exportRegistrationAsync(ExportRegistrationRequest request)
Exports a Registration
resource, such that it is no longer managed by Cloud Domains.
When an active domain is successfully exported, you can continue to use the domain in Google Domains until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.
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 (DomainsClient domainsClient = DomainsClient.create()) {
ExportRegistrationRequest request =
ExportRegistrationRequest.newBuilder()
.setName(RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString())
.build();
Registration response = domainsClient.exportRegistrationAsync(request).get();
}
Name | Description |
request | ExportRegistrationRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Registration,OperationMetadata> |
exportRegistrationAsync(RegistrationName name)
public final OperationFuture<Registration,OperationMetadata> exportRegistrationAsync(RegistrationName name)
Exports a Registration
resource, such that it is no longer managed by Cloud Domains.
When an active domain is successfully exported, you can continue to use the domain in Google Domains until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.
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 (DomainsClient domainsClient = DomainsClient.create()) {
RegistrationName name = RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
Registration response = domainsClient.exportRegistrationAsync(name).get();
}
Name | Description |
name | RegistrationName Required. The name of the |
Type | Description |
OperationFuture<Registration,OperationMetadata> |
exportRegistrationAsync(String name)
public final OperationFuture<Registration,OperationMetadata> exportRegistrationAsync(String name)
Exports a Registration
resource, such that it is no longer managed by Cloud Domains.
When an active domain is successfully exported, you can continue to use the domain in Google Domains until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.
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 (DomainsClient domainsClient = DomainsClient.create()) {
String name = RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString();
Registration response = domainsClient.exportRegistrationAsync(name).get();
}
Name | Description |
name | String Required. The name of the |
Type | Description |
OperationFuture<Registration,OperationMetadata> |
exportRegistrationCallable()
public final UnaryCallable<ExportRegistrationRequest,Operation> exportRegistrationCallable()
Exports a Registration
resource, such that it is no longer managed by Cloud Domains.
When an active domain is successfully exported, you can continue to use the domain in Google Domains until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.
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 (DomainsClient domainsClient = DomainsClient.create()) {
ExportRegistrationRequest request =
ExportRegistrationRequest.newBuilder()
.setName(RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString())
.build();
ApiFuture<Operation> future = domainsClient.exportRegistrationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<ExportRegistrationRequest,Operation> |
exportRegistrationOperationCallable()
public final OperationCallable<ExportRegistrationRequest,Registration,OperationMetadata> exportRegistrationOperationCallable()
Exports a Registration
resource, such that it is no longer managed by Cloud Domains.
When an active domain is successfully exported, you can continue to use the domain in Google Domains until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.
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 (DomainsClient domainsClient = DomainsClient.create()) {
ExportRegistrationRequest request =
ExportRegistrationRequest.newBuilder()
.setName(RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString())
.build();
OperationFuture<Registration, OperationMetadata> future =
domainsClient.exportRegistrationOperationCallable().futureCall(request);
// Do something.
Registration response = future.get();
}
Type | Description |
OperationCallable<ExportRegistrationRequest,Registration,OperationMetadata> |
getHttpJsonOperationsClient()
public final OperationsClient getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Type | Description |
OperationsClient |
getOperationsClient()
public final OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Type | Description |
OperationsClient |
getRegistration(GetRegistrationRequest request)
public final Registration getRegistration(GetRegistrationRequest request)
Gets the details of a Registration
resource.
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 (DomainsClient domainsClient = DomainsClient.create()) {
GetRegistrationRequest request =
GetRegistrationRequest.newBuilder()
.setName(RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString())
.build();
Registration response = domainsClient.getRegistration(request);
}
Name | Description |
request | GetRegistrationRequest The request object containing all of the parameters for the API call. |
Type | Description |
Registration |
getRegistration(RegistrationName name)
public final Registration getRegistration(RegistrationName name)
Gets the details of a Registration
resource.
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 (DomainsClient domainsClient = DomainsClient.create()) {
RegistrationName name = RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
Registration response = domainsClient.getRegistration(name);
}
Name | Description |
name | RegistrationName Required. The name of the |
Type | Description |
Registration |
getRegistration(String name)
public final Registration getRegistration(String name)
Gets the details of a Registration
resource.
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 (DomainsClient domainsClient = DomainsClient.create()) {
String name = RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString();
Registration response = domainsClient.getRegistration(name);
}
Name | Description |
name | String Required. The name of the |
Type | Description |
Registration |
getRegistrationCallable()
public final UnaryCallable<GetRegistrationRequest,Registration> getRegistrationCallable()
Gets the details of a Registration
resource.
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 (DomainsClient domainsClient = DomainsClient.create()) {
GetRegistrationRequest request =
GetRegistrationRequest.newBuilder()
.setName(RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString())
.build();
ApiFuture<Registration> future = domainsClient.getRegistrationCallable().futureCall(request);
// Do something.
Registration response = future.get();
}
Type | Description |
UnaryCallable<GetRegistrationRequest,Registration> |
getSettings()
public final DomainsSettings getSettings()
Type | Description |
DomainsSettings |
getStub()
public DomainsStub getStub()
Type | Description |
DomainsStub |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
listRegistrations(ListRegistrationsRequest request)
public final DomainsClient.ListRegistrationsPagedResponse listRegistrations(ListRegistrationsRequest request)
Lists the Registration
resources in a project.
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 (DomainsClient domainsClient = DomainsClient.create()) {
ListRegistrationsRequest request =
ListRegistrationsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
for (Registration element : domainsClient.listRegistrations(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListRegistrationsRequest The request object containing all of the parameters for the API call. |
Type | Description |
DomainsClient.ListRegistrationsPagedResponse |
listRegistrations(LocationName parent)
public final DomainsClient.ListRegistrationsPagedResponse listRegistrations(LocationName parent)
Lists the Registration
resources in a project.
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 (DomainsClient domainsClient = DomainsClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Registration element : domainsClient.listRegistrations(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | LocationName Required. The project and location from which to list |
Type | Description |
DomainsClient.ListRegistrationsPagedResponse |
listRegistrations(String parent)
public final DomainsClient.ListRegistrationsPagedResponse listRegistrations(String parent)
Lists the Registration
resources in a project.
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 (DomainsClient domainsClient = DomainsClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Registration element : domainsClient.listRegistrations(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The project and location from which to list |
Type | Description |
DomainsClient.ListRegistrationsPagedResponse |
listRegistrationsCallable()
public final UnaryCallable<ListRegistrationsRequest,ListRegistrationsResponse> listRegistrationsCallable()
Lists the Registration
resources in a project.
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 (DomainsClient domainsClient = DomainsClient.create()) {
ListRegistrationsRequest request =
ListRegistrationsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
while (true) {
ListRegistrationsResponse response =
domainsClient.listRegistrationsCallable().call(request);
for (Registration element : response.getRegistrationsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListRegistrationsRequest,ListRegistrationsResponse> |
listRegistrationsPagedCallable()
public final UnaryCallable<ListRegistrationsRequest,DomainsClient.ListRegistrationsPagedResponse> listRegistrationsPagedCallable()
Lists the Registration
resources in a project.
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 (DomainsClient domainsClient = DomainsClient.create()) {
ListRegistrationsRequest request =
ListRegistrationsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
ApiFuture<Registration> future =
domainsClient.listRegistrationsPagedCallable().futureCall(request);
// Do something.
for (Registration element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<ListRegistrationsRequest,ListRegistrationsPagedResponse> |
registerDomainAsync(LocationName parent, Registration registration, Money yearlyPrice)
public final OperationFuture<Registration,OperationMetadata> registerDomainAsync(LocationName parent, Registration registration, Money yearlyPrice)
Registers a new domain name and creates a corresponding Registration
resource.
Call RetrieveRegisterParameters
first to check availability of the domain name and
determine parameters like price that are needed to build a call to this method.
A successful call creates a Registration
resource in state REGISTRATION_PENDING
, which
resolves to ACTIVE
within 1-2 minutes, indicating that the domain was successfully
registered. If the resource ends up in state REGISTRATION_FAILED
, it indicates that the
domain was not registered successfully, and you can safely delete the resource and retry
registration.
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 (DomainsClient domainsClient = DomainsClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Registration registration = Registration.newBuilder().build();
Money yearlyPrice = Money.newBuilder().build();
Registration response =
domainsClient.registerDomainAsync(parent, registration, yearlyPrice).get();
}
Name | Description |
parent | LocationName Required. The parent resource of the |
registration | Registration Required. The complete |
yearlyPrice | com.google.type.Money Required. Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls. |
Type | Description |
OperationFuture<Registration,OperationMetadata> |
registerDomainAsync(RegisterDomainRequest request)
public final OperationFuture<Registration,OperationMetadata> registerDomainAsync(RegisterDomainRequest request)
Registers a new domain name and creates a corresponding Registration
resource.
Call RetrieveRegisterParameters
first to check availability of the domain name and
determine parameters like price that are needed to build a call to this method.
A successful call creates a Registration
resource in state REGISTRATION_PENDING
, which
resolves to ACTIVE
within 1-2 minutes, indicating that the domain was successfully
registered. If the resource ends up in state REGISTRATION_FAILED
, it indicates that the
domain was not registered successfully, and you can safely delete the resource and retry
registration.
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 (DomainsClient domainsClient = DomainsClient.create()) {
RegisterDomainRequest request =
RegisterDomainRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setRegistration(Registration.newBuilder().build())
.addAllDomainNotices(new ArrayList<DomainNotice>())
.addAllContactNotices(new ArrayList<ContactNotice>())
.setYearlyPrice(Money.newBuilder().build())
.setValidateOnly(true)
.build();
Registration response = domainsClient.registerDomainAsync(request).get();
}
Name | Description |
request | RegisterDomainRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Registration,OperationMetadata> |
registerDomainAsync(String parent, Registration registration, Money yearlyPrice)
public final OperationFuture<Registration,OperationMetadata> registerDomainAsync(String parent, Registration registration, Money yearlyPrice)
Registers a new domain name and creates a corresponding Registration
resource.
Call RetrieveRegisterParameters
first to check availability of the domain name and
determine parameters like price that are needed to build a call to this method.
A successful call creates a Registration
resource in state REGISTRATION_PENDING
, which
resolves to ACTIVE
within 1-2 minutes, indicating that the domain was successfully
registered. If the resource ends up in state REGISTRATION_FAILED
, it indicates that the
domain was not registered successfully, and you can safely delete the resource and retry
registration.
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 (DomainsClient domainsClient = DomainsClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Registration registration = Registration.newBuilder().build();
Money yearlyPrice = Money.newBuilder().build();
Registration response =
domainsClient.registerDomainAsync(parent, registration, yearlyPrice).get();
}
Name | Description |
parent | String Required. The parent resource of the |
registration | Registration Required. The complete |
yearlyPrice | com.google.type.Money Required. Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls. |
Type | Description |
OperationFuture<Registration,OperationMetadata> |
registerDomainCallable()
public final UnaryCallable<RegisterDomainRequest,Operation> registerDomainCallable()
Registers a new domain name and creates a corresponding Registration
resource.
Call RetrieveRegisterParameters
first to check availability of the domain name and
determine parameters like price that are needed to build a call to this method.
A successful call creates a Registration
resource in state REGISTRATION_PENDING
, which
resolves to ACTIVE
within 1-2 minutes, indicating that the domain was successfully
registered. If the resource ends up in state REGISTRATION_FAILED
, it indicates that the
domain was not registered successfully, and you can safely delete the resource and retry
registration.
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 (DomainsClient domainsClient = DomainsClient.create()) {
RegisterDomainRequest request =
RegisterDomainRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setRegistration(Registration.newBuilder().build())
.addAllDomainNotices(new ArrayList<DomainNotice>())
.addAllContactNotices(new ArrayList<ContactNotice>())
.setYearlyPrice(Money.newBuilder().build())
.setValidateOnly(true)
.build();
ApiFuture<Operation> future = domainsClient.registerDomainCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<RegisterDomainRequest,Operation> |
registerDomainOperationCallable()
public final OperationCallable<RegisterDomainRequest,Registration,OperationMetadata> registerDomainOperationCallable()
Registers a new domain name and creates a corresponding Registration
resource.
Call RetrieveRegisterParameters
first to check availability of the domain name and
determine parameters like price that are needed to build a call to this method.
A successful call creates a Registration
resource in state REGISTRATION_PENDING
, which
resolves to ACTIVE
within 1-2 minutes, indicating that the domain was successfully
registered. If the resource ends up in state REGISTRATION_FAILED
, it indicates that the
domain was not registered successfully, and you can safely delete the resource and retry
registration.
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 (DomainsClient domainsClient = DomainsClient.create()) {
RegisterDomainRequest request =
RegisterDomainRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setRegistration(Registration.newBuilder().build())
.addAllDomainNotices(new ArrayList<DomainNotice>())
.addAllContactNotices(new ArrayList<ContactNotice>())
.setYearlyPrice(Money.newBuilder().build())
.setValidateOnly(true)
.build();
OperationFuture<Registration, OperationMetadata> future =
domainsClient.registerDomainOperationCallable().futureCall(request);
// Do something.
Registration response = future.get();
}
Type | Description |
OperationCallable<RegisterDomainRequest,Registration,OperationMetadata> |
resetAuthorizationCode(RegistrationName registration)
public final AuthorizationCode resetAuthorizationCode(RegistrationName registration)
Resets the authorization code of the Registration
to a new random string.
You can call this method only after 60 days have elapsed since the initial domain registration.
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 (DomainsClient domainsClient = DomainsClient.create()) {
RegistrationName registration =
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
AuthorizationCode response = domainsClient.resetAuthorizationCode(registration);
}
Name | Description |
registration | RegistrationName Required. The name of the |
Type | Description |
AuthorizationCode |
resetAuthorizationCode(ResetAuthorizationCodeRequest request)
public final AuthorizationCode resetAuthorizationCode(ResetAuthorizationCodeRequest request)
Resets the authorization code of the Registration
to a new random string.
You can call this method only after 60 days have elapsed since the initial domain registration.
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 (DomainsClient domainsClient = DomainsClient.create()) {
ResetAuthorizationCodeRequest request =
ResetAuthorizationCodeRequest.newBuilder()
.setRegistration(
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString())
.build();
AuthorizationCode response = domainsClient.resetAuthorizationCode(request);
}
Name | Description |
request | ResetAuthorizationCodeRequest The request object containing all of the parameters for the API call. |
Type | Description |
AuthorizationCode |
resetAuthorizationCode(String registration)
public final AuthorizationCode resetAuthorizationCode(String registration)
Resets the authorization code of the Registration
to a new random string.
You can call this method only after 60 days have elapsed since the initial domain registration.
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 (DomainsClient domainsClient = DomainsClient.create()) {
String registration =
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString();
AuthorizationCode response = domainsClient.resetAuthorizationCode(registration);
}
Name | Description |
registration | String Required. The name of the |
Type | Description |
AuthorizationCode |
resetAuthorizationCodeCallable()
public final UnaryCallable<ResetAuthorizationCodeRequest,AuthorizationCode> resetAuthorizationCodeCallable()
Resets the authorization code of the Registration
to a new random string.
You can call this method only after 60 days have elapsed since the initial domain registration.
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 (DomainsClient domainsClient = DomainsClient.create()) {
ResetAuthorizationCodeRequest request =
ResetAuthorizationCodeRequest.newBuilder()
.setRegistration(
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString())
.build();
ApiFuture<AuthorizationCode> future =
domainsClient.resetAuthorizationCodeCallable().futureCall(request);
// Do something.
AuthorizationCode response = future.get();
}
Type | Description |
UnaryCallable<ResetAuthorizationCodeRequest,AuthorizationCode> |
retrieveAuthorizationCode(RegistrationName registration)
public final AuthorizationCode retrieveAuthorizationCode(RegistrationName registration)
Gets the authorization code of the Registration
for the purpose of transferring the domain to
another registrar.
You can call this method only after 60 days have elapsed since the initial domain registration.
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 (DomainsClient domainsClient = DomainsClient.create()) {
RegistrationName registration =
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]");
AuthorizationCode response = domainsClient.retrieveAuthorizationCode(registration);
}
Name | Description |
registration | RegistrationName Required. The name of the |
Type | Description |
AuthorizationCode |
retrieveAuthorizationCode(RetrieveAuthorizationCodeRequest request)
public final AuthorizationCode retrieveAuthorizationCode(RetrieveAuthorizationCodeRequest request)
Gets the authorization code of the Registration
for the purpose of transferring the domain to
another registrar.
You can call this method only after 60 days have elapsed since the initial domain registration.
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 (DomainsClient domainsClient = DomainsClient.create()) {
RetrieveAuthorizationCodeRequest request =
RetrieveAuthorizationCodeRequest.newBuilder()
.setRegistration(
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString())
.build();
AuthorizationCode response = domainsClient.retrieveAuthorizationCode(request);
}
Name | Description |
request | RetrieveAuthorizationCodeRequest The request object containing all of the parameters for the API call. |
Type | Description |
AuthorizationCode |
retrieveAuthorizationCode(String registration)
public final AuthorizationCode retrieveAuthorizationCode(String registration)
Gets the authorization code of the Registration
for the purpose of transferring the domain to
another registrar.
You can call this method only after 60 days have elapsed since the initial domain registration.
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 (DomainsClient domainsClient = DomainsClient.create()) {
String registration =
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString();
AuthorizationCode response = domainsClient.retrieveAuthorizationCode(registration);
}
Name | Description |
registration | String Required. The name of the |
Type | Description |
AuthorizationCode |
retrieveAuthorizationCodeCallable()
public final UnaryCallable<RetrieveAuthorizationCodeRequest,AuthorizationCode> retrieveAuthorizationCodeCallable()
Gets the authorization code of the Registration
for the purpose of transferring the domain to
another registrar.
You can call this method only after 60 days have elapsed since the initial domain registration.
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 (DomainsClient domainsClient = DomainsClient.create()) {
RetrieveAuthorizationCodeRequest request =
RetrieveAuthorizationCodeRequest.newBuilder()
.setRegistration(
RegistrationName.of("[PROJECT]", "[LOCATION]", "[REGISTRATION]").toString())
.build();
ApiFuture<AuthorizationCode> future =
domainsClient.retrieveAuthorizationCodeCallable().futureCall(request);
// Do something.
AuthorizationCode response = future.get();
}
Type | Description |
UnaryCallable<RetrieveAuthorizationCodeRequest,AuthorizationCode> |
retrieveRegisterParameters(LocationName location, String domainName)
public final RetrieveRegisterParametersResponse retrieveRegisterParameters(LocationName location, String domainName)
Gets parameters needed to register a new domain name, including price and up-to-date
availability. Use the returned values to call RegisterDomain
.
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 (DomainsClient domainsClient = DomainsClient.create()) {
LocationName location = LocationName.of("[PROJECT]", "[LOCATION]");
String domainName = "domainName-1244085905";
RetrieveRegisterParametersResponse response =
domainsClient.retrieveRegisterParameters(location, domainName);
}
Name | Description |
location | LocationName Required. The location. Must be in the format |
domainName | String Required. The domain name. Unicode domain names must be expressed in Punycode format. |
Type | Description |
RetrieveRegisterParametersResponse |
retrieveRegisterParameters(RetrieveRegisterParametersRequest request)
public final RetrieveRegisterParametersResponse retrieveRegisterParameters(RetrieveRegisterParametersRequest request)
Gets parameters needed to register a new domain name, including price and up-to-date
availability. Use the returned values to call RegisterDomain
.
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 (DomainsClient domainsClient = DomainsClient.create()) {
RetrieveRegisterParametersRequest request =
RetrieveRegisterParametersRequest.newBuilder()
.setDomainName("domainName-1244085905")
.setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.build();
RetrieveRegisterParametersResponse response =
domainsClient.retrieveRegisterParameters(request);
}
Name | Description |
request | RetrieveRegisterParametersRequest The request object containing all of the parameters for the API call. |
Type | Description |
RetrieveRegisterParametersResponse |
retrieveRegisterParameters(String location, String domainName)
public final RetrieveRegisterParametersResponse retrieveRegisterParameters(String location, String domainName)
Gets parameters needed to register a new domain name, including price and up-to-date
availability. Use the returned values to call RegisterDomain
.
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 (DomainsClient domainsClient = DomainsClient.create()) {
String location = LocationName.of("[PROJECT]", "[LOCATION]").toString();
String domainName = "domainName-1244085905";
RetrieveRegisterParametersResponse response =
domainsClient.retrieveRegisterParameters(location, domainName);
}
Name | Description |
location | String Required. The location. Must be in the format |
domainName | String Required. The domain name. Unicode domain names must be expressed in Punycode format. |
Type | Description |
RetrieveRegisterParametersResponse |
retrieveRegisterParametersCallable()
public final UnaryCallable<RetrieveRegisterParametersRequest,RetrieveRegisterParametersResponse> retrieveRegisterParametersCallable()
Gets parameters needed to register a new domain name, including price and up-to-date
availability. Use the returned values to call RegisterDomain
.
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 (DomainsClient domainsClient = DomainsClient.create()) {
RetrieveRegisterParametersRequest request =
RetrieveRegisterParametersRequest.newBuilder()
.setDomainName("domainName-1244085905")
.setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.build();
ApiFuture<RetrieveRegisterParametersResponse> future =
domainsClient.retrieveRegisterParametersCallable().futureCall(request);
// Do something.
RetrieveRegisterParametersResponse response = future.get();
}
Type | Description |
UnaryCallable<RetrieveRegisterParametersRequest,RetrieveRegisterParametersResponse> |
retrieveTransferParameters(LocationName location, String domainName)
public final RetrieveTransferParametersResponse retrieveTransferParameters(LocationName location, String domainName)
Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.
Use the returned values to call TransferDomain
.
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 (DomainsClient domainsClient = DomainsClient.create()) {
LocationName location = LocationName.of("[PROJECT]", "[LOCATION]");
String domainName = "domainName-1244085905";
RetrieveTransferParametersResponse response =
domainsClient.retrieveTransferParameters(location, domainName);
}
Name | Description |
location | LocationName Required. The location. Must be in the format |
domainName | String Required. The domain name. Unicode domain names must be expressed in Punycode format. |
Type | Description |
RetrieveTransferParametersResponse |
retrieveTransferParameters(RetrieveTransferParametersRequest request)
public final RetrieveTransferParametersResponse retrieveTransferParameters(RetrieveTransferParametersRequest request)
Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.
Use the returned values to call TransferDomain
.
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 (DomainsClient domainsClient = DomainsClient.create()) {
RetrieveTransferParametersRequest request =
RetrieveTransferParametersRequest.newBuilder()
.setDomainName("domainName-1244085905")
.setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.build();
RetrieveTransferParametersResponse response =
domainsClient.retrieveTransferParameters(request);
}
Name | Description |
request | RetrieveTransferParametersRequest The request object containing all of the parameters for the API call. |
Type | Description |
RetrieveTransferParametersResponse |
retrieveTransferParameters(String location, String domainName)
public final RetrieveTransferParametersResponse retrieveTransferParameters(String location, String domainName)
Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.
Use the returned values to call TransferDomain
.
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 (DomainsClient domainsClient = DomainsClient.create()) {
String location = LocationName.of("[PROJECT]", "[LOCATION]").toString();
String domainName = "domainName-1244085905";
RetrieveTransferParametersResponse response =
domainsClient.retrieveTransferParameters(location, domainName);
}
Name | Description |
location | String Required. The location. Must be in the format |
domainName | String Required. The domain name. Unicode domain names must be expressed in Punycode format. |
Type | Description |
RetrieveTransferParametersResponse |
retrieveTransferParametersCallable()
public final UnaryCallable<RetrieveTransferParametersRequest,RetrieveTransferParametersResponse> retrieveTransferParametersCallable()
Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.
Use the returned values to call TransferDomain
.
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 (DomainsClient domainsClient = DomainsClient.create()) {
RetrieveTransferParametersRequest request =
RetrieveTransferParametersRequest.newBuilder()
.setDomainName("domainName-1244085905")
.setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.build();
ApiFuture<RetrieveTransferParametersResponse> future =
domainsClient.retrieveTransferParametersCallable().futureCall(request);
// Do something.
RetrieveTransferParametersResponse response = future.get();
}
Type | Description |
UnaryCallable<RetrieveTransferParametersRequest,RetrieveTransferParametersResponse> |
searchDomains(LocationName location, String query)
public final SearchDomainsResponse searchDomains(LocationName location, String query)
Searches for available domain names similar to the provided query.
Availability results from this method are approximate; call RetrieveRegisterParameters
on
a domain before registering to confirm availability.
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 (DomainsClient domainsClient = DomainsClient.create()) {
LocationName location = LocationName.of("[PROJECT]", "[LOCATION]");
String query = "query107944136";
SearchDomainsResponse response = domainsClient.searchDomains(location, query);
}
Name | Description |
location | LocationName Required. The location. Must be in the format |
query | String Required. String used to search for available domain names. |
Type | Description |
SearchDomainsResponse |
searchDomains(SearchDomainsRequest request)
public final SearchDomainsResponse searchDomains(SearchDomainsRequest request)
Searches for available domain names similar to the provided query.
Availability results from this method are approximate; call RetrieveRegisterParameters
on
a domain before registering to confirm availability.
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 (DomainsClient domainsClient = DomainsClient.create()) {
SearchDomainsRequest request =
SearchDomainsRequest.newBuilder()
.setQuery("query107944136")
.setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.build();
SearchDomainsResponse response = domainsClient.searchDomains(request);
}
Name | Description |
request | SearchDomainsRequest The request object containing all of the parameters for the API call. |
Type | Description |
SearchDomainsResponse |
searchDomains(String location, String query)
public final SearchDomainsResponse searchDomains(String location, String query)
Searches for available domain names similar to the provided query.
Availability results from this method are approximate; call RetrieveRegisterParameters
on
a domain before registering to confirm availability.
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 (DomainsClient domainsClient = DomainsClient.create()) {
String location = LocationName.of("[PROJECT]", "[LOCATION]").toString();
String query = "query107944136";
SearchDomainsResponse response = domainsClient.searchDomains(location, query);
}
Name | Description |
location | String Required. The location. Must be in the format |
query | String Required. String used to search for available domain names. |
Type | Description |
SearchDomainsResponse |
searchDomainsCallable()
public final UnaryCallable<SearchDomainsRequest,SearchDomainsResponse> searchDomainsCallable()
Searches for available domain names similar to the provided query.
Availability results from this method are approximate; call RetrieveRegisterParameters
on
a domain before registering to confirm availability.
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 (DomainsClient domainsClient = DomainsClient.create()) {
SearchDomainsRequest request =
SearchDomainsRequest.newBuilder()
.setQuery("query107944136")
.setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.build();
ApiFuture<SearchDomainsResponse> future =
domainsClient.searchDomainsCallable().futureCall(request);
// Do something.
SearchDomainsResponse response = future.get();
}
Type | Description |
UnaryCallable<SearchDomainsRequest,SearchDomainsResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
transferDomainAsync(LocationName parent, Registration registration, Money yearlyPrice, AuthorizationCode authorizationCode)
public final OperationFuture<Registration,OperationMetadata> transferDomainAsync(LocationName parent, Registration registration, Money yearlyPrice, AuthorizationCode authorizationCode)
Transfers a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.
Before calling this method, go to the domain's current registrar to unlock the domain for
transfer and retrieve the domain's transfer authorization code. Then call
RetrieveTransferParameters
to confirm that the domain is unlocked and to get values needed to
build a call to this method.
A successful call creates a Registration
resource in state TRANSFER_PENDING
. It can take
several days to complete the transfer process. The registrant can often speed up this process
by approving the transfer through the current registrar, either by clicking a link in an email
from the registrar or by visiting the registrar's website.
A few minutes after transfer approval, the resource transitions to state ACTIVE
,
indicating that the transfer was successful. If the transfer is rejected or the request expires
without being approved, the resource can end up in state TRANSFER_FAILED
. If transfer fails,
you can safely delete the resource and retry the transfer.
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 (DomainsClient domainsClient = DomainsClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Registration registration = Registration.newBuilder().build();
Money yearlyPrice = Money.newBuilder().build();
AuthorizationCode authorizationCode = AuthorizationCode.newBuilder().build();
Registration response =
domainsClient
.transferDomainAsync(parent, registration, yearlyPrice, authorizationCode)
.get();
}
Name | Description |
parent | LocationName Required. The parent resource of the |
registration | Registration Required. The complete You can leave |
yearlyPrice | com.google.type.Money Required. Acknowledgement of the price to transfer or renew the domain for
one year. Call |
authorizationCode | AuthorizationCode The domain's transfer authorization code. You can obtain this from the domain's current registrar. |
Type | Description |
OperationFuture<Registration,OperationMetadata> |
transferDomainAsync(TransferDomainRequest request)
public final OperationFuture<Registration,OperationMetadata> transferDomainAsync(TransferDomainRequest request)
Transfers a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.
Before calling this method, go to the domain's current registrar to unlock the domain for
transfer and retrieve the domain's transfer authorization code. Then call
RetrieveTransferParameters
to confirm that the domain is unlocked and to get values needed to
build a call to this method.
A successful call creates a Registration
resource in state TRANSFER_PENDING
. It can take
several days to complete the transfer process. The registrant can often speed up this process
by approving the transfer through the current registrar, either by clicking a link in an email
from the registrar or by visiting the registrar's website.
A few minutes after transfer approval, the resource transitions to state ACTIVE
,
indicating that the transfer was successful. If the transfer is rejected or the request expires
without being approved, the resource can end up in state TRANSFER_FAILED
. If transfer fails,
you can safely delete the resource and retry the transfer.
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 (DomainsClient domainsClient = DomainsClient.create()) {
TransferDomainRequest request =
TransferDomainRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setRegistration(Registration.newBuilder().build())
.addAllContactNotices(new ArrayList<ContactNotice>())
.setYearlyPrice(Money.newBuilder().build())
.setAuthorizationCode(AuthorizationCode.newBuilder().build())
.setValidateOnly(true)
.build();
Registration response = domainsClient.transferDomainAsync(request).get();
}
Name | Description |
request | TransferDomainRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Registration,OperationMetadata> |
transferDomainAsync(String parent, Registration registration, Money yearlyPrice, AuthorizationCode authorizationCode)
public final OperationFuture<Registration,OperationMetadata> transferDomainAsync(String parent, Registration registration, Money yearlyPrice, AuthorizationCode authorizationCode)
Transfers a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.
Before calling this method, go to the domain's current registrar to unlock the domain for
transfer and retrieve the domain's transfer authorization code. Then call
RetrieveTransferParameters
to confirm that the domain is unlocked and to get values needed to
build a call to this method.
A successful call creates a Registration
resource in state TRANSFER_PENDING
. It can take
several days to complete the transfer process. The registrant can often speed up this process
by approving the transfer through the current registrar, either by clicking a link in an email
from the registrar or by visiting the registrar's website.
A few minutes after transfer approval, the resource transitions to state ACTIVE
,
indicating that the transfer was successful. If the transfer is rejected or the request expires
without being approved, the resource can end up in state TRANSFER_FAILED
. If transfer fails,
you can safely delete the resource and retry the transfer.
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 (DomainsClient domainsClient = DomainsClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Registration registration = Registration.newBuilder().build();
Money yearlyPrice = Money.newBuilder().build();
AuthorizationCode authorizationCode = AuthorizationCode.newBuilder().build();
Registration response =
domainsClient
.transferDomainAsync(parent, registration, yearlyPrice, authorizationCode)
.get();
}
Name | Description |
parent | String Required. The parent resource of the |
registration | Registration Required. The complete You can leave |
yearlyPrice | com.google.type.Money Required. Acknowledgement of the price to transfer or renew the domain for
one year. Call |
authorizationCode | AuthorizationCode The domain's transfer authorization code. You can obtain this from the domain's current registrar. |
Type | Description |
OperationFuture<Registration,OperationMetadata> |
transferDomainCallable()
public final UnaryCallable<TransferDomainRequest,Operation> transferDomainCallable()
Transfers a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.
Before calling this method, go to the domain's current registrar to unlock the domain for
transfer and retrieve the domain's transfer authorization code. Then call
RetrieveTransferParameters
to confirm that the domain is unlocked and to get values needed to
build a call to this method.
A successful call creates a Registration
resource in state TRANSFER_PENDING
. It can take
several days to complete the transfer process. The registrant can often speed up this process
by approving the transfer through the current registrar, either by clicking a link in an email
from the registrar or by visiting the registrar's website.
A few minutes after transfer approval, the resource transitions to state ACTIVE
,
indicating that the transfer was successful. If the transfer is rejected or the request expires
without being approved, the resource can end up in state TRANSFER_FAILED
. If transfer fails,
you can safely delete the resource and retry the transfer.
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 (DomainsClient domainsClient = DomainsClient.create()) {
TransferDomainRequest request =
TransferDomainRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setRegistration(Registration.newBuilder().build())
.addAllContactNotices(new ArrayList<ContactNotice>())
.setYearlyPrice(Money.newBuilder().build())
.setAuthorizationCode(AuthorizationCode.newBuilder().build())
.setValidateOnly(true)
.build();
ApiFuture<Operation> future = domainsClient.transferDomainCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<TransferDomainRequest,Operation> |
transferDomainOperationCallable()
public final OperationCallable<TransferDomainRequest,Registration,OperationMetadata> transferDomainOperationCallable()
Transfers a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not supported.
Before calling this method, go to the domain's current registrar to unlock the domain for
transfer and retrieve the domain's transfer authorization code. Then call
RetrieveTransferParameters
to confirm that the domain is unlocked and to get values needed to
build a call to this method.
A successful call creates a Registration
resource in state TRANSFER_PENDING
. It can take
several days to complete the transfer process. The registrant can often speed up this process
by approving the transfer through the current registrar, either by clicking a link in an email
from the registrar or by visiting the registrar's website.
A few minutes after transfer approval, the resource transitions to state ACTIVE
,
indicating that the transfer was successful. If the transfer is rejected or the request expires
without being approved, the resource can end up in state TRANSFER_FAILED
. If transfer fails,
you can safely delete the resource and retry the transfer.
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 (DomainsClient domainsClient = DomainsClient.create()) {
TransferDomainRequest request =
TransferDomainRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setRegistration(Registration.newBuilder().build())
.addAllContactNotices(new ArrayList<ContactNotice>())
.setYearlyPrice(Money.newBuilder().build())
.setAuthorizationCode(AuthorizationCode.newBuilder().build())
.setValidateOnly(true)
.build();
OperationFuture<Registration, OperationMetadata> future =
domainsClient.transferDomainOperationCallable().futureCall(request);
// Do something.
Registration response = future.get();
}
Type | Description |
OperationCallable<TransferDomainRequest,Registration,OperationMetadata> |
updateRegistrationAsync(Registration registration, FieldMask updateMask)
public final OperationFuture<Registration,OperationMetadata> updateRegistrationAsync(Registration registration, FieldMask updateMask)
Updates select fields of a Registration
resource, notably labels
. To update other fields,
use the appropriate custom update method:
- To update management settings, see
ConfigureManagementSettings
- To update DNS configuration, see
ConfigureDnsSettings
- To update contact information, see
ConfigureContactSettings
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 (DomainsClient domainsClient = DomainsClient.create()) {
Registration registration = Registration.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Registration response = domainsClient.updateRegistrationAsync(registration, updateMask).get();
}
Name | Description |
registration | Registration Fields of the |
updateMask | FieldMask Required. The field mask describing which fields to update as a
comma-separated list. For example, if only the labels are being updated, the |
Type | Description |
OperationFuture<Registration,OperationMetadata> |
updateRegistrationAsync(UpdateRegistrationRequest request)
public final OperationFuture<Registration,OperationMetadata> updateRegistrationAsync(UpdateRegistrationRequest request)
Updates select fields of a Registration
resource, notably labels
. To update other fields,
use the appropriate custom update method:
- To update management settings, see
ConfigureManagementSettings
- To update DNS configuration, see
ConfigureDnsSettings
- To update contact information, see
ConfigureContactSettings
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 (DomainsClient domainsClient = DomainsClient.create()) {
UpdateRegistrationRequest request =
UpdateRegistrationRequest.newBuilder()
.setRegistration(Registration.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Registration response = domainsClient.updateRegistrationAsync(request).get();
}
Name | Description |
request | UpdateRegistrationRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Registration,OperationMetadata> |
updateRegistrationCallable()
public final UnaryCallable<UpdateRegistrationRequest,Operation> updateRegistrationCallable()
Updates select fields of a Registration
resource, notably labels
. To update other fields,
use the appropriate custom update method:
- To update management settings, see
ConfigureManagementSettings
- To update DNS configuration, see
ConfigureDnsSettings
- To update contact information, see
ConfigureContactSettings
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 (DomainsClient domainsClient = DomainsClient.create()) {
UpdateRegistrationRequest request =
UpdateRegistrationRequest.newBuilder()
.setRegistration(Registration.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Operation> future = domainsClient.updateRegistrationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<UpdateRegistrationRequest,Operation> |
updateRegistrationOperationCallable()
public final OperationCallable<UpdateRegistrationRequest,Registration,OperationMetadata> updateRegistrationOperationCallable()
Updates select fields of a Registration
resource, notably labels
. To update other fields,
use the appropriate custom update method:
- To update management settings, see
ConfigureManagementSettings
- To update DNS configuration, see
ConfigureDnsSettings
- To update contact information, see
ConfigureContactSettings
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 (DomainsClient domainsClient = DomainsClient.create()) {
UpdateRegistrationRequest request =
UpdateRegistrationRequest.newBuilder()
.setRegistration(Registration.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
OperationFuture<Registration, OperationMetadata> future =
domainsClient.updateRegistrationOperationCallable().futureCall(request);
// Do something.
Registration response = future.get();
}
Type | Description |
OperationCallable<UpdateRegistrationRequest,Registration,OperationMetadata> |