Package com.google.cloud.domains.v1beta1 (1.17.0)

A client to Cloud Domains API

The interfaces provided are listed below, along with usage samples.

DomainsClient

Service Description: The Cloud Domains API enables management and configuration of domain names.

Sample for DomainsClient:


 // 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);
 }

Classes

AuthorizationCode

Defines an authorization code.

Protobuf type google.cloud.domains.v1beta1.AuthorizationCode

AuthorizationCode.Builder

Defines an authorization code.

Protobuf type google.cloud.domains.v1beta1.AuthorizationCode

ConfigureContactSettingsRequest

Request for the ConfigureContactSettings method.

Protobuf type google.cloud.domains.v1beta1.ConfigureContactSettingsRequest

ConfigureContactSettingsRequest.Builder

Request for the ConfigureContactSettings method.

Protobuf type google.cloud.domains.v1beta1.ConfigureContactSettingsRequest

ConfigureDnsSettingsRequest

Request for the ConfigureDnsSettings method.

Protobuf type google.cloud.domains.v1beta1.ConfigureDnsSettingsRequest

ConfigureDnsSettingsRequest.Builder

Request for the ConfigureDnsSettings method.

Protobuf type google.cloud.domains.v1beta1.ConfigureDnsSettingsRequest

ConfigureManagementSettingsRequest

Request for the ConfigureManagementSettings method.

Protobuf type google.cloud.domains.v1beta1.ConfigureManagementSettingsRequest

ConfigureManagementSettingsRequest.Builder

Request for the ConfigureManagementSettings method.

Protobuf type google.cloud.domains.v1beta1.ConfigureManagementSettingsRequest

ContactSettings

Defines the contact information associated with a Registration.

ICANN requires all domain names to have associated contact information. The registrant_contact is considered the domain's legal owner, and often the other contacts are identical.

Protobuf type google.cloud.domains.v1beta1.ContactSettings

ContactSettings.Builder

Defines the contact information associated with a Registration.

ICANN requires all domain names to have associated contact information. The registrant_contact is considered the domain's legal owner, and often the other contacts are identical.

Protobuf type google.cloud.domains.v1beta1.ContactSettings

ContactSettings.Contact

Details required for a contact associated with a Registration.

Protobuf type google.cloud.domains.v1beta1.ContactSettings.Contact

ContactSettings.Contact.Builder

Details required for a contact associated with a Registration.

Protobuf type google.cloud.domains.v1beta1.ContactSettings.Contact

DeleteRegistrationRequest

Request for the DeleteRegistration method.

Protobuf type google.cloud.domains.v1beta1.DeleteRegistrationRequest

DeleteRegistrationRequest.Builder

Request for the DeleteRegistration method.

Protobuf type google.cloud.domains.v1beta1.DeleteRegistrationRequest

DnsSettings

Defines the DNS configuration of a Registration, including name servers, DNSSEC, and glue records.

Protobuf type google.cloud.domains.v1beta1.DnsSettings

DnsSettings.Builder

Defines the DNS configuration of a Registration, including name servers, DNSSEC, and glue records.

Protobuf type google.cloud.domains.v1beta1.DnsSettings

DnsSettings.CustomDns

Configuration for an arbitrary DNS provider.

Protobuf type google.cloud.domains.v1beta1.DnsSettings.CustomDns

DnsSettings.CustomDns.Builder

Configuration for an arbitrary DNS provider.

Protobuf type google.cloud.domains.v1beta1.DnsSettings.CustomDns

DnsSettings.DsRecord

Defines a Delegation Signer (DS) record, which is needed to enable DNSSEC for a domain. It contains a digest (hash) of a DNSKEY record that must be present in the domain's DNS zone.

Protobuf type google.cloud.domains.v1beta1.DnsSettings.DsRecord

DnsSettings.DsRecord.Builder

Defines a Delegation Signer (DS) record, which is needed to enable DNSSEC for a domain. It contains a digest (hash) of a DNSKEY record that must be present in the domain's DNS zone.

Protobuf type google.cloud.domains.v1beta1.DnsSettings.DsRecord

Defines a host on your domain that is a DNS name server for your domain and/or other domains. Glue records are a way of making the IP address of a name server known, even when it serves DNS queries for its parent domain. For example, when ns.example.com is a name server for example.com, the host ns.example.com must have a glue record to break the circular DNS reference.

Protobuf type google.cloud.domains.v1beta1.DnsSettings.GlueRecord

DnsSettings.GlueRecord.Builder

Protobuf type google.cloud.domains.v1beta1.DnsSettings.GlueRecord

DnsSettings.GoogleDomainsDns

Configuration for using the free DNS zone provided by Google Domains as a Registration's dns_provider. You cannot configure the DNS zone itself using the API. To configure the DNS zone, go to Google Domains.

Protobuf type google.cloud.domains.v1beta1.DnsSettings.GoogleDomainsDns

DnsSettings.GoogleDomainsDns.Builder

Protobuf type google.cloud.domains.v1beta1.DnsSettings.GoogleDomainsDns

DomainsClient

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.

DomainsClient.ListRegistrationsFixedSizeCollection

DomainsClient.ListRegistrationsPage

DomainsClient.ListRegistrationsPagedResponse

DomainsGrpc

The Cloud Domains API enables management and configuration of domain names.

DomainsGrpc.DomainsBlockingStub

A stub to allow clients to do synchronous rpc calls to service Domains.

The Cloud Domains API enables management and configuration of domain names.

DomainsGrpc.DomainsFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Domains.

The Cloud Domains API enables management and configuration of domain names.

DomainsGrpc.DomainsImplBase

Base class for the server implementation of the service Domains.

The Cloud Domains API enables management and configuration of domain names.

DomainsGrpc.DomainsStub

A stub to allow clients to do asynchronous rpc calls to service Domains.

The Cloud Domains API enables management and configuration of domain names.

DomainsProto

DomainsSettings

Settings class to configure an instance of DomainsClient.

The default instance has everything set to sensible defaults:

The default service address (domains.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of searchDomains to 30 seconds:


 // 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.Builder domainsSettingsBuilder = DomainsSettings.newBuilder();
 domainsSettingsBuilder
     .searchDomainsSettings()
     .setRetrySettings(
         domainsSettingsBuilder
             .searchDomainsSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DomainsSettings domainsSettings = domainsSettingsBuilder.build();

DomainsSettings.Builder

Builder for DomainsSettings.

ExportRegistrationRequest

Request for the ExportRegistration method.

Protobuf type google.cloud.domains.v1beta1.ExportRegistrationRequest

ExportRegistrationRequest.Builder

Request for the ExportRegistration method.

Protobuf type google.cloud.domains.v1beta1.ExportRegistrationRequest

GetRegistrationRequest

Request for the GetRegistration method.

Protobuf type google.cloud.domains.v1beta1.GetRegistrationRequest

GetRegistrationRequest.Builder

Request for the GetRegistration method.

Protobuf type google.cloud.domains.v1beta1.GetRegistrationRequest

ListRegistrationsRequest

Request for the ListRegistrations method.

Protobuf type google.cloud.domains.v1beta1.ListRegistrationsRequest

ListRegistrationsRequest.Builder

Request for the ListRegistrations method.

Protobuf type google.cloud.domains.v1beta1.ListRegistrationsRequest

ListRegistrationsResponse

Response for the ListRegistrations method.

Protobuf type google.cloud.domains.v1beta1.ListRegistrationsResponse

ListRegistrationsResponse.Builder

Response for the ListRegistrations method.

Protobuf type google.cloud.domains.v1beta1.ListRegistrationsResponse

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

ManagementSettings

Defines renewal, billing, and transfer settings for a Registration.

Protobuf type google.cloud.domains.v1beta1.ManagementSettings

ManagementSettings.Builder

Defines renewal, billing, and transfer settings for a Registration.

Protobuf type google.cloud.domains.v1beta1.ManagementSettings

OperationMetadata

Represents the metadata of the long-running operation. Output only.

Protobuf type google.cloud.domains.v1beta1.OperationMetadata

OperationMetadata.Builder

Represents the metadata of the long-running operation. Output only.

Protobuf type google.cloud.domains.v1beta1.OperationMetadata

RegisterDomainRequest

Request for the RegisterDomain method.

Protobuf type google.cloud.domains.v1beta1.RegisterDomainRequest

RegisterDomainRequest.Builder

Request for the RegisterDomain method.

Protobuf type google.cloud.domains.v1beta1.RegisterDomainRequest

RegisterParameters

Parameters required to register a new domain.

Protobuf type google.cloud.domains.v1beta1.RegisterParameters

RegisterParameters.Builder

Parameters required to register a new domain.

Protobuf type google.cloud.domains.v1beta1.RegisterParameters

Registration

The Registration resource facilitates managing and configuring domain name registrations.

There are several ways to create a new Registration resource:

To create a new Registration resource, find a suitable domain name by calling the SearchDomains method with a query to see available domain name options. After choosing a name, call RetrieveRegisterParameters to ensure availability and obtain information like pricing, which is needed to build a call to RegisterDomain.

Another way to create a new Registration is to transfer an existing domain from another registrar. First, go to the 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 TransferDomain.

Protobuf type google.cloud.domains.v1beta1.Registration

Registration.Builder

The Registration resource facilitates managing and configuring domain name registrations.

There are several ways to create a new Registration resource:

Protobuf type google.cloud.domains.v1beta1.Registration

RegistrationName

RegistrationName.Builder

Builder for projects/{project}/locations/{location}/registrations/{registration}.

ResetAuthorizationCodeRequest

Request for the ResetAuthorizationCode method.

Protobuf type google.cloud.domains.v1beta1.ResetAuthorizationCodeRequest

ResetAuthorizationCodeRequest.Builder

Request for the ResetAuthorizationCode method.

Protobuf type google.cloud.domains.v1beta1.ResetAuthorizationCodeRequest

RetrieveAuthorizationCodeRequest

Request for the RetrieveAuthorizationCode method.

Protobuf type google.cloud.domains.v1beta1.RetrieveAuthorizationCodeRequest

RetrieveAuthorizationCodeRequest.Builder

Request for the RetrieveAuthorizationCode method.

Protobuf type google.cloud.domains.v1beta1.RetrieveAuthorizationCodeRequest

RetrieveRegisterParametersRequest

Request for the RetrieveRegisterParameters method.

Protobuf type google.cloud.domains.v1beta1.RetrieveRegisterParametersRequest

RetrieveRegisterParametersRequest.Builder

Request for the RetrieveRegisterParameters method.

Protobuf type google.cloud.domains.v1beta1.RetrieveRegisterParametersRequest

RetrieveRegisterParametersResponse

Response for the RetrieveRegisterParameters method.

Protobuf type google.cloud.domains.v1beta1.RetrieveRegisterParametersResponse

RetrieveRegisterParametersResponse.Builder

Response for the RetrieveRegisterParameters method.

Protobuf type google.cloud.domains.v1beta1.RetrieveRegisterParametersResponse

RetrieveTransferParametersRequest

Request for the RetrieveTransferParameters method.

Protobuf type google.cloud.domains.v1beta1.RetrieveTransferParametersRequest

RetrieveTransferParametersRequest.Builder

Request for the RetrieveTransferParameters method.

Protobuf type google.cloud.domains.v1beta1.RetrieveTransferParametersRequest

RetrieveTransferParametersResponse

Response for the RetrieveTransferParameters method.

Protobuf type google.cloud.domains.v1beta1.RetrieveTransferParametersResponse

RetrieveTransferParametersResponse.Builder

Response for the RetrieveTransferParameters method.

Protobuf type google.cloud.domains.v1beta1.RetrieveTransferParametersResponse

SearchDomainsRequest

Request for the SearchDomains method.

Protobuf type google.cloud.domains.v1beta1.SearchDomainsRequest

SearchDomainsRequest.Builder

Request for the SearchDomains method.

Protobuf type google.cloud.domains.v1beta1.SearchDomainsRequest

SearchDomainsResponse

Response for the SearchDomains method.

Protobuf type google.cloud.domains.v1beta1.SearchDomainsResponse

SearchDomainsResponse.Builder

Response for the SearchDomains method.

Protobuf type google.cloud.domains.v1beta1.SearchDomainsResponse

TransferDomainRequest

Request for the TransferDomain method.

Protobuf type google.cloud.domains.v1beta1.TransferDomainRequest

TransferDomainRequest.Builder

Request for the TransferDomain method.

Protobuf type google.cloud.domains.v1beta1.TransferDomainRequest

TransferParameters

Parameters required to transfer a domain from another registrar.

Protobuf type google.cloud.domains.v1beta1.TransferParameters

TransferParameters.Builder

Parameters required to transfer a domain from another registrar.

Protobuf type google.cloud.domains.v1beta1.TransferParameters

UpdateRegistrationRequest

Request for the UpdateRegistration method.

Protobuf type google.cloud.domains.v1beta1.UpdateRegistrationRequest

UpdateRegistrationRequest.Builder

Request for the UpdateRegistration method.

Protobuf type google.cloud.domains.v1beta1.UpdateRegistrationRequest

Interfaces

AuthorizationCodeOrBuilder

ConfigureContactSettingsRequestOrBuilder

ConfigureDnsSettingsRequestOrBuilder

ConfigureManagementSettingsRequestOrBuilder

ContactSettings.ContactOrBuilder

ContactSettingsOrBuilder

DeleteRegistrationRequestOrBuilder

DnsSettings.CustomDnsOrBuilder

DnsSettings.DsRecordOrBuilder

DnsSettings.GlueRecordOrBuilder

DnsSettings.GoogleDomainsDnsOrBuilder

DnsSettingsOrBuilder

DomainsGrpc.AsyncService

The Cloud Domains API enables management and configuration of domain names.

ExportRegistrationRequestOrBuilder

GetRegistrationRequestOrBuilder

ListRegistrationsRequestOrBuilder

ListRegistrationsResponseOrBuilder

ManagementSettingsOrBuilder

OperationMetadataOrBuilder

RegisterDomainRequestOrBuilder

RegisterParametersOrBuilder

RegistrationOrBuilder

ResetAuthorizationCodeRequestOrBuilder

RetrieveAuthorizationCodeRequestOrBuilder

RetrieveRegisterParametersRequestOrBuilder

RetrieveRegisterParametersResponseOrBuilder

RetrieveTransferParametersRequestOrBuilder

RetrieveTransferParametersResponseOrBuilder

SearchDomainsRequestOrBuilder

SearchDomainsResponseOrBuilder

TransferDomainRequestOrBuilder

TransferParametersOrBuilder

UpdateRegistrationRequestOrBuilder

Enums

ContactNotice

Notices related to contact information.

Protobuf enum google.cloud.domains.v1beta1.ContactNotice

ContactPrivacy

Defines a set of possible contact privacy settings for a Registration.

ICANN maintains the WHOIS database, a publicly accessible mapping from domain name to contact information, and requires that each domain name have an entry. Choose from these options to control how much information in your ContactSettings is published.

Protobuf enum google.cloud.domains.v1beta1.ContactPrivacy