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
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DNS_SETTINGS_FIELD_NUMBER
public static final int DNS_SETTINGS_FIELD_NUMBER
Field Value
DOMAIN_NAME_FIELD_NUMBER
public static final int DOMAIN_NAME_FIELD_NUMBER
Field Value
EXPIRE_TIME_FIELD_NUMBER
public static final int EXPIRE_TIME_FIELD_NUMBER
Field Value
ISSUES_FIELD_NUMBER
public static final int ISSUES_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
MANAGEMENT_SETTINGS_FIELD_NUMBER
public static final int MANAGEMENT_SETTINGS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
PENDING_CONTACT_SETTINGS_FIELD_NUMBER
public static final int PENDING_CONTACT_SETTINGS_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
SUPPORTED_PRIVACY_FIELD_NUMBER
public static final int SUPPORTED_PRIVACY_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Registration getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Registration.Builder newBuilder()
Returns
newBuilder(Registration prototype)
public static Registration.Builder newBuilder(Registration prototype)
Parameter
Returns
parseDelimitedFrom(InputStream input)
public static Registration parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Registration parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Registration parseFrom(byte[] data)
Parameter
| Name |
Description |
data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Registration parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Registration parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Registration parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(CodedInputStream input)
public static Registration parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Registration parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(InputStream input)
public static Registration parseFrom(InputStream input)
Parameter
Returns
Exceptions
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Registration parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Registration parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Registration parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Registration> parser()
Returns
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Set of labels associated with the Registration.
map<string, string> labels = 9;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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];
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];
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];
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];
getDefaultInstanceForType()
public Registration getDefaultInstanceForType()
Returns
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;
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;
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];
| 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];
| 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];
getExpireTimeOrBuilder()
public TimestampOrBuilder getExpireTimeOrBuilder()
Output only. The expiration timestamp of the Registration.
.google.protobuf.Timestamp expire_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];
| Name |
Description |
index |
int
The index of the element to return.
|
Returns
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];
| 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];
| 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];
| 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];
| Type |
Description |
List<Integer> |
A list containing the enum numeric values on the wire for issues.
|
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
Set of labels associated with the Registration.
map<string, string> labels = 9;
getLabelsMap()
public Map<String,String> getLabelsMap()
Set of labels associated with the Registration.
map<string, string> labels = 9;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Set of labels associated with the Registration.
map<string, string> labels = 9;
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Set of labels associated with the Registration.
map<string, string> labels = 9;
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;
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;
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];
| 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];
getParserForType()
public Parser<Registration> getParserForType()
Returns
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];
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];
getSerializedSize()
public int getSerializedSize()
Returns
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];
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];
| 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];
| 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];
| 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];
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];
| 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];
| Type |
Description |
List<Integer> |
A list containing the enum numeric values on the wire for supportedPrivacy.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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];
| 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];
| 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;
| 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];
| 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;
| 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];
| Type |
Description |
boolean |
Whether the pendingContactSettings field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
| Name |
Description |
number |
int
|
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Registration.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Registration.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Registration.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
