Package com.google.cloud.domains.v1alpha2

Class Registration

  • All Implemented Interfaces:
    RegistrationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Registration
extends com.google.protobuf.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.v1alpha2.Registration
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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];
        Specified by:
        getName in interface RegistrationOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.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];
        Specified by:
        getNameBytes in interface RegistrationOrBuilder
        Returns:
        The bytes for name.

      • 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];
        Specified by:
        getDomainName in interface RegistrationOrBuilder
        Returns:
        The domainName.

      • getDomainNameBytes

        public com.google.protobuf.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];
        Specified by:
        getDomainNameBytes in interface RegistrationOrBuilder
        Returns:
        The bytes for domainName.

      • 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];
        Specified by:
        hasCreateTime in interface RegistrationOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The creation timestamp of the `Registration` resource.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface RegistrationOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The creation timestamp of the `Registration` resource.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface RegistrationOrBuilder

      • hasExpireTime

        public boolean hasExpireTime()
         Output only. The expiration timestamp of the `Registration`.
        .google.protobuf.Timestamp expire_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasExpireTime in interface RegistrationOrBuilder
        Returns:
        Whether the expireTime field is set.

      • getExpireTime

        public com.google.protobuf.Timestamp getExpireTime()
         Output only. The expiration timestamp of the `Registration`.
        .google.protobuf.Timestamp expire_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getExpireTime in interface RegistrationOrBuilder
        Returns:
        The expireTime.

      • getExpireTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()
         Output only. The expiration timestamp of the `Registration`.
        .google.protobuf.Timestamp expire_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getExpireTimeOrBuilder in interface RegistrationOrBuilder

      • getStateValue

        public int getStateValue()
         Output only. The state of the `Registration`
        .google.cloud.domains.v1alpha2.Registration.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface RegistrationOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public Registration.State getState()
         Output only. The state of the `Registration`
        .google.cloud.domains.v1alpha2.Registration.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface RegistrationOrBuilder
        Returns:
        The state.

      • getIssuesList

        public List<Registration.Issue> getIssuesList()
         Output only. The set of issues with the `Registration` that require attention.
        repeated .google.cloud.domains.v1alpha2.Registration.Issue issues = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getIssuesList in interface RegistrationOrBuilder
        Returns:
        A list containing the issues.

      • getIssuesCount

        public int getIssuesCount()
         Output only. The set of issues with the `Registration` that require attention.
        repeated .google.cloud.domains.v1alpha2.Registration.Issue issues = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getIssuesCount in interface RegistrationOrBuilder
        Returns:
        The count of issues.

      • getIssues

        public Registration.Issue getIssues​(int index)
         Output only. The set of issues with the `Registration` that require attention.
        repeated .google.cloud.domains.v1alpha2.Registration.Issue issues = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getIssues in interface RegistrationOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The 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.v1alpha2.Registration.Issue issues = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getIssuesValueList in interface RegistrationOrBuilder
        Returns:
        A list containing the enum numeric values on the wire for issues.

      • getIssuesValue

        public int getIssuesValue​(int index)
         Output only. The set of issues with the `Registration` that require attention.
        repeated .google.cloud.domains.v1alpha2.Registration.Issue issues = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getIssuesValue in interface RegistrationOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of issues at the given index.

      • containsLabels

        public boolean containsLabels​(String key)
         Set of labels associated with the `Registration`.
        map<string, string> labels = 9;
        Specified by:
        containsLabels in interface RegistrationOrBuilder

      • 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.v1alpha2.ManagementSettings management_settings = 10;
        Specified by:
        hasManagementSettings in interface RegistrationOrBuilder
        Returns:
        Whether the managementSettings field is set.

      • 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.v1alpha2.ManagementSettings management_settings = 10;
        Specified by:
        getManagementSettings in interface RegistrationOrBuilder
        Returns:
        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.v1alpha2.ManagementSettings management_settings = 10;
        Specified by:
        getManagementSettingsOrBuilder in interface RegistrationOrBuilder

      • 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.v1alpha2.DnsSettings dns_settings = 11;
        Specified by:
        hasDnsSettings in interface RegistrationOrBuilder
        Returns:
        Whether the dnsSettings field is set.

      • 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.v1alpha2.DnsSettings dns_settings = 11;
        Specified by:
        getDnsSettings in interface RegistrationOrBuilder
        Returns:
        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.v1alpha2.DnsSettings dns_settings = 11;
        Specified by:
        getDnsSettingsOrBuilder in interface RegistrationOrBuilder

      • 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.v1alpha2.ContactSettings contact_settings = 12 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasContactSettings in interface RegistrationOrBuilder
        Returns:
        Whether the contactSettings field is set.

      • 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.v1alpha2.ContactSettings contact_settings = 12 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getContactSettings in interface RegistrationOrBuilder
        Returns:
        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.v1alpha2.ContactSettings contact_settings = 12 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getContactSettingsOrBuilder in interface RegistrationOrBuilder

      • 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.v1alpha2.ContactSettings pending_contact_settings = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasPendingContactSettings in interface RegistrationOrBuilder
        Returns:
        Whether the pendingContactSettings field is set.

      • 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.v1alpha2.ContactSettings pending_contact_settings = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPendingContactSettings in interface RegistrationOrBuilder
        Returns:
        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.v1alpha2.ContactSettings pending_contact_settings = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPendingContactSettingsOrBuilder in interface RegistrationOrBuilder

      • getSupportedPrivacyList

        public List<ContactPrivacy> getSupportedPrivacyList()
         Output only. Set of options for the `contact_settings.privacy` field that this
 `Registration` supports.
        repeated .google.cloud.domains.v1alpha2.ContactPrivacy supported_privacy = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSupportedPrivacyList in interface RegistrationOrBuilder
        Returns:
        A list containing the supportedPrivacy.

      • getSupportedPrivacyCount

        public int getSupportedPrivacyCount()
         Output only. Set of options for the `contact_settings.privacy` field that this
 `Registration` supports.
        repeated .google.cloud.domains.v1alpha2.ContactPrivacy supported_privacy = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSupportedPrivacyCount in interface RegistrationOrBuilder
        Returns:
        The count of supportedPrivacy.

      • getSupportedPrivacy

        public ContactPrivacy getSupportedPrivacy​(int index)
         Output only. Set of options for the `contact_settings.privacy` field that this
 `Registration` supports.
        repeated .google.cloud.domains.v1alpha2.ContactPrivacy supported_privacy = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSupportedPrivacy in interface RegistrationOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The 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.v1alpha2.ContactPrivacy supported_privacy = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSupportedPrivacyValueList in interface RegistrationOrBuilder
        Returns:
        A list containing the enum numeric values on the wire for supportedPrivacy.

      • getSupportedPrivacyValue

        public int getSupportedPrivacyValue​(int index)
         Output only. Set of options for the `contact_settings.privacy` field that this
 `Registration` supports.
        repeated .google.cloud.domains.v1alpha2.ContactPrivacy supported_privacy = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSupportedPrivacyValue in interface RegistrationOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of supportedPrivacy at the given index.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Registration parseFrom​(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Registration parseFrom​(ByteBuffer data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Registration parseFrom​(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Registration parseFrom​(com.google.protobuf.ByteString data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Registration parseFrom​(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Registration parseFrom​(byte[] data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Registration parseFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Registration.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Registration.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Registration.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Registration getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Registration> parser()

      • getParserForType

        public com.google.protobuf.Parser<Registration> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Registration getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder