Package com.google.cloud.domains.v1 (1.4.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.v1.AuthorizationCode

AuthorizationCode.Builder

Defines an authorization code.

Protobuf type google.cloud.domains.v1.AuthorizationCode

ConfigureContactSettingsRequest

Request for the ConfigureContactSettings method.

Protobuf type google.cloud.domains.v1.ConfigureContactSettingsRequest

ConfigureContactSettingsRequest.Builder

Request for the ConfigureContactSettings method.

Protobuf type google.cloud.domains.v1.ConfigureContactSettingsRequest

ConfigureDnsSettingsRequest

Request for the ConfigureDnsSettings method.

Protobuf type google.cloud.domains.v1.ConfigureDnsSettingsRequest

ConfigureDnsSettingsRequest.Builder

Request for the ConfigureDnsSettings method.

Protobuf type google.cloud.domains.v1.ConfigureDnsSettingsRequest

ConfigureManagementSettingsRequest

Request for the ConfigureManagementSettings method.

Protobuf type google.cloud.domains.v1.ConfigureManagementSettingsRequest

ConfigureManagementSettingsRequest.Builder

Request for the ConfigureManagementSettings method.

Protobuf type google.cloud.domains.v1.ConfigureManagementSettingsRequest

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.v1.ContactSettings

ContactSettings.Builder

Protobuf type google.cloud.domains.v1.ContactSettings

ContactSettings.Contact

Details required for a contact associated with a Registration.

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

ContactSettings.Contact.Builder

Details required for a contact associated with a Registration.

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

DeleteRegistrationRequest

Request for the DeleteRegistration method.

Protobuf type google.cloud.domains.v1.DeleteRegistrationRequest

DeleteRegistrationRequest.Builder

Request for the DeleteRegistration method.

Protobuf type google.cloud.domains.v1.DeleteRegistrationRequest

DnsSettings

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

Protobuf type google.cloud.domains.v1.DnsSettings

DnsSettings.Builder

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

Protobuf type google.cloud.domains.v1.DnsSettings

DnsSettings.CustomDns

Configuration for an arbitrary DNS provider.

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

DnsSettings.CustomDns.Builder

Configuration for an arbitrary DNS provider.

Protobuf type google.cloud.domains.v1.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.v1.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.v1.DnsSettings.DsRecord

DnsSettings.GlueRecord

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.v1.DnsSettings.GlueRecord

DnsSettings.GlueRecord.Builder

Protobuf type google.cloud.domains.v1.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.v1.DnsSettings.GoogleDomainsDns

DnsSettings.GoogleDomainsDns.Builder

Protobuf type google.cloud.domains.v1.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.