Class Registration (1.43.0)

public final class Registration extends GeneratedMessageV3 implements RegistrationOrBuilder

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

Static Fields

CONTACT_SETTINGS_FIELD_NUMBER

public static final int CONTACT_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DNS_SETTINGS_FIELD_NUMBER

public static final int DNS_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

DOMAIN_NAME_FIELD_NUMBER

public static final int DOMAIN_NAME_FIELD_NUMBER
Field Value
Type Description
int

EXPIRE_TIME_FIELD_NUMBER

public static final int EXPIRE_TIME_FIELD_NUMBER
Field Value
Type Description
int

ISSUES_FIELD_NUMBER

public static final int ISSUES_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

MANAGEMENT_SETTINGS_FIELD_NUMBER

public static final int MANAGEMENT_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PENDING_CONTACT_SETTINGS_FIELD_NUMBER

public static final int PENDING_CONTACT_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

SUPPORTED_PRIVACY_FIELD_NUMBER

public static final int SUPPORTED_PRIVACY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Registration getDefaultInstance()
Returns
Type Description
Registration

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Registration.Builder newBuilder()
Returns
Type Description
Registration.Builder

newBuilder(Registration prototype)

public static Registration.Builder newBuilder(Registration prototype)
Parameter
Name Description
prototype Registration
Returns
Type Description
Registration.Builder

parseDelimitedFrom(InputStream input)

public static Registration parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Registration
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Registration parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Registration
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Registration parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Registration
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Registration parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Registration
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Registration parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Registration
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Registration parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Registration
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Registration parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Registration
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Registration parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Registration
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Registration parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Registration
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Registration parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Registration
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Registration parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Registration
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Registration parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Registration
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Registration> parser()
Returns
Type Description
Parser<Registration>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Set of labels associated with the Registration.

map<string, string> labels = 9;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getContactSettings()

public ContactSettings getContactSettings()

Required. Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method.

.google.cloud.domains.v1.ContactSettings contact_settings = 12 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ContactSettings

The contactSettings.

getContactSettingsOrBuilder()

public ContactSettingsOrBuilder getContactSettingsOrBuilder()

Required. Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method.

.google.cloud.domains.v1.ContactSettings contact_settings = 12 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ContactSettingsOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. The creation timestamp of the Registration resource.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation timestamp of the Registration resource.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Registration getDefaultInstanceForType()
Returns
Type Description
Registration

getDnsSettings()

public DnsSettings getDnsSettings()

Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method.

.google.cloud.domains.v1.DnsSettings dns_settings = 11;

Returns
Type Description
DnsSettings

The dnsSettings.

getDnsSettingsOrBuilder()

public DnsSettingsOrBuilder getDnsSettingsOrBuilder()

Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method.

.google.cloud.domains.v1.DnsSettings dns_settings = 11;

Returns
Type Description
DnsSettingsOrBuilder

getDomainName()

public String getDomainName()

Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.

string domain_name = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The domainName.

getDomainNameBytes()

public ByteString getDomainNameBytes()

Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.

string domain_name = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for domainName.

getExpireTime()

public Timestamp getExpireTime()

Output only. The expiration timestamp of the Registration.

.google.protobuf.Timestamp expire_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The expireTime.

getExpireTimeOrBuilder()

public TimestampOrBuilder getExpireTimeOrBuilder()

Output only. The expiration timestamp of the Registration.

.google.protobuf.Timestamp expire_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getIssues(int index)

public Registration.Issue getIssues(int index)

Output only. The set of issues with the Registration that require attention.

repeated .google.cloud.domains.v1.Registration.Issue issues = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
Registration.Issue

The issues at the given index.

getIssuesCount()

public int getIssuesCount()

Output only. The set of issues with the Registration that require attention.

repeated .google.cloud.domains.v1.Registration.Issue issues = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of issues.

getIssuesList()

public List<Registration.Issue> getIssuesList()

Output only. The set of issues with the Registration that require attention.

repeated .google.cloud.domains.v1.Registration.Issue issues = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Issue>

A list containing the issues.

getIssuesValue(int index)

public int getIssuesValue(int index)

Output only. The set of issues with the Registration that require attention.

repeated .google.cloud.domains.v1.Registration.Issue issues = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of issues at the given index.

getIssuesValueList()

public List<Integer> getIssuesValueList()

Output only. The set of issues with the Registration that require attention.

repeated .google.cloud.domains.v1.Registration.Issue issues = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for issues.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Set of labels associated with the Registration.

map<string, string> labels = 9;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Set of labels associated with the Registration.

map<string, string> labels = 9;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Set of labels associated with the Registration.

map<string, string> labels = 9;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Set of labels associated with the Registration.

map<string, string> labels = 9;

Parameter
Name Description
key String
Returns
Type Description
String

getManagementSettings()

public ManagementSettings getManagementSettings()

Settings for management of the Registration, including renewal, billing, and transfer. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureManagementSettings method.

.google.cloud.domains.v1.ManagementSettings management_settings = 10;

Returns
Type Description
ManagementSettings

The managementSettings.

getManagementSettingsOrBuilder()

public ManagementSettingsOrBuilder getManagementSettingsOrBuilder()

Settings for management of the Registration, including renewal, billing, and transfer. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureManagementSettings method.

.google.cloud.domains.v1.ManagementSettings management_settings = 10;

Returns
Type Description
ManagementSettingsOrBuilder

getName()

public String getName()

Output only. Name of the Registration resource, in the format projects/*/locations/*/registrations/<domain_name>.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Name of the Registration resource, in the format projects/*/locations/*/registrations/<domain_name>.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Registration> getParserForType()
Returns
Type Description
Parser<Registration>
Overrides

getPendingContactSettings()

public ContactSettings getPendingContactSettings()

Output only. Pending contact settings for the Registration. Updates to the contact_settings field that change its registrant_contact or privacy fields require email confirmation by the registrant_contact before taking effect. This field is set only if there are pending updates to the contact_settings that have not been confirmed. To confirm the changes, the registrant_contact must follow the instructions in the email they receive.

.google.cloud.domains.v1.ContactSettings pending_contact_settings = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ContactSettings

The pendingContactSettings.

getPendingContactSettingsOrBuilder()

public ContactSettingsOrBuilder getPendingContactSettingsOrBuilder()

Output only. Pending contact settings for the Registration. Updates to the contact_settings field that change its registrant_contact or privacy fields require email confirmation by the registrant_contact before taking effect. This field is set only if there are pending updates to the contact_settings that have not been confirmed. To confirm the changes, the registrant_contact must follow the instructions in the email they receive.

.google.cloud.domains.v1.ContactSettings pending_contact_settings = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ContactSettingsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public Registration.State getState()

Output only. The state of the Registration

.google.cloud.domains.v1.Registration.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Registration.State

The state.

getStateValue()

public int getStateValue()

Output only. The state of the Registration

.google.cloud.domains.v1.Registration.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getSupportedPrivacy(int index)

public ContactPrivacy getSupportedPrivacy(int index)

Output only. Set of options for the contact_settings.privacy field that this Registration supports.

repeated .google.cloud.domains.v1.ContactPrivacy supported_privacy = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
ContactPrivacy

The supportedPrivacy at the given index.

getSupportedPrivacyCount()

public int getSupportedPrivacyCount()

Output only. Set of options for the contact_settings.privacy field that this Registration supports.

repeated .google.cloud.domains.v1.ContactPrivacy supported_privacy = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of supportedPrivacy.

getSupportedPrivacyList()

public List<ContactPrivacy> getSupportedPrivacyList()

Output only. Set of options for the contact_settings.privacy field that this Registration supports.

repeated .google.cloud.domains.v1.ContactPrivacy supported_privacy = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<ContactPrivacy>

A list containing the supportedPrivacy.

getSupportedPrivacyValue(int index)

public int getSupportedPrivacyValue(int index)

Output only. Set of options for the contact_settings.privacy field that this Registration supports.

repeated .google.cloud.domains.v1.ContactPrivacy supported_privacy = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of supportedPrivacy at the given index.

getSupportedPrivacyValueList()

public List<Integer> getSupportedPrivacyValueList()

Output only. Set of options for the contact_settings.privacy field that this Registration supports.

repeated .google.cloud.domains.v1.ContactPrivacy supported_privacy = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for supportedPrivacy.

hasContactSettings()

public boolean hasContactSettings()

Required. Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method.

.google.cloud.domains.v1.ContactSettings contact_settings = 12 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the contactSettings field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The creation timestamp of the Registration resource.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDnsSettings()

public boolean hasDnsSettings()

Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method.

.google.cloud.domains.v1.DnsSettings dns_settings = 11;

Returns
Type Description
boolean

Whether the dnsSettings field is set.

hasExpireTime()

public boolean hasExpireTime()

Output only. The expiration timestamp of the Registration.

.google.protobuf.Timestamp expire_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the expireTime field is set.

hasManagementSettings()

public boolean hasManagementSettings()

Settings for management of the Registration, including renewal, billing, and transfer. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureManagementSettings method.

.google.cloud.domains.v1.ManagementSettings management_settings = 10;

Returns
Type Description
boolean

Whether the managementSettings field is set.

hasPendingContactSettings()

public boolean hasPendingContactSettings()

Output only. Pending contact settings for the Registration. Updates to the contact_settings field that change its registrant_contact or privacy fields require email confirmation by the registrant_contact before taking effect. This field is set only if there are pending updates to the contact_settings that have not been confirmed. To confirm the changes, the registrant_contact must follow the instructions in the email they receive.

.google.cloud.domains.v1.ContactSettings pending_contact_settings = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the pendingContactSettings field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Registration.Builder newBuilderForType()
Returns
Type Description
Registration.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Registration.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Registration.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Registration.Builder toBuilder()
Returns
Type Description
Registration.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException