Class: Google::Cloud::Domains::V1beta1::Registration

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/domains/v1beta1/domains.rb

Overview

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.

Defined Under Namespace

Modules: Issue, State Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#contact_settings ⇒ ::Google::Cloud::Domains::V1beta1::ContactSettings

Returns 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.

Returns:

  • (::Google::Cloud::Domains::V1beta1::ContactSettings) —

    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.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'proto_docs/google/cloud/domains/v1beta1/domains.rb', line 91

class Registration
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of a `Registration`.
  module State
    # The state is undefined.
    STATE_UNSPECIFIED = 0

    # The domain is being registered.
    REGISTRATION_PENDING = 1

    # The domain registration failed. You can delete resources in this state
    # to allow registration to be retried.
    REGISTRATION_FAILED = 2

    # The domain is being transferred from another registrar to Cloud Domains.
    TRANSFER_PENDING = 3

    # The attempt to transfer the domain from another registrar to
    # Cloud Domains failed. You can delete resources in this state and retry
    # the transfer.
    TRANSFER_FAILED = 4

    # The domain is registered and operational. The domain renews automatically
    # as long as it remains in this state.
    ACTIVE = 6

    # The domain is suspended and inoperative. For more details, see the
    # `issues` field.
    SUSPENDED = 7

    # The domain is no longer managed with Cloud Domains. It may have been
    # transferred to another registrar or exported for management in
    # [Google Domains](https://domains.google/). You can no longer update it
    # with this API, and information shown about it may be stale. Domains in
    # this state are not automatically renewed by Cloud Domains.
    EXPORTED = 8
  end

  # Possible issues with a `Registration` that require attention.
  module Issue
    # The issue is undefined.
    ISSUE_UNSPECIFIED = 0

    # Contact the Cloud Support team to resolve a problem with this domain.
    CONTACT_SUPPORT = 1

    # [ICANN](https://icann.org/) requires verification of the email address
    # in the `Registration`'s `contact_settings.registrant_contact` field. To
    # verify the email address, follow the
    # instructions in the email the `registrant_contact` receives following
    # registration. If you do not complete email verification within
    # 15 days of registration, the domain is suspended. To resend the
    # verification email, call ConfigureContactSettings and provide the current
    # `registrant_contact.email`.
    UNVERIFIED_EMAIL = 2
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The creation timestamp of the Registration resource.

Returns:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'proto_docs/google/cloud/domains/v1beta1/domains.rb', line 91

class Registration
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of a `Registration`.
  module State
    # The state is undefined.
    STATE_UNSPECIFIED = 0

    # The domain is being registered.
    REGISTRATION_PENDING = 1

    # The domain registration failed. You can delete resources in this state
    # to allow registration to be retried.
    REGISTRATION_FAILED = 2

    # The domain is being transferred from another registrar to Cloud Domains.
    TRANSFER_PENDING = 3

    # The attempt to transfer the domain from another registrar to
    # Cloud Domains failed. You can delete resources in this state and retry
    # the transfer.
    TRANSFER_FAILED = 4

    # The domain is registered and operational. The domain renews automatically
    # as long as it remains in this state.
    ACTIVE = 6

    # The domain is suspended and inoperative. For more details, see the
    # `issues` field.
    SUSPENDED = 7

    # The domain is no longer managed with Cloud Domains. It may have been
    # transferred to another registrar or exported for management in
    # [Google Domains](https://domains.google/). You can no longer update it
    # with this API, and information shown about it may be stale. Domains in
    # this state are not automatically renewed by Cloud Domains.
    EXPORTED = 8
  end

  # Possible issues with a `Registration` that require attention.
  module Issue
    # The issue is undefined.
    ISSUE_UNSPECIFIED = 0

    # Contact the Cloud Support team to resolve a problem with this domain.
    CONTACT_SUPPORT = 1

    # [ICANN](https://icann.org/) requires verification of the email address
    # in the `Registration`'s `contact_settings.registrant_contact` field. To
    # verify the email address, follow the
    # instructions in the email the `registrant_contact` receives following
    # registration. If you do not complete email verification within
    # 15 days of registration, the domain is suspended. To resend the
    # verification email, call ConfigureContactSettings and provide the current
    # `registrant_contact.email`.
    UNVERIFIED_EMAIL = 2
  end
end

#dns_settings ⇒ ::Google::Cloud::Domains::V1beta1::DnsSettings

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

Returns:

  • (::Google::Cloud::Domains::V1beta1::DnsSettings) —

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'proto_docs/google/cloud/domains/v1beta1/domains.rb', line 91

class Registration
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of a `Registration`.
  module State
    # The state is undefined.
    STATE_UNSPECIFIED = 0

    # The domain is being registered.
    REGISTRATION_PENDING = 1

    # The domain registration failed. You can delete resources in this state
    # to allow registration to be retried.
    REGISTRATION_FAILED = 2

    # The domain is being transferred from another registrar to Cloud Domains.
    TRANSFER_PENDING = 3

    # The attempt to transfer the domain from another registrar to
    # Cloud Domains failed. You can delete resources in this state and retry
    # the transfer.
    TRANSFER_FAILED = 4

    # The domain is registered and operational. The domain renews automatically
    # as long as it remains in this state.
    ACTIVE = 6

    # The domain is suspended and inoperative. For more details, see the
    # `issues` field.
    SUSPENDED = 7

    # The domain is no longer managed with Cloud Domains. It may have been
    # transferred to another registrar or exported for management in
    # [Google Domains](https://domains.google/). You can no longer update it
    # with this API, and information shown about it may be stale. Domains in
    # this state are not automatically renewed by Cloud Domains.
    EXPORTED = 8
  end

  # Possible issues with a `Registration` that require attention.
  module Issue
    # The issue is undefined.
    ISSUE_UNSPECIFIED = 0

    # Contact the Cloud Support team to resolve a problem with this domain.
    CONTACT_SUPPORT = 1

    # [ICANN](https://icann.org/) requires verification of the email address
    # in the `Registration`'s `contact_settings.registrant_contact` field. To
    # verify the email address, follow the
    # instructions in the email the `registrant_contact` receives following
    # registration. If you do not complete email verification within
    # 15 days of registration, the domain is suspended. To resend the
    # verification email, call ConfigureContactSettings and provide the current
    # `registrant_contact.email`.
    UNVERIFIED_EMAIL = 2
  end
end

#domain_name ⇒ ::String

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

Returns:

  • (::String) —

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'proto_docs/google/cloud/domains/v1beta1/domains.rb', line 91

class Registration
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of a `Registration`.
  module State
    # The state is undefined.
    STATE_UNSPECIFIED = 0

    # The domain is being registered.
    REGISTRATION_PENDING = 1

    # The domain registration failed. You can delete resources in this state
    # to allow registration to be retried.
    REGISTRATION_FAILED = 2

    # The domain is being transferred from another registrar to Cloud Domains.
    TRANSFER_PENDING = 3

    # The attempt to transfer the domain from another registrar to
    # Cloud Domains failed. You can delete resources in this state and retry
    # the transfer.
    TRANSFER_FAILED = 4

    # The domain is registered and operational. The domain renews automatically
    # as long as it remains in this state.
    ACTIVE = 6

    # The domain is suspended and inoperative. For more details, see the
    # `issues` field.
    SUSPENDED = 7

    # The domain is no longer managed with Cloud Domains. It may have been
    # transferred to another registrar or exported for management in
    # [Google Domains](https://domains.google/). You can no longer update it
    # with this API, and information shown about it may be stale. Domains in
    # this state are not automatically renewed by Cloud Domains.
    EXPORTED = 8
  end

  # Possible issues with a `Registration` that require attention.
  module Issue
    # The issue is undefined.
    ISSUE_UNSPECIFIED = 0

    # Contact the Cloud Support team to resolve a problem with this domain.
    CONTACT_SUPPORT = 1

    # [ICANN](https://icann.org/) requires verification of the email address
    # in the `Registration`'s `contact_settings.registrant_contact` field. To
    # verify the email address, follow the
    # instructions in the email the `registrant_contact` receives following
    # registration. If you do not complete email verification within
    # 15 days of registration, the domain is suspended. To resend the
    # verification email, call ConfigureContactSettings and provide the current
    # `registrant_contact.email`.
    UNVERIFIED_EMAIL = 2
  end
end

#expire_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The expiration timestamp of the Registration.

Returns:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'proto_docs/google/cloud/domains/v1beta1/domains.rb', line 91

class Registration
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of a `Registration`.
  module State
    # The state is undefined.
    STATE_UNSPECIFIED = 0

    # The domain is being registered.
    REGISTRATION_PENDING = 1

    # The domain registration failed. You can delete resources in this state
    # to allow registration to be retried.
    REGISTRATION_FAILED = 2

    # The domain is being transferred from another registrar to Cloud Domains.
    TRANSFER_PENDING = 3

    # The attempt to transfer the domain from another registrar to
    # Cloud Domains failed. You can delete resources in this state and retry
    # the transfer.
    TRANSFER_FAILED = 4

    # The domain is registered and operational. The domain renews automatically
    # as long as it remains in this state.
    ACTIVE = 6

    # The domain is suspended and inoperative. For more details, see the
    # `issues` field.
    SUSPENDED = 7

    # The domain is no longer managed with Cloud Domains. It may have been
    # transferred to another registrar or exported for management in
    # [Google Domains](https://domains.google/). You can no longer update it
    # with this API, and information shown about it may be stale. Domains in
    # this state are not automatically renewed by Cloud Domains.
    EXPORTED = 8
  end

  # Possible issues with a `Registration` that require attention.
  module Issue
    # The issue is undefined.
    ISSUE_UNSPECIFIED = 0

    # Contact the Cloud Support team to resolve a problem with this domain.
    CONTACT_SUPPORT = 1

    # [ICANN](https://icann.org/) requires verification of the email address
    # in the `Registration`'s `contact_settings.registrant_contact` field. To
    # verify the email address, follow the
    # instructions in the email the `registrant_contact` receives following
    # registration. If you do not complete email verification within
    # 15 days of registration, the domain is suspended. To resend the
    # verification email, call ConfigureContactSettings and provide the current
    # `registrant_contact.email`.
    UNVERIFIED_EMAIL = 2
  end
end

#issues ⇒ ::Array<::Google::Cloud::Domains::V1beta1::Registration::Issue> (readonly)

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

Returns:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'proto_docs/google/cloud/domains/v1beta1/domains.rb', line 91

class Registration
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of a `Registration`.
  module State
    # The state is undefined.
    STATE_UNSPECIFIED = 0

    # The domain is being registered.
    REGISTRATION_PENDING = 1

    # The domain registration failed. You can delete resources in this state
    # to allow registration to be retried.
    REGISTRATION_FAILED = 2

    # The domain is being transferred from another registrar to Cloud Domains.
    TRANSFER_PENDING = 3

    # The attempt to transfer the domain from another registrar to
    # Cloud Domains failed. You can delete resources in this state and retry
    # the transfer.
    TRANSFER_FAILED = 4

    # The domain is registered and operational. The domain renews automatically
    # as long as it remains in this state.
    ACTIVE = 6

    # The domain is suspended and inoperative. For more details, see the
    # `issues` field.
    SUSPENDED = 7

    # The domain is no longer managed with Cloud Domains. It may have been
    # transferred to another registrar or exported for management in
    # [Google Domains](https://domains.google/). You can no longer update it
    # with this API, and information shown about it may be stale. Domains in
    # this state are not automatically renewed by Cloud Domains.
    EXPORTED = 8
  end

  # Possible issues with a `Registration` that require attention.
  module Issue
    # The issue is undefined.
    ISSUE_UNSPECIFIED = 0

    # Contact the Cloud Support team to resolve a problem with this domain.
    CONTACT_SUPPORT = 1

    # [ICANN](https://icann.org/) requires verification of the email address
    # in the `Registration`'s `contact_settings.registrant_contact` field. To
    # verify the email address, follow the
    # instructions in the email the `registrant_contact` receives following
    # registration. If you do not complete email verification within
    # 15 days of registration, the domain is suspended. To resend the
    # verification email, call ConfigureContactSettings and provide the current
    # `registrant_contact.email`.
    UNVERIFIED_EMAIL = 2
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Set of labels associated with the Registration.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Set of labels associated with the Registration.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'proto_docs/google/cloud/domains/v1beta1/domains.rb', line 91

class Registration
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of a `Registration`.
  module State
    # The state is undefined.
    STATE_UNSPECIFIED = 0

    # The domain is being registered.
    REGISTRATION_PENDING = 1

    # The domain registration failed. You can delete resources in this state
    # to allow registration to be retried.
    REGISTRATION_FAILED = 2

    # The domain is being transferred from another registrar to Cloud Domains.
    TRANSFER_PENDING = 3

    # The attempt to transfer the domain from another registrar to
    # Cloud Domains failed. You can delete resources in this state and retry
    # the transfer.
    TRANSFER_FAILED = 4

    # The domain is registered and operational. The domain renews automatically
    # as long as it remains in this state.
    ACTIVE = 6

    # The domain is suspended and inoperative. For more details, see the
    # `issues` field.
    SUSPENDED = 7

    # The domain is no longer managed with Cloud Domains. It may have been
    # transferred to another registrar or exported for management in
    # [Google Domains](https://domains.google/). You can no longer update it
    # with this API, and information shown about it may be stale. Domains in
    # this state are not automatically renewed by Cloud Domains.
    EXPORTED = 8
  end

  # Possible issues with a `Registration` that require attention.
  module Issue
    # The issue is undefined.
    ISSUE_UNSPECIFIED = 0

    # Contact the Cloud Support team to resolve a problem with this domain.
    CONTACT_SUPPORT = 1

    # [ICANN](https://icann.org/) requires verification of the email address
    # in the `Registration`'s `contact_settings.registrant_contact` field. To
    # verify the email address, follow the
    # instructions in the email the `registrant_contact` receives following
    # registration. If you do not complete email verification within
    # 15 days of registration, the domain is suspended. To resend the
    # verification email, call ConfigureContactSettings and provide the current
    # `registrant_contact.email`.
    UNVERIFIED_EMAIL = 2
  end
end

#management_settings ⇒ ::Google::Cloud::Domains::V1beta1::ManagementSettings

Returns 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.

Returns:

  • (::Google::Cloud::Domains::V1beta1::ManagementSettings) —

    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.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'proto_docs/google/cloud/domains/v1beta1/domains.rb', line 91

class Registration
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of a `Registration`.
  module State
    # The state is undefined.
    STATE_UNSPECIFIED = 0

    # The domain is being registered.
    REGISTRATION_PENDING = 1

    # The domain registration failed. You can delete resources in this state
    # to allow registration to be retried.
    REGISTRATION_FAILED = 2

    # The domain is being transferred from another registrar to Cloud Domains.
    TRANSFER_PENDING = 3

    # The attempt to transfer the domain from another registrar to
    # Cloud Domains failed. You can delete resources in this state and retry
    # the transfer.
    TRANSFER_FAILED = 4

    # The domain is registered and operational. The domain renews automatically
    # as long as it remains in this state.
    ACTIVE = 6

    # The domain is suspended and inoperative. For more details, see the
    # `issues` field.
    SUSPENDED = 7

    # The domain is no longer managed with Cloud Domains. It may have been
    # transferred to another registrar or exported for management in
    # [Google Domains](https://domains.google/). You can no longer update it
    # with this API, and information shown about it may be stale. Domains in
    # this state are not automatically renewed by Cloud Domains.
    EXPORTED = 8
  end

  # Possible issues with a `Registration` that require attention.
  module Issue
    # The issue is undefined.
    ISSUE_UNSPECIFIED = 0

    # Contact the Cloud Support team to resolve a problem with this domain.
    CONTACT_SUPPORT = 1

    # [ICANN](https://icann.org/) requires verification of the email address
    # in the `Registration`'s `contact_settings.registrant_contact` field. To
    # verify the email address, follow the
    # instructions in the email the `registrant_contact` receives following
    # registration. If you do not complete email verification within
    # 15 days of registration, the domain is suspended. To resend the
    # verification email, call ConfigureContactSettings and provide the current
    # `registrant_contact.email`.
    UNVERIFIED_EMAIL = 2
  end
end

#name ⇒ ::String (readonly)

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

Returns:

  • (::String) —

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'proto_docs/google/cloud/domains/v1beta1/domains.rb', line 91

class Registration
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of a `Registration`.
  module State
    # The state is undefined.
    STATE_UNSPECIFIED = 0

    # The domain is being registered.
    REGISTRATION_PENDING = 1

    # The domain registration failed. You can delete resources in this state
    # to allow registration to be retried.
    REGISTRATION_FAILED = 2

    # The domain is being transferred from another registrar to Cloud Domains.
    TRANSFER_PENDING = 3

    # The attempt to transfer the domain from another registrar to
    # Cloud Domains failed. You can delete resources in this state and retry
    # the transfer.
    TRANSFER_FAILED = 4

    # The domain is registered and operational. The domain renews automatically
    # as long as it remains in this state.
    ACTIVE = 6

    # The domain is suspended and inoperative. For more details, see the
    # `issues` field.
    SUSPENDED = 7

    # The domain is no longer managed with Cloud Domains. It may have been
    # transferred to another registrar or exported for management in
    # [Google Domains](https://domains.google/). You can no longer update it
    # with this API, and information shown about it may be stale. Domains in
    # this state are not automatically renewed by Cloud Domains.
    EXPORTED = 8
  end

  # Possible issues with a `Registration` that require attention.
  module Issue
    # The issue is undefined.
    ISSUE_UNSPECIFIED = 0

    # Contact the Cloud Support team to resolve a problem with this domain.
    CONTACT_SUPPORT = 1

    # [ICANN](https://icann.org/) requires verification of the email address
    # in the `Registration`'s `contact_settings.registrant_contact` field. To
    # verify the email address, follow the
    # instructions in the email the `registrant_contact` receives following
    # registration. If you do not complete email verification within
    # 15 days of registration, the domain is suspended. To resend the
    # verification email, call ConfigureContactSettings and provide the current
    # `registrant_contact.email`.
    UNVERIFIED_EMAIL = 2
  end
end

#pending_contact_settings ⇒ ::Google::Cloud::Domains::V1beta1::ContactSettings (readonly)

Returns 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.

Returns:

  • (::Google::Cloud::Domains::V1beta1::ContactSettings) —

    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.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'proto_docs/google/cloud/domains/v1beta1/domains.rb', line 91

class Registration
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of a `Registration`.
  module State
    # The state is undefined.
    STATE_UNSPECIFIED = 0

    # The domain is being registered.
    REGISTRATION_PENDING = 1

    # The domain registration failed. You can delete resources in this state
    # to allow registration to be retried.
    REGISTRATION_FAILED = 2

    # The domain is being transferred from another registrar to Cloud Domains.
    TRANSFER_PENDING = 3

    # The attempt to transfer the domain from another registrar to
    # Cloud Domains failed. You can delete resources in this state and retry
    # the transfer.
    TRANSFER_FAILED = 4

    # The domain is registered and operational. The domain renews automatically
    # as long as it remains in this state.
    ACTIVE = 6

    # The domain is suspended and inoperative. For more details, see the
    # `issues` field.
    SUSPENDED = 7

    # The domain is no longer managed with Cloud Domains. It may have been
    # transferred to another registrar or exported for management in
    # [Google Domains](https://domains.google/). You can no longer update it
    # with this API, and information shown about it may be stale. Domains in
    # this state are not automatically renewed by Cloud Domains.
    EXPORTED = 8
  end

  # Possible issues with a `Registration` that require attention.
  module Issue
    # The issue is undefined.
    ISSUE_UNSPECIFIED = 0

    # Contact the Cloud Support team to resolve a problem with this domain.
    CONTACT_SUPPORT = 1

    # [ICANN](https://icann.org/) requires verification of the email address
    # in the `Registration`'s `contact_settings.registrant_contact` field. To
    # verify the email address, follow the
    # instructions in the email the `registrant_contact` receives following
    # registration. If you do not complete email verification within
    # 15 days of registration, the domain is suspended. To resend the
    # verification email, call ConfigureContactSettings and provide the current
    # `registrant_contact.email`.
    UNVERIFIED_EMAIL = 2
  end
end

#state ⇒ ::Google::Cloud::Domains::V1beta1::Registration::State (readonly)

Returns Output only. The state of the Registration.

Returns:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'proto_docs/google/cloud/domains/v1beta1/domains.rb', line 91

class Registration
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of a `Registration`.
  module State
    # The state is undefined.
    STATE_UNSPECIFIED = 0

    # The domain is being registered.
    REGISTRATION_PENDING = 1

    # The domain registration failed. You can delete resources in this state
    # to allow registration to be retried.
    REGISTRATION_FAILED = 2

    # The domain is being transferred from another registrar to Cloud Domains.
    TRANSFER_PENDING = 3

    # The attempt to transfer the domain from another registrar to
    # Cloud Domains failed. You can delete resources in this state and retry
    # the transfer.
    TRANSFER_FAILED = 4

    # The domain is registered and operational. The domain renews automatically
    # as long as it remains in this state.
    ACTIVE = 6

    # The domain is suspended and inoperative. For more details, see the
    # `issues` field.
    SUSPENDED = 7

    # The domain is no longer managed with Cloud Domains. It may have been
    # transferred to another registrar or exported for management in
    # [Google Domains](https://domains.google/). You can no longer update it
    # with this API, and information shown about it may be stale. Domains in
    # this state are not automatically renewed by Cloud Domains.
    EXPORTED = 8
  end

  # Possible issues with a `Registration` that require attention.
  module Issue
    # The issue is undefined.
    ISSUE_UNSPECIFIED = 0

    # Contact the Cloud Support team to resolve a problem with this domain.
    CONTACT_SUPPORT = 1

    # [ICANN](https://icann.org/) requires verification of the email address
    # in the `Registration`'s `contact_settings.registrant_contact` field. To
    # verify the email address, follow the
    # instructions in the email the `registrant_contact` receives following
    # registration. If you do not complete email verification within
    # 15 days of registration, the domain is suspended. To resend the
    # verification email, call ConfigureContactSettings and provide the current
    # `registrant_contact.email`.
    UNVERIFIED_EMAIL = 2
  end
end

#supported_privacy ⇒ ::Array<::Google::Cloud::Domains::V1beta1::ContactPrivacy> (readonly)

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

Returns:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'proto_docs/google/cloud/domains/v1beta1/domains.rb', line 91

class Registration
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of a `Registration`.
  module State
    # The state is undefined.
    STATE_UNSPECIFIED = 0

    # The domain is being registered.
    REGISTRATION_PENDING = 1

    # The domain registration failed. You can delete resources in this state
    # to allow registration to be retried.
    REGISTRATION_FAILED = 2

    # The domain is being transferred from another registrar to Cloud Domains.
    TRANSFER_PENDING = 3

    # The attempt to transfer the domain from another registrar to
    # Cloud Domains failed. You can delete resources in this state and retry
    # the transfer.
    TRANSFER_FAILED = 4

    # The domain is registered and operational. The domain renews automatically
    # as long as it remains in this state.
    ACTIVE = 6

    # The domain is suspended and inoperative. For more details, see the
    # `issues` field.
    SUSPENDED = 7

    # The domain is no longer managed with Cloud Domains. It may have been
    # transferred to another registrar or exported for management in
    # [Google Domains](https://domains.google/). You can no longer update it
    # with this API, and information shown about it may be stale. Domains in
    # this state are not automatically renewed by Cloud Domains.
    EXPORTED = 8
  end

  # Possible issues with a `Registration` that require attention.
  module Issue
    # The issue is undefined.
    ISSUE_UNSPECIFIED = 0

    # Contact the Cloud Support team to resolve a problem with this domain.
    CONTACT_SUPPORT = 1

    # [ICANN](https://icann.org/) requires verification of the email address
    # in the `Registration`'s `contact_settings.registrant_contact` field. To
    # verify the email address, follow the
    # instructions in the email the `registrant_contact` receives following
    # registration. If you do not complete email verification within
    # 15 days of registration, the domain is suspended. To resend the
    # verification email, call ConfigureContactSettings and provide the current
    # `registrant_contact.email`.
    UNVERIFIED_EMAIL = 2
  end
end