Constants
Domains_SearchDomains_FullMethodName, Domains_RetrieveRegisterParameters_FullMethodName, Domains_RegisterDomain_FullMethodName, Domains_RetrieveTransferParameters_FullMethodName, Domains_TransferDomain_FullMethodName, Domains_ListRegistrations_FullMethodName, Domains_GetRegistration_FullMethodName, Domains_UpdateRegistration_FullMethodName, Domains_ConfigureManagementSettings_FullMethodName, Domains_ConfigureDnsSettings_FullMethodName, Domains_ConfigureContactSettings_FullMethodName, Domains_ExportRegistration_FullMethodName, Domains_DeleteRegistration_FullMethodName, Domains_RetrieveAuthorizationCode_FullMethodName, Domains_ResetAuthorizationCode_FullMethodName
const (
Domains_SearchDomains_FullMethodName = "/google.cloud.domains.v1beta1.Domains/SearchDomains"
Domains_RetrieveRegisterParameters_FullMethodName = "/google.cloud.domains.v1beta1.Domains/RetrieveRegisterParameters"
Domains_RegisterDomain_FullMethodName = "/google.cloud.domains.v1beta1.Domains/RegisterDomain"
Domains_RetrieveTransferParameters_FullMethodName = "/google.cloud.domains.v1beta1.Domains/RetrieveTransferParameters"
Domains_TransferDomain_FullMethodName = "/google.cloud.domains.v1beta1.Domains/TransferDomain"
Domains_ListRegistrations_FullMethodName = "/google.cloud.domains.v1beta1.Domains/ListRegistrations"
Domains_GetRegistration_FullMethodName = "/google.cloud.domains.v1beta1.Domains/GetRegistration"
Domains_UpdateRegistration_FullMethodName = "/google.cloud.domains.v1beta1.Domains/UpdateRegistration"
Domains_ConfigureManagementSettings_FullMethodName = "/google.cloud.domains.v1beta1.Domains/ConfigureManagementSettings"
Domains_ConfigureDnsSettings_FullMethodName = "/google.cloud.domains.v1beta1.Domains/ConfigureDnsSettings"
Domains_ConfigureContactSettings_FullMethodName = "/google.cloud.domains.v1beta1.Domains/ConfigureContactSettings"
Domains_ExportRegistration_FullMethodName = "/google.cloud.domains.v1beta1.Domains/ExportRegistration"
Domains_DeleteRegistration_FullMethodName = "/google.cloud.domains.v1beta1.Domains/DeleteRegistration"
Domains_RetrieveAuthorizationCode_FullMethodName = "/google.cloud.domains.v1beta1.Domains/RetrieveAuthorizationCode"
Domains_ResetAuthorizationCode_FullMethodName = "/google.cloud.domains.v1beta1.Domains/ResetAuthorizationCode"
)Variables
ContactPrivacy_name, ContactPrivacy_value
var (
ContactPrivacy_name = map[int32]string{
0: "CONTACT_PRIVACY_UNSPECIFIED",
1: "PUBLIC_CONTACT_DATA",
2: "PRIVATE_CONTACT_DATA",
3: "REDACTED_CONTACT_DATA",
}
ContactPrivacy_value = map[string]int32{
"CONTACT_PRIVACY_UNSPECIFIED": 0,
"PUBLIC_CONTACT_DATA": 1,
"PRIVATE_CONTACT_DATA": 2,
"REDACTED_CONTACT_DATA": 3,
}
)Enum value maps for ContactPrivacy.
DomainNotice_name, DomainNotice_value
var (
DomainNotice_name = map[int32]string{
0: "DOMAIN_NOTICE_UNSPECIFIED",
1: "HSTS_PRELOADED",
}
DomainNotice_value = map[string]int32{
"DOMAIN_NOTICE_UNSPECIFIED": 0,
"HSTS_PRELOADED": 1,
}
)Enum value maps for DomainNotice.
ContactNotice_name, ContactNotice_value
var (
ContactNotice_name = map[int32]string{
0: "CONTACT_NOTICE_UNSPECIFIED",
1: "PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT",
}
ContactNotice_value = map[string]int32{
"CONTACT_NOTICE_UNSPECIFIED": 0,
"PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT": 1,
}
)Enum value maps for ContactNotice.
TransferLockState_name, TransferLockState_value
var (
TransferLockState_name = map[int32]string{
0: "TRANSFER_LOCK_STATE_UNSPECIFIED",
1: "UNLOCKED",
2: "LOCKED",
}
TransferLockState_value = map[string]int32{
"TRANSFER_LOCK_STATE_UNSPECIFIED": 0,
"UNLOCKED": 1,
"LOCKED": 2,
}
)Enum value maps for TransferLockState.
Registration_State_name, Registration_State_value
var (
Registration_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "REGISTRATION_PENDING",
2: "REGISTRATION_FAILED",
3: "TRANSFER_PENDING",
4: "TRANSFER_FAILED",
6: "ACTIVE",
7: "SUSPENDED",
8: "EXPORTED",
}
Registration_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"REGISTRATION_PENDING": 1,
"REGISTRATION_FAILED": 2,
"TRANSFER_PENDING": 3,
"TRANSFER_FAILED": 4,
"ACTIVE": 6,
"SUSPENDED": 7,
"EXPORTED": 8,
}
)Enum value maps for Registration_State.
Registration_Issue_name, Registration_Issue_value
var (
Registration_Issue_name = map[int32]string{
0: "ISSUE_UNSPECIFIED",
1: "CONTACT_SUPPORT",
2: "UNVERIFIED_EMAIL",
}
Registration_Issue_value = map[string]int32{
"ISSUE_UNSPECIFIED": 0,
"CONTACT_SUPPORT": 1,
"UNVERIFIED_EMAIL": 2,
}
)Enum value maps for Registration_Issue.
ManagementSettings_RenewalMethod_name, ManagementSettings_RenewalMethod_value
var (
ManagementSettings_RenewalMethod_name = map[int32]string{
0: "RENEWAL_METHOD_UNSPECIFIED",
1: "AUTOMATIC_RENEWAL",
2: "MANUAL_RENEWAL",
}
ManagementSettings_RenewalMethod_value = map[string]int32{
"RENEWAL_METHOD_UNSPECIFIED": 0,
"AUTOMATIC_RENEWAL": 1,
"MANUAL_RENEWAL": 2,
}
)Enum value maps for ManagementSettings_RenewalMethod.
DnsSettings_DsState_name, DnsSettings_DsState_value
var (
DnsSettings_DsState_name = map[int32]string{
0: "DS_STATE_UNSPECIFIED",
1: "DS_RECORDS_UNPUBLISHED",
2: "DS_RECORDS_PUBLISHED",
}
DnsSettings_DsState_value = map[string]int32{
"DS_STATE_UNSPECIFIED": 0,
"DS_RECORDS_UNPUBLISHED": 1,
"DS_RECORDS_PUBLISHED": 2,
}
)Enum value maps for DnsSettings_DsState.
DnsSettings_DsRecord_Algorithm_name, DnsSettings_DsRecord_Algorithm_value
var (
DnsSettings_DsRecord_Algorithm_name = map[int32]string{
0: "ALGORITHM_UNSPECIFIED",
1: "RSAMD5",
2: "DH",
3: "DSA",
4: "ECC",
5: "RSASHA1",
6: "DSANSEC3SHA1",
7: "RSASHA1NSEC3SHA1",
8: "RSASHA256",
10: "RSASHA512",
12: "ECCGOST",
13: "ECDSAP256SHA256",
14: "ECDSAP384SHA384",
15: "ED25519",
16: "ED448",
252: "INDIRECT",
253: "PRIVATEDNS",
254: "PRIVATEOID",
}
DnsSettings_DsRecord_Algorithm_value = map[string]int32{
"ALGORITHM_UNSPECIFIED": 0,
"RSAMD5": 1,
"DH": 2,
"DSA": 3,
"ECC": 4,
"RSASHA1": 5,
"DSANSEC3SHA1": 6,
"RSASHA1NSEC3SHA1": 7,
"RSASHA256": 8,
"RSASHA512": 10,
"ECCGOST": 12,
"ECDSAP256SHA256": 13,
"ECDSAP384SHA384": 14,
"ED25519": 15,
"ED448": 16,
"INDIRECT": 252,
"PRIVATEDNS": 253,
"PRIVATEOID": 254,
}
)Enum value maps for DnsSettings_DsRecord_Algorithm.
DnsSettings_DsRecord_DigestType_name, DnsSettings_DsRecord_DigestType_value
var (
DnsSettings_DsRecord_DigestType_name = map[int32]string{
0: "DIGEST_TYPE_UNSPECIFIED",
1: "SHA1",
2: "SHA256",
3: "GOST3411",
4: "SHA384",
}
DnsSettings_DsRecord_DigestType_value = map[string]int32{
"DIGEST_TYPE_UNSPECIFIED": 0,
"SHA1": 1,
"SHA256": 2,
"GOST3411": 3,
"SHA384": 4,
}
)Enum value maps for DnsSettings_DsRecord_DigestType.
RegisterParameters_Availability_name, RegisterParameters_Availability_value
var (
RegisterParameters_Availability_name = map[int32]string{
0: "AVAILABILITY_UNSPECIFIED",
1: "AVAILABLE",
2: "UNAVAILABLE",
3: "UNSUPPORTED",
4: "UNKNOWN",
}
RegisterParameters_Availability_value = map[string]int32{
"AVAILABILITY_UNSPECIFIED": 0,
"AVAILABLE": 1,
"UNAVAILABLE": 2,
"UNSUPPORTED": 3,
"UNKNOWN": 4,
}
)Enum value maps for RegisterParameters_Availability.
Domains_ServiceDesc
var Domains_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.cloud.domains.v1beta1.Domains",
HandlerType: (*DomainsServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "SearchDomains",
Handler: _Domains_SearchDomains_Handler,
},
{
MethodName: "RetrieveRegisterParameters",
Handler: _Domains_RetrieveRegisterParameters_Handler,
},
{
MethodName: "RegisterDomain",
Handler: _Domains_RegisterDomain_Handler,
},
{
MethodName: "RetrieveTransferParameters",
Handler: _Domains_RetrieveTransferParameters_Handler,
},
{
MethodName: "TransferDomain",
Handler: _Domains_TransferDomain_Handler,
},
{
MethodName: "ListRegistrations",
Handler: _Domains_ListRegistrations_Handler,
},
{
MethodName: "GetRegistration",
Handler: _Domains_GetRegistration_Handler,
},
{
MethodName: "UpdateRegistration",
Handler: _Domains_UpdateRegistration_Handler,
},
{
MethodName: "ConfigureManagementSettings",
Handler: _Domains_ConfigureManagementSettings_Handler,
},
{
MethodName: "ConfigureDnsSettings",
Handler: _Domains_ConfigureDnsSettings_Handler,
},
{
MethodName: "ConfigureContactSettings",
Handler: _Domains_ConfigureContactSettings_Handler,
},
{
MethodName: "ExportRegistration",
Handler: _Domains_ExportRegistration_Handler,
},
{
MethodName: "DeleteRegistration",
Handler: _Domains_DeleteRegistration_Handler,
},
{
MethodName: "RetrieveAuthorizationCode",
Handler: _Domains_RetrieveAuthorizationCode_Handler,
},
{
MethodName: "ResetAuthorizationCode",
Handler: _Domains_ResetAuthorizationCode_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/cloud/domains/v1beta1/domains.proto",
}Domains_ServiceDesc is the grpc.ServiceDesc for Domains service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
File_google_cloud_domains_v1beta1_domains_proto
var File_google_cloud_domains_v1beta1_domains_proto protoreflect.FileDescriptorFunctions
func RegisterDomainsServer
func RegisterDomainsServer(s grpc.ServiceRegistrar, srv DomainsServer)AuthorizationCode
type AuthorizationCode struct {
// The Authorization Code in ASCII. It can be used to transfer the domain
// to or from another registrar.
Code string `protobuf:"bytes,1,opt,name=code,proto3" json:"code,omitempty"`
// contains filtered or unexported fields
}Defines an authorization code.
func (*AuthorizationCode) Descriptor
func (*AuthorizationCode) Descriptor() ([]byte, []int)Deprecated: Use AuthorizationCode.ProtoReflect.Descriptor instead.
func (*AuthorizationCode) GetCode
func (x *AuthorizationCode) GetCode() stringfunc (*AuthorizationCode) ProtoMessage
func (*AuthorizationCode) ProtoMessage()func (*AuthorizationCode) ProtoReflect
func (x *AuthorizationCode) ProtoReflect() protoreflect.Messagefunc (*AuthorizationCode) Reset
func (x *AuthorizationCode) Reset()func (*AuthorizationCode) String
func (x *AuthorizationCode) String() stringConfigureContactSettingsRequest
type ConfigureContactSettingsRequest struct {
// Required. The name of the `Registration` whose contact settings are being updated,
// in the format `projects/*/locations/*/registrations/*`.
Registration string `protobuf:"bytes,1,opt,name=registration,proto3" json:"registration,omitempty"`
// Fields of the `ContactSettings` to update.
ContactSettings *ContactSettings `protobuf:"bytes,2,opt,name=contact_settings,json=contactSettings,proto3" json:"contact_settings,omitempty"`
// Required. The field mask describing which fields to update as a comma-separated list.
// For example, if only the registrant contact is being updated, the
// `update_mask` is `"registrant_contact"`.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// The list of contact notices that the caller acknowledges. The notices
// needed here depend on the values specified in `contact_settings`.
ContactNotices []ContactNotice `protobuf:"varint,4,rep,packed,name=contact_notices,json=contactNotices,proto3,enum=google.cloud.domains.v1beta1.ContactNotice" json:"contact_notices,omitempty"`
// Validate the request without actually updating the contact settings.
ValidateOnly bool `protobuf:"varint,5,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// contains filtered or unexported fields
}Request for the ConfigureContactSettings method.
func (*ConfigureContactSettingsRequest) Descriptor
func (*ConfigureContactSettingsRequest) Descriptor() ([]byte, []int)Deprecated: Use ConfigureContactSettingsRequest.ProtoReflect.Descriptor instead.
func (*ConfigureContactSettingsRequest) GetContactNotices
func (x *ConfigureContactSettingsRequest) GetContactNotices() []ContactNoticefunc (*ConfigureContactSettingsRequest) GetContactSettings
func (x *ConfigureContactSettingsRequest) GetContactSettings() *ContactSettingsfunc (*ConfigureContactSettingsRequest) GetRegistration
func (x *ConfigureContactSettingsRequest) GetRegistration() stringfunc (*ConfigureContactSettingsRequest) GetUpdateMask
func (x *ConfigureContactSettingsRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*ConfigureContactSettingsRequest) GetValidateOnly
func (x *ConfigureContactSettingsRequest) GetValidateOnly() boolfunc (*ConfigureContactSettingsRequest) ProtoMessage
func (*ConfigureContactSettingsRequest) ProtoMessage()func (*ConfigureContactSettingsRequest) ProtoReflect
func (x *ConfigureContactSettingsRequest) ProtoReflect() protoreflect.Messagefunc (*ConfigureContactSettingsRequest) Reset
func (x *ConfigureContactSettingsRequest) Reset()func (*ConfigureContactSettingsRequest) String
func (x *ConfigureContactSettingsRequest) String() stringConfigureDnsSettingsRequest
type ConfigureDnsSettingsRequest struct {
// Required. The name of the `Registration` whose DNS settings are being updated,
// in the format `projects/*/locations/*/registrations/*`.
Registration string `protobuf:"bytes,1,opt,name=registration,proto3" json:"registration,omitempty"`
// Fields of the `DnsSettings` to update.
DnsSettings *DnsSettings `protobuf:"bytes,2,opt,name=dns_settings,json=dnsSettings,proto3" json:"dns_settings,omitempty"`
// Required. The field mask describing which fields to update as a comma-separated list.
// For example, if only the name servers are being updated for an existing
// Custom DNS configuration, the `update_mask` is
// `"custom_dns.name_servers"`.
//
// When changing the DNS provider from one type to another, pass the new
// provider's field name as part of the field mask. For example, when changing
// from a Google Domains DNS configuration to a Custom DNS configuration, the
// `update_mask` is `"custom_dns"`. //
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// Validate the request without actually updating the DNS settings.
ValidateOnly bool `protobuf:"varint,4,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// contains filtered or unexported fields
}Request for the ConfigureDnsSettings method.
func (*ConfigureDnsSettingsRequest) Descriptor
func (*ConfigureDnsSettingsRequest) Descriptor() ([]byte, []int)Deprecated: Use ConfigureDnsSettingsRequest.ProtoReflect.Descriptor instead.
func (*ConfigureDnsSettingsRequest) GetDnsSettings
func (x *ConfigureDnsSettingsRequest) GetDnsSettings() *DnsSettingsfunc (*ConfigureDnsSettingsRequest) GetRegistration
func (x *ConfigureDnsSettingsRequest) GetRegistration() stringfunc (*ConfigureDnsSettingsRequest) GetUpdateMask
func (x *ConfigureDnsSettingsRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*ConfigureDnsSettingsRequest) GetValidateOnly
func (x *ConfigureDnsSettingsRequest) GetValidateOnly() boolfunc (*ConfigureDnsSettingsRequest) ProtoMessage
func (*ConfigureDnsSettingsRequest) ProtoMessage()func (*ConfigureDnsSettingsRequest) ProtoReflect
func (x *ConfigureDnsSettingsRequest) ProtoReflect() protoreflect.Messagefunc (*ConfigureDnsSettingsRequest) Reset
func (x *ConfigureDnsSettingsRequest) Reset()func (*ConfigureDnsSettingsRequest) String
func (x *ConfigureDnsSettingsRequest) String() stringConfigureManagementSettingsRequest
type ConfigureManagementSettingsRequest struct {
// Required. The name of the `Registration` whose management settings are being updated,
// in the format `projects/*/locations/*/registrations/*`.
Registration string `protobuf:"bytes,1,opt,name=registration,proto3" json:"registration,omitempty"`
// Fields of the `ManagementSettings` to update.
ManagementSettings *ManagementSettings `protobuf:"bytes,2,opt,name=management_settings,json=managementSettings,proto3" json:"management_settings,omitempty"`
// Required. The field mask describing which fields to update as a comma-separated list.
// For example, if only the transfer lock is being updated, the `update_mask`
// is `"transfer_lock_state"`.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Request for the ConfigureManagementSettings method.
func (*ConfigureManagementSettingsRequest) Descriptor
func (*ConfigureManagementSettingsRequest) Descriptor() ([]byte, []int)Deprecated: Use ConfigureManagementSettingsRequest.ProtoReflect.Descriptor instead.
func (*ConfigureManagementSettingsRequest) GetManagementSettings
func (x *ConfigureManagementSettingsRequest) GetManagementSettings() *ManagementSettingsfunc (*ConfigureManagementSettingsRequest) GetRegistration
func (x *ConfigureManagementSettingsRequest) GetRegistration() stringfunc (*ConfigureManagementSettingsRequest) GetUpdateMask
func (x *ConfigureManagementSettingsRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*ConfigureManagementSettingsRequest) ProtoMessage
func (*ConfigureManagementSettingsRequest) ProtoMessage()func (*ConfigureManagementSettingsRequest) ProtoReflect
func (x *ConfigureManagementSettingsRequest) ProtoReflect() protoreflect.Messagefunc (*ConfigureManagementSettingsRequest) Reset
func (x *ConfigureManagementSettingsRequest) Reset()func (*ConfigureManagementSettingsRequest) String
func (x *ConfigureManagementSettingsRequest) String() stringContactNotice
type ContactNotice int32Notices related to contact information.
ContactNotice_CONTACT_NOTICE_UNSPECIFIED, ContactNotice_PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT
const (
// The notice is undefined.
ContactNotice_CONTACT_NOTICE_UNSPECIFIED ContactNotice = 0
// Required when setting the `privacy` field of `ContactSettings` to
// `PUBLIC_CONTACT_DATA`, which exposes contact data publicly.
ContactNotice_PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT ContactNotice = 1
)func (ContactNotice) Descriptor
func (ContactNotice) Descriptor() protoreflect.EnumDescriptorfunc (ContactNotice) Enum
func (x ContactNotice) Enum() *ContactNoticefunc (ContactNotice) EnumDescriptor
func (ContactNotice) EnumDescriptor() ([]byte, []int)Deprecated: Use ContactNotice.Descriptor instead.
func (ContactNotice) Number
func (x ContactNotice) Number() protoreflect.EnumNumberfunc (ContactNotice) String
func (x ContactNotice) String() stringfunc (ContactNotice) Type
func (ContactNotice) Type() protoreflect.EnumTypeContactPrivacy
type ContactPrivacy int32Defines a set of possible contact privacy settings for a Registration.
ICANN maintains the WHOIS database, a publicly
accessible mapping from domain name to contact information, and requires that
each domain name have an entry. Choose from these options to control how much
information in your ContactSettings is published.
ContactPrivacy_CONTACT_PRIVACY_UNSPECIFIED, ContactPrivacy_PUBLIC_CONTACT_DATA, ContactPrivacy_PRIVATE_CONTACT_DATA, ContactPrivacy_REDACTED_CONTACT_DATA
const (
// The contact privacy settings are undefined.
ContactPrivacy_CONTACT_PRIVACY_UNSPECIFIED ContactPrivacy = 0
// All the data from `ContactSettings` is publicly available. When setting
// this option, you must also provide a
// `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field of the
// request.
ContactPrivacy_PUBLIC_CONTACT_DATA ContactPrivacy = 1
// None of the data from `ContactSettings` is publicly available. Instead,
// proxy contact data is published for your domain. Email sent to the proxy
// email address is forwarded to the registrant's email address. Cloud Domains
// provides this privacy proxy service at no additional cost.
ContactPrivacy_PRIVATE_CONTACT_DATA ContactPrivacy = 2
// Some data from `ContactSettings` is publicly available. The actual
// information redacted depends on the domain. For details, see [the
// registration privacy
// article](https://support.google.com/domains/answer/3251242).
ContactPrivacy_REDACTED_CONTACT_DATA ContactPrivacy = 3
)func (ContactPrivacy) Descriptor
func (ContactPrivacy) Descriptor() protoreflect.EnumDescriptorfunc (ContactPrivacy) Enum
func (x ContactPrivacy) Enum() *ContactPrivacyfunc (ContactPrivacy) EnumDescriptor
func (ContactPrivacy) EnumDescriptor() ([]byte, []int)Deprecated: Use ContactPrivacy.Descriptor instead.
func (ContactPrivacy) Number
func (x ContactPrivacy) Number() protoreflect.EnumNumberfunc (ContactPrivacy) String
func (x ContactPrivacy) String() stringfunc (ContactPrivacy) Type
func (ContactPrivacy) Type() protoreflect.EnumTypeContactSettings
type ContactSettings struct {
// Required. Privacy setting for the contacts associated with the `Registration`.
Privacy ContactPrivacy `protobuf:"varint,1,opt,name=privacy,proto3,enum=google.cloud.domains.v1beta1.ContactPrivacy" json:"privacy,omitempty"`
// Required. The registrant contact for the `Registration`.
//
// *Caution: Anyone with access to this email address, phone number,
// and/or postal address can take control of the domain.*
//
// *Warning: For new `Registration`s, the registrant receives an email
// confirmation that they must complete within 15 days to avoid domain
// suspension.*
RegistrantContact *ContactSettings_Contact `protobuf:"bytes,2,opt,name=registrant_contact,json=registrantContact,proto3" json:"registrant_contact,omitempty"`
// Required. The administrative contact for the `Registration`.
AdminContact *ContactSettings_Contact `protobuf:"bytes,3,opt,name=admin_contact,json=adminContact,proto3" json:"admin_contact,omitempty"`
// Required. The technical contact for the `Registration`.
TechnicalContact *ContactSettings_Contact `protobuf:"bytes,4,opt,name=technical_contact,json=technicalContact,proto3" json:"technical_contact,omitempty"`
// contains filtered or unexported fields
}Defines the contact information associated with a Registration.
ICANN requires all domain names to have associated
contact information. The registrant_contact is considered the
domain's legal owner, and often the other contacts are identical.
func (*ContactSettings) Descriptor
func (*ContactSettings) Descriptor() ([]byte, []int)Deprecated: Use ContactSettings.ProtoReflect.Descriptor instead.
func (*ContactSettings) GetAdminContact
func (x *ContactSettings) GetAdminContact() *ContactSettings_Contactfunc (*ContactSettings) GetPrivacy
func (x *ContactSettings) GetPrivacy() ContactPrivacyfunc (*ContactSettings) GetRegistrantContact
func (x *ContactSettings) GetRegistrantContact() *ContactSettings_Contactfunc (*ContactSettings) GetTechnicalContact
func (x *ContactSettings) GetTechnicalContact() *ContactSettings_Contactfunc (*ContactSettings) ProtoMessage
func (*ContactSettings) ProtoMessage()func (*ContactSettings) ProtoReflect
func (x *ContactSettings) ProtoReflect() protoreflect.Messagefunc (*ContactSettings) Reset
func (x *ContactSettings) Reset()func (*ContactSettings) String
func (x *ContactSettings) String() stringContactSettings_Contact
type ContactSettings_Contact struct {
// Required. Postal address of the contact.
PostalAddress *postaladdress.PostalAddress `protobuf:"bytes,1,opt,name=postal_address,json=postalAddress,proto3" json:"postal_address,omitempty"`
// Required. Email address of the contact.
Email string `protobuf:"bytes,2,opt,name=email,proto3" json:"email,omitempty"`
// Required. Phone number of the contact in international format. For example,
// `"+1-800-555-0123"`.
PhoneNumber string `protobuf:"bytes,3,opt,name=phone_number,json=phoneNumber,proto3" json:"phone_number,omitempty"`
// Fax number of the contact in international format. For example,
// `"+1-800-555-0123"`.
FaxNumber string `protobuf:"bytes,4,opt,name=fax_number,json=faxNumber,proto3" json:"fax_number,omitempty"`
// contains filtered or unexported fields
}Details required for a contact associated with a Registration.
func (*ContactSettings_Contact) Descriptor
func (*ContactSettings_Contact) Descriptor() ([]byte, []int)Deprecated: Use ContactSettings_Contact.ProtoReflect.Descriptor instead.
func (*ContactSettings_Contact) GetEmail
func (x *ContactSettings_Contact) GetEmail() stringfunc (*ContactSettings_Contact) GetFaxNumber
func (x *ContactSettings_Contact) GetFaxNumber() stringfunc (*ContactSettings_Contact) GetPhoneNumber
func (x *ContactSettings_Contact) GetPhoneNumber() stringfunc (*ContactSettings_Contact) GetPostalAddress
func (x *ContactSettings_Contact) GetPostalAddress() *postaladdress.PostalAddressfunc (*ContactSettings_Contact) ProtoMessage
func (*ContactSettings_Contact) ProtoMessage()func (*ContactSettings_Contact) ProtoReflect
func (x *ContactSettings_Contact) ProtoReflect() protoreflect.Messagefunc (*ContactSettings_Contact) Reset
func (x *ContactSettings_Contact) Reset()func (*ContactSettings_Contact) String
func (x *ContactSettings_Contact) String() stringDeleteRegistrationRequest
type DeleteRegistrationRequest struct {
// Required. The name of the `Registration` to delete,
// in the format `projects/*/locations/*/registrations/*`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request for the DeleteRegistration method.
func (*DeleteRegistrationRequest) Descriptor
func (*DeleteRegistrationRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteRegistrationRequest.ProtoReflect.Descriptor instead.
func (*DeleteRegistrationRequest) GetName
func (x *DeleteRegistrationRequest) GetName() stringfunc (*DeleteRegistrationRequest) ProtoMessage
func (*DeleteRegistrationRequest) ProtoMessage()func (*DeleteRegistrationRequest) ProtoReflect
func (x *DeleteRegistrationRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteRegistrationRequest) Reset
func (x *DeleteRegistrationRequest) Reset()func (*DeleteRegistrationRequest) String
func (x *DeleteRegistrationRequest) String() stringDnsSettings
type DnsSettings struct {
// The DNS provider of the registration.
//
// Types that are assignable to DnsProvider:
//
// *DnsSettings_CustomDns_
// *DnsSettings_GoogleDomainsDns_
DnsProvider isDnsSettings_DnsProvider `protobuf_oneof:"dns_provider"`
// The list of glue records for this `Registration`. Commonly empty.
GlueRecords []*DnsSettings_GlueRecord `protobuf:"bytes,4,rep,name=glue_records,json=glueRecords,proto3" json:"glue_records,omitempty"`
// contains filtered or unexported fields
}Defines the DNS configuration of a Registration, including name servers,
DNSSEC, and glue records.
func (*DnsSettings) Descriptor
func (*DnsSettings) Descriptor() ([]byte, []int)Deprecated: Use DnsSettings.ProtoReflect.Descriptor instead.
func (*DnsSettings) GetCustomDns
func (x *DnsSettings) GetCustomDns() *DnsSettings_CustomDnsfunc (*DnsSettings) GetDnsProvider
func (m *DnsSettings) GetDnsProvider() isDnsSettings_DnsProviderfunc (*DnsSettings) GetGlueRecords
func (x *DnsSettings) GetGlueRecords() []*DnsSettings_GlueRecordfunc (*DnsSettings) GetGoogleDomainsDns
func (x *DnsSettings) GetGoogleDomainsDns() *DnsSettings_GoogleDomainsDnsfunc (*DnsSettings) ProtoMessage
func (*DnsSettings) ProtoMessage()func (*DnsSettings) ProtoReflect
func (x *DnsSettings) ProtoReflect() protoreflect.Messagefunc (*DnsSettings) Reset
func (x *DnsSettings) Reset()func (*DnsSettings) String
func (x *DnsSettings) String() stringDnsSettings_CustomDns
type DnsSettings_CustomDns struct {
// Required. A list of name servers that store the DNS zone for this domain. Each name
// server is a domain name, with Unicode domain names expressed in
// Punycode format.
NameServers []string `protobuf:"bytes,1,rep,name=name_servers,json=nameServers,proto3" json:"name_servers,omitempty"`
// The list of DS records for this domain, which are used to enable DNSSEC.
// The domain's DNS provider can provide the values to set here. If this
// field is empty, DNSSEC is disabled.
DsRecords []*DnsSettings_DsRecord `protobuf:"bytes,2,rep,name=ds_records,json=dsRecords,proto3" json:"ds_records,omitempty"`
// contains filtered or unexported fields
}Configuration for an arbitrary DNS provider.
func (*DnsSettings_CustomDns) Descriptor
func (*DnsSettings_CustomDns) Descriptor() ([]byte, []int)Deprecated: Use DnsSettings_CustomDns.ProtoReflect.Descriptor instead.
func (*DnsSettings_CustomDns) GetDsRecords
func (x *DnsSettings_CustomDns) GetDsRecords() []*DnsSettings_DsRecordfunc (*DnsSettings_CustomDns) GetNameServers
func (x *DnsSettings_CustomDns) GetNameServers() []stringfunc (*DnsSettings_CustomDns) ProtoMessage
func (*DnsSettings_CustomDns) ProtoMessage()func (*DnsSettings_CustomDns) ProtoReflect
func (x *DnsSettings_CustomDns) ProtoReflect() protoreflect.Messagefunc (*DnsSettings_CustomDns) Reset
func (x *DnsSettings_CustomDns) Reset()func (*DnsSettings_CustomDns) String
func (x *DnsSettings_CustomDns) String() stringDnsSettings_CustomDns_
type DnsSettings_CustomDns_ struct {
// An arbitrary DNS provider identified by its name servers.
CustomDns *DnsSettings_CustomDns `protobuf:"bytes,1,opt,name=custom_dns,json=customDns,proto3,oneof"`
}DnsSettings_DsRecord
type DnsSettings_DsRecord struct {
// The key tag of the record. Must be set in range 0 -- 65535.
KeyTag int32 `protobuf:"varint,1,opt,name=key_tag,json=keyTag,proto3" json:"key_tag,omitempty"`
// The algorithm used to generate the referenced DNSKEY.
Algorithm DnsSettings_DsRecord_Algorithm `protobuf:"varint,2,opt,name=algorithm,proto3,enum=google.cloud.domains.v1beta1.DnsSettings_DsRecord_Algorithm" json:"algorithm,omitempty"`
// The hash function used to generate the digest of the referenced DNSKEY.
DigestType DnsSettings_DsRecord_DigestType `protobuf:"varint,3,opt,name=digest_type,json=digestType,proto3,enum=google.cloud.domains.v1beta1.DnsSettings_DsRecord_DigestType" json:"digest_type,omitempty"`
// The digest generated from the referenced DNSKEY.
Digest string `protobuf:"bytes,4,opt,name=digest,proto3" json:"digest,omitempty"`
// contains filtered or unexported fields
}Defines a Delegation Signer (DS) record, which is needed to enable DNSSEC for a domain. It contains a digest (hash) of a DNSKEY record that must be present in the domain's DNS zone.
func (*DnsSettings_DsRecord) Descriptor
func (*DnsSettings_DsRecord) Descriptor() ([]byte, []int)Deprecated: Use DnsSettings_DsRecord.ProtoReflect.Descriptor instead.
func (*DnsSettings_DsRecord) GetAlgorithm
func (x *DnsSettings_DsRecord) GetAlgorithm() DnsSettings_DsRecord_Algorithmfunc (*DnsSettings_DsRecord) GetDigest
func (x *DnsSettings_DsRecord) GetDigest() stringfunc (*DnsSettings_DsRecord) GetDigestType
func (x *DnsSettings_DsRecord) GetDigestType() DnsSettings_DsRecord_DigestTypefunc (*DnsSettings_DsRecord) GetKeyTag
func (x *DnsSettings_DsRecord) GetKeyTag() int32func (*DnsSettings_DsRecord) ProtoMessage
func (*DnsSettings_DsRecord) ProtoMessage()func (*DnsSettings_DsRecord) ProtoReflect
func (x *DnsSettings_DsRecord) ProtoReflect() protoreflect.Messagefunc (*DnsSettings_DsRecord) Reset
func (x *DnsSettings_DsRecord) Reset()func (*DnsSettings_DsRecord) String
func (x *DnsSettings_DsRecord) String() stringDnsSettings_DsRecord_Algorithm
type DnsSettings_DsRecord_Algorithm int32List of algorithms used to create a DNSKEY. Certain algorithms are not supported for particular domains.
DnsSettings_DsRecord_ALGORITHM_UNSPECIFIED, DnsSettings_DsRecord_RSAMD5, DnsSettings_DsRecord_DH, DnsSettings_DsRecord_DSA, DnsSettings_DsRecord_ECC, DnsSettings_DsRecord_RSASHA1, DnsSettings_DsRecord_DSANSEC3SHA1, DnsSettings_DsRecord_RSASHA1NSEC3SHA1, DnsSettings_DsRecord_RSASHA256, DnsSettings_DsRecord_RSASHA512, DnsSettings_DsRecord_ECCGOST, DnsSettings_DsRecord_ECDSAP256SHA256, DnsSettings_DsRecord_ECDSAP384SHA384, DnsSettings_DsRecord_ED25519, DnsSettings_DsRecord_ED448, DnsSettings_DsRecord_INDIRECT, DnsSettings_DsRecord_PRIVATEDNS, DnsSettings_DsRecord_PRIVATEOID
const (
// The algorithm is unspecified.
DnsSettings_DsRecord_ALGORITHM_UNSPECIFIED DnsSettings_DsRecord_Algorithm = 0
// RSA/MD5. Cannot be used for new deployments.
DnsSettings_DsRecord_RSAMD5 DnsSettings_DsRecord_Algorithm = 1
// Diffie-Hellman. Cannot be used for new deployments.
DnsSettings_DsRecord_DH DnsSettings_DsRecord_Algorithm = 2
// DSA/SHA1. Not recommended for new deployments.
DnsSettings_DsRecord_DSA DnsSettings_DsRecord_Algorithm = 3
// ECC. Not recommended for new deployments.
DnsSettings_DsRecord_ECC DnsSettings_DsRecord_Algorithm = 4
// RSA/SHA-1. Not recommended for new deployments.
DnsSettings_DsRecord_RSASHA1 DnsSettings_DsRecord_Algorithm = 5
// DSA-NSEC3-SHA1. Not recommended for new deployments.
DnsSettings_DsRecord_DSANSEC3SHA1 DnsSettings_DsRecord_Algorithm = 6
// RSA/SHA1-NSEC3-SHA1. Not recommended for new deployments.
DnsSettings_DsRecord_RSASHA1NSEC3SHA1 DnsSettings_DsRecord_Algorithm = 7
// RSA/SHA-256.
DnsSettings_DsRecord_RSASHA256 DnsSettings_DsRecord_Algorithm = 8
// RSA/SHA-512.
DnsSettings_DsRecord_RSASHA512 DnsSettings_DsRecord_Algorithm = 10
// GOST R 34.10-2001.
DnsSettings_DsRecord_ECCGOST DnsSettings_DsRecord_Algorithm = 12
// ECDSA Curve P-256 with SHA-256.
DnsSettings_DsRecord_ECDSAP256SHA256 DnsSettings_DsRecord_Algorithm = 13
// ECDSA Curve P-384 with SHA-384.
DnsSettings_DsRecord_ECDSAP384SHA384 DnsSettings_DsRecord_Algorithm = 14
// Ed25519.
DnsSettings_DsRecord_ED25519 DnsSettings_DsRecord_Algorithm = 15
// Ed448.
DnsSettings_DsRecord_ED448 DnsSettings_DsRecord_Algorithm = 16
// Reserved for Indirect Keys. Cannot be used for new deployments.
DnsSettings_DsRecord_INDIRECT DnsSettings_DsRecord_Algorithm = 252
// Private algorithm. Cannot be used for new deployments.
DnsSettings_DsRecord_PRIVATEDNS DnsSettings_DsRecord_Algorithm = 253
// Private algorithm OID. Cannot be used for new deployments.
DnsSettings_DsRecord_PRIVATEOID DnsSettings_DsRecord_Algorithm = 254
)func (DnsSettings_DsRecord_Algorithm) Descriptor
func (DnsSettings_DsRecord_Algorithm) Descriptor() protoreflect.EnumDescriptorfunc (DnsSettings_DsRecord_Algorithm) Enum
func (x DnsSettings_DsRecord_Algorithm) Enum() *DnsSettings_DsRecord_Algorithmfunc (DnsSettings_DsRecord_Algorithm) EnumDescriptor
func (DnsSettings_DsRecord_Algorithm) EnumDescriptor() ([]byte, []int)Deprecated: Use DnsSettings_DsRecord_Algorithm.Descriptor instead.
func (DnsSettings_DsRecord_Algorithm) Number
func (x DnsSettings_DsRecord_Algorithm) Number() protoreflect.EnumNumberfunc (DnsSettings_DsRecord_Algorithm) String
func (x DnsSettings_DsRecord_Algorithm) String() stringfunc (DnsSettings_DsRecord_Algorithm) Type
func (DnsSettings_DsRecord_Algorithm) Type() protoreflect.EnumTypeDnsSettings_DsRecord_DigestType
type DnsSettings_DsRecord_DigestType int32List of hash functions that may have been used to generate a digest of a DNSKEY.
DnsSettings_DsRecord_DIGEST_TYPE_UNSPECIFIED, DnsSettings_DsRecord_SHA1, DnsSettings_DsRecord_SHA256, DnsSettings_DsRecord_GOST3411, DnsSettings_DsRecord_SHA384
const (
// The DigestType is unspecified.
DnsSettings_DsRecord_DIGEST_TYPE_UNSPECIFIED DnsSettings_DsRecord_DigestType = 0
// SHA-1. Not recommended for new deployments.
DnsSettings_DsRecord_SHA1 DnsSettings_DsRecord_DigestType = 1
// SHA-256.
DnsSettings_DsRecord_SHA256 DnsSettings_DsRecord_DigestType = 2
// GOST R 34.11-94.
DnsSettings_DsRecord_GOST3411 DnsSettings_DsRecord_DigestType = 3
// SHA-384.
DnsSettings_DsRecord_SHA384 DnsSettings_DsRecord_DigestType = 4
)func (DnsSettings_DsRecord_DigestType) Descriptor
func (DnsSettings_DsRecord_DigestType) Descriptor() protoreflect.EnumDescriptorfunc (DnsSettings_DsRecord_DigestType) Enum
func (x DnsSettings_DsRecord_DigestType) Enum() *DnsSettings_DsRecord_DigestTypefunc (DnsSettings_DsRecord_DigestType) EnumDescriptor
func (DnsSettings_DsRecord_DigestType) EnumDescriptor() ([]byte, []int)Deprecated: Use DnsSettings_DsRecord_DigestType.Descriptor instead.
func (DnsSettings_DsRecord_DigestType) Number
func (x DnsSettings_DsRecord_DigestType) Number() protoreflect.EnumNumberfunc (DnsSettings_DsRecord_DigestType) String
func (x DnsSettings_DsRecord_DigestType) String() stringfunc (DnsSettings_DsRecord_DigestType) Type
func (DnsSettings_DsRecord_DigestType) Type() protoreflect.EnumTypeDnsSettings_DsState
type DnsSettings_DsState int32The publication state of DS records for a Registration.
DnsSettings_DS_STATE_UNSPECIFIED, DnsSettings_DS_RECORDS_UNPUBLISHED, DnsSettings_DS_RECORDS_PUBLISHED
const (
// DS state is unspecified.
DnsSettings_DS_STATE_UNSPECIFIED DnsSettings_DsState = 0
// DNSSEC is disabled for this domain. No DS records for this domain are
// published in the parent DNS zone.
DnsSettings_DS_RECORDS_UNPUBLISHED DnsSettings_DsState = 1
// DNSSEC is enabled for this domain. Appropriate DS records for this domain
// are published in the parent DNS zone. This option is valid only if the
// DNS zone referenced in the `Registration`'s `dns_provider` field is
// already DNSSEC-signed.
DnsSettings_DS_RECORDS_PUBLISHED DnsSettings_DsState = 2
)func (DnsSettings_DsState) Descriptor
func (DnsSettings_DsState) Descriptor() protoreflect.EnumDescriptorfunc (DnsSettings_DsState) Enum
func (x DnsSettings_DsState) Enum() *DnsSettings_DsStatefunc (DnsSettings_DsState) EnumDescriptor
func (DnsSettings_DsState) EnumDescriptor() ([]byte, []int)Deprecated: Use DnsSettings_DsState.Descriptor instead.
func (DnsSettings_DsState) Number
func (x DnsSettings_DsState) Number() protoreflect.EnumNumberfunc (DnsSettings_DsState) String
func (x DnsSettings_DsState) String() stringfunc (DnsSettings_DsState) Type
func (DnsSettings_DsState) Type() protoreflect.EnumTypeDnsSettings_GlueRecord
type DnsSettings_GlueRecord struct {
// Required. Domain name of the host in Punycode format.
HostName string `protobuf:"bytes,1,opt,name=host_name,json=hostName,proto3" json:"host_name,omitempty"`
// List of IPv4 addresses corresponding to this host in the standard decimal
// format (e.g. `198.51.100.1`). At least one of `ipv4_address` and
// `ipv6_address` must be set.
Ipv4Addresses []string `protobuf:"bytes,2,rep,name=ipv4_addresses,json=ipv4Addresses,proto3" json:"ipv4_addresses,omitempty"`
// List of IPv6 addresses corresponding to this host in the standard
// hexadecimal format (e.g. `2001:db8::`). At least one of
// `ipv4_address` and `ipv6_address` must be set.
Ipv6Addresses []string `protobuf:"bytes,3,rep,name=ipv6_addresses,json=ipv6Addresses,proto3" json:"ipv6_addresses,omitempty"`
// contains filtered or unexported fields
}Defines a host on your domain that is a DNS name server for your domain
and/or other domains. Glue records are a way of making the IP address of a
name server known, even when it serves DNS queries for its parent domain.
For example, when ns.example.com is a name server for example.com, the
host ns.example.com must have a glue record to break the circular DNS
reference.
func (*DnsSettings_GlueRecord) Descriptor
func (*DnsSettings_GlueRecord) Descriptor() ([]byte, []int)Deprecated: Use DnsSettings_GlueRecord.ProtoReflect.Descriptor instead.
func (*DnsSettings_GlueRecord) GetHostName
func (x *DnsSettings_GlueRecord) GetHostName() stringfunc (*DnsSettings_GlueRecord) GetIpv4Addresses
func (x *DnsSettings_GlueRecord) GetIpv4Addresses() []stringfunc (*DnsSettings_GlueRecord) GetIpv6Addresses
func (x *DnsSettings_GlueRecord) GetIpv6Addresses() []stringfunc (*DnsSettings_GlueRecord) ProtoMessage
func (*DnsSettings_GlueRecord) ProtoMessage()func (*DnsSettings_GlueRecord) ProtoReflect
func (x *DnsSettings_GlueRecord) ProtoReflect() protoreflect.Messagefunc (*DnsSettings_GlueRecord) Reset
func (x *DnsSettings_GlueRecord) Reset()func (*DnsSettings_GlueRecord) String
func (x *DnsSettings_GlueRecord) String() stringDnsSettings_GoogleDomainsDns
type DnsSettings_GoogleDomainsDns struct {
// Output only. A list of name servers that store the DNS zone for this domain. Each name
// server is a domain name, with Unicode domain names expressed in
// Punycode format. This field is automatically populated with the name
// servers assigned to the Google Domains DNS zone.
NameServers []string `protobuf:"bytes,1,rep,name=name_servers,json=nameServers,proto3" json:"name_servers,omitempty"`
// Required. The state of DS records for this domain. Used to enable or disable
// automatic DNSSEC.
DsState DnsSettings_DsState `protobuf:"varint,2,opt,name=ds_state,json=dsState,proto3,enum=google.cloud.domains.v1beta1.DnsSettings_DsState" json:"ds_state,omitempty"`
// Output only. The list of DS records published for this domain. The list is
// automatically populated when `ds_state` is `DS_RECORDS_PUBLISHED`,
// otherwise it remains empty.
DsRecords []*DnsSettings_DsRecord `protobuf:"bytes,3,rep,name=ds_records,json=dsRecords,proto3" json:"ds_records,omitempty"`
// contains filtered or unexported fields
}Configuration for using the free DNS zone provided by Google Domains as a
Registration's dns_provider. You cannot configure the DNS zone itself
using the API. To configure the DNS zone, go to
Google Domains.
func (*DnsSettings_GoogleDomainsDns) Descriptor
func (*DnsSettings_GoogleDomainsDns) Descriptor() ([]byte, []int)Deprecated: Use DnsSettings_GoogleDomainsDns.ProtoReflect.Descriptor instead.
func (*DnsSettings_GoogleDomainsDns) GetDsRecords
func (x *DnsSettings_GoogleDomainsDns) GetDsRecords() []*DnsSettings_DsRecordfunc (*DnsSettings_GoogleDomainsDns) GetDsState
func (x *DnsSettings_GoogleDomainsDns) GetDsState() DnsSettings_DsStatefunc (*DnsSettings_GoogleDomainsDns) GetNameServers
func (x *DnsSettings_GoogleDomainsDns) GetNameServers() []stringfunc (*DnsSettings_GoogleDomainsDns) ProtoMessage
func (*DnsSettings_GoogleDomainsDns) ProtoMessage()func (*DnsSettings_GoogleDomainsDns) ProtoReflect
func (x *DnsSettings_GoogleDomainsDns) ProtoReflect() protoreflect.Messagefunc (*DnsSettings_GoogleDomainsDns) Reset
func (x *DnsSettings_GoogleDomainsDns) Reset()func (*DnsSettings_GoogleDomainsDns) String
func (x *DnsSettings_GoogleDomainsDns) String() stringDnsSettings_GoogleDomainsDns_
type DnsSettings_GoogleDomainsDns_ struct {
// The free DNS zone provided by
// [Google Domains](https://domains.google/).
GoogleDomainsDns *DnsSettings_GoogleDomainsDns `protobuf:"bytes,2,opt,name=google_domains_dns,json=googleDomainsDns,proto3,oneof"`
}DomainNotice
type DomainNotice int32Notices about special properties of certain domains.
DomainNotice_DOMAIN_NOTICE_UNSPECIFIED, DomainNotice_HSTS_PRELOADED
const (
// The notice is undefined.
DomainNotice_DOMAIN_NOTICE_UNSPECIFIED DomainNotice = 0
// Indicates that the domain is preloaded on the HTTP Strict Transport
// Security list in browsers. Serving a website on such domain requires
// an SSL certificate. For details, see
// [how to get an SSL
// certificate](https://support.google.com/domains/answer/7638036).
DomainNotice_HSTS_PRELOADED DomainNotice = 1
)func (DomainNotice) Descriptor
func (DomainNotice) Descriptor() protoreflect.EnumDescriptorfunc (DomainNotice) Enum
func (x DomainNotice) Enum() *DomainNoticefunc (DomainNotice) EnumDescriptor
func (DomainNotice) EnumDescriptor() ([]byte, []int)Deprecated: Use DomainNotice.Descriptor instead.
func (DomainNotice) Number
func (x DomainNotice) Number() protoreflect.EnumNumberfunc (DomainNotice) String
func (x DomainNotice) String() stringfunc (DomainNotice) Type
func (DomainNotice) Type() protoreflect.EnumTypeDomainsClient
type DomainsClient interface {
// Searches for available domain names similar to the provided query.
//
// Availability results from this method are approximate; call
// `RetrieveRegisterParameters` on a domain before registering to confirm
// availability.
SearchDomains(ctx context.Context, in *SearchDomainsRequest, opts ...grpc.CallOption) (*SearchDomainsResponse, error)
// Gets parameters needed to register a new domain name, including price and
// up-to-date availability. Use the returned values to call `RegisterDomain`.
RetrieveRegisterParameters(ctx context.Context, in *RetrieveRegisterParametersRequest, opts ...grpc.CallOption) (*RetrieveRegisterParametersResponse, error)
// Registers a new domain name and creates a corresponding `Registration`
// resource.
//
// Call `RetrieveRegisterParameters` first to check availability of the domain
// name and determine parameters like price that are needed to build a call to
// this method.
//
// A successful call creates a `Registration` resource in state
// `REGISTRATION_PENDING`, which resolves to `ACTIVE` within 1-2
// minutes, indicating that the domain was successfully registered. If the
// resource ends up in state `REGISTRATION_FAILED`, it indicates that the
// domain was not registered successfully, and you can safely delete the
// resource and retry registration.
RegisterDomain(ctx context.Context, in *RegisterDomainRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Gets parameters needed to transfer a domain name from another registrar to
// Cloud Domains. For domains managed by Google Domains, transferring to Cloud
// Domains is not supported.
//
// Use the returned values to call `TransferDomain`.
RetrieveTransferParameters(ctx context.Context, in *RetrieveTransferParametersRequest, opts ...grpc.CallOption) (*RetrieveTransferParametersResponse, error)
// Transfers a domain name from another registrar to Cloud Domains. For
// domains managed by Google Domains, transferring to Cloud Domains is not
// supported.
//
// Before calling this method, go to the domain's 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 this method.
//
// A successful call creates a `Registration` resource in state
// `TRANSFER_PENDING`. It can take several days to complete the transfer
// process. The registrant can often speed up this process by approving the
// transfer through the current registrar, either by clicking a link in an
// email from the registrar or by visiting the registrar's website.
//
// A few minutes after transfer approval, the resource transitions to state
// `ACTIVE`, indicating that the transfer was successful. If the transfer is
// rejected or the request expires without being approved, the resource can
// end up in state `TRANSFER_FAILED`. If transfer fails, you can safely delete
// the resource and retry the transfer.
TransferDomain(ctx context.Context, in *TransferDomainRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Lists the `Registration` resources in a project.
ListRegistrations(ctx context.Context, in *ListRegistrationsRequest, opts ...grpc.CallOption) (*ListRegistrationsResponse, error)
// Gets the details of a `Registration` resource.
GetRegistration(ctx context.Context, in *GetRegistrationRequest, opts ...grpc.CallOption) (*Registration, error)
// Updates select fields of a `Registration` resource, notably `labels`. To
// update other fields, use the appropriate custom update method:
//
// * To update management settings, see `ConfigureManagementSettings`
// * To update DNS configuration, see `ConfigureDnsSettings`
// * To update contact information, see `ConfigureContactSettings`
UpdateRegistration(ctx context.Context, in *UpdateRegistrationRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Updates a `Registration`'s management settings.
ConfigureManagementSettings(ctx context.Context, in *ConfigureManagementSettingsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Updates a `Registration`'s DNS settings.
ConfigureDnsSettings(ctx context.Context, in *ConfigureDnsSettingsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Updates a `Registration`'s contact settings. Some changes require
// confirmation by the domain's registrant contact .
ConfigureContactSettings(ctx context.Context, in *ConfigureContactSettingsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Exports a `Registration` resource, such that it is no longer managed by
// Cloud Domains.
//
// When an active domain is successfully exported, you can continue to use the
// domain in [Google Domains](https://domains.google/) until it expires. The
// calling user becomes the domain's sole owner in Google Domains, and
// permissions for the domain are subsequently managed there. The domain does
// not renew automatically unless the new owner sets up billing in Google
// Domains.
ExportRegistration(ctx context.Context, in *ExportRegistrationRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Deletes a `Registration` resource.
//
// This method works on any `Registration` resource using [Subscription or
// Commitment billing](https://cloud.google.com/domains/pricing#billing-models), provided that the
// resource was created at least 1 day in the past.
//
// For `Registration` resources using
// [Monthly billing](https://cloud.google.com/domains/pricing#billing-models), this method works if:
//
// * `state` is `EXPORTED` with `expire_time` in the past
// * `state` is `REGISTRATION_FAILED`
// * `state` is `TRANSFER_FAILED`
//
// When an active registration is successfully deleted, you can continue to
// use the domain in [Google Domains](https://domains.google/) until it
// expires. The calling user becomes the domain's sole owner in Google
// Domains, and permissions for the domain are subsequently managed there. The
// domain does not renew automatically unless the new owner sets up billing in
// Google Domains.
DeleteRegistration(ctx context.Context, in *DeleteRegistrationRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Gets the authorization code of the `Registration` for the purpose of
// transferring the domain to another registrar.
//
// You can call this method only after 60 days have elapsed since the initial
// domain registration.
RetrieveAuthorizationCode(ctx context.Context, in *RetrieveAuthorizationCodeRequest, opts ...grpc.CallOption) (*AuthorizationCode, error)
// Resets the authorization code of the `Registration` to a new random string.
//
// You can call this method only after 60 days have elapsed since the initial
// domain registration.
ResetAuthorizationCode(ctx context.Context, in *ResetAuthorizationCodeRequest, opts ...grpc.CallOption) (*AuthorizationCode, error)
}DomainsClient is the client API for Domains service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewDomainsClient
func NewDomainsClient(cc grpc.ClientConnInterface) DomainsClientDomainsServer
type DomainsServer interface {
// Searches for available domain names similar to the provided query.
//
// Availability results from this method are approximate; call
// `RetrieveRegisterParameters` on a domain before registering to confirm
// availability.
SearchDomains(context.Context, *SearchDomainsRequest) (*SearchDomainsResponse, error)
// Gets parameters needed to register a new domain name, including price and
// up-to-date availability. Use the returned values to call `RegisterDomain`.
RetrieveRegisterParameters(context.Context, *RetrieveRegisterParametersRequest) (*RetrieveRegisterParametersResponse, error)
// Registers a new domain name and creates a corresponding `Registration`
// resource.
//
// Call `RetrieveRegisterParameters` first to check availability of the domain
// name and determine parameters like price that are needed to build a call to
// this method.
//
// A successful call creates a `Registration` resource in state
// `REGISTRATION_PENDING`, which resolves to `ACTIVE` within 1-2
// minutes, indicating that the domain was successfully registered. If the
// resource ends up in state `REGISTRATION_FAILED`, it indicates that the
// domain was not registered successfully, and you can safely delete the
// resource and retry registration.
RegisterDomain(context.Context, *RegisterDomainRequest) (*longrunningpb.Operation, error)
// Gets parameters needed to transfer a domain name from another registrar to
// Cloud Domains. For domains managed by Google Domains, transferring to Cloud
// Domains is not supported.
//
// Use the returned values to call `TransferDomain`.
RetrieveTransferParameters(context.Context, *RetrieveTransferParametersRequest) (*RetrieveTransferParametersResponse, error)
// Transfers a domain name from another registrar to Cloud Domains. For
// domains managed by Google Domains, transferring to Cloud Domains is not
// supported.
//
// Before calling this method, go to the domain's 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 this method.
//
// A successful call creates a `Registration` resource in state
// `TRANSFER_PENDING`. It can take several days to complete the transfer
// process. The registrant can often speed up this process by approving the
// transfer through the current registrar, either by clicking a link in an
// email from the registrar or by visiting the registrar's website.
//
// A few minutes after transfer approval, the resource transitions to state
// `ACTIVE`, indicating that the transfer was successful. If the transfer is
// rejected or the request expires without being approved, the resource can
// end up in state `TRANSFER_FAILED`. If transfer fails, you can safely delete
// the resource and retry the transfer.
TransferDomain(context.Context, *TransferDomainRequest) (*longrunningpb.Operation, error)
// Lists the `Registration` resources in a project.
ListRegistrations(context.Context, *ListRegistrationsRequest) (*ListRegistrationsResponse, error)
// Gets the details of a `Registration` resource.
GetRegistration(context.Context, *GetRegistrationRequest) (*Registration, error)
// Updates select fields of a `Registration` resource, notably `labels`. To
// update other fields, use the appropriate custom update method:
//
// * To update management settings, see `ConfigureManagementSettings`
// * To update DNS configuration, see `ConfigureDnsSettings`
// * To update contact information, see `ConfigureContactSettings`
UpdateRegistration(context.Context, *UpdateRegistrationRequest) (*longrunningpb.Operation, error)
// Updates a `Registration`'s management settings.
ConfigureManagementSettings(context.Context, *ConfigureManagementSettingsRequest) (*longrunningpb.Operation, error)
// Updates a `Registration`'s DNS settings.
ConfigureDnsSettings(context.Context, *ConfigureDnsSettingsRequest) (*longrunningpb.Operation, error)
// Updates a `Registration`'s contact settings. Some changes require
// confirmation by the domain's registrant contact .
ConfigureContactSettings(context.Context, *ConfigureContactSettingsRequest) (*longrunningpb.Operation, error)
// Exports a `Registration` resource, such that it is no longer managed by
// Cloud Domains.
//
// When an active domain is successfully exported, you can continue to use the
// domain in [Google Domains](https://domains.google/) until it expires. The
// calling user becomes the domain's sole owner in Google Domains, and
// permissions for the domain are subsequently managed there. The domain does
// not renew automatically unless the new owner sets up billing in Google
// Domains.
ExportRegistration(context.Context, *ExportRegistrationRequest) (*longrunningpb.Operation, error)
// Deletes a `Registration` resource.
//
// This method works on any `Registration` resource using [Subscription or
// Commitment billing](https://cloud.google.com/domains/pricing#billing-models), provided that the
// resource was created at least 1 day in the past.
//
// For `Registration` resources using
// [Monthly billing](https://cloud.google.com/domains/pricing#billing-models), this method works if:
//
// * `state` is `EXPORTED` with `expire_time` in the past
// * `state` is `REGISTRATION_FAILED`
// * `state` is `TRANSFER_FAILED`
//
// When an active registration is successfully deleted, you can continue to
// use the domain in [Google Domains](https://domains.google/) until it
// expires. The calling user becomes the domain's sole owner in Google
// Domains, and permissions for the domain are subsequently managed there. The
// domain does not renew automatically unless the new owner sets up billing in
// Google Domains.
DeleteRegistration(context.Context, *DeleteRegistrationRequest) (*longrunningpb.Operation, error)
// Gets the authorization code of the `Registration` for the purpose of
// transferring the domain to another registrar.
//
// You can call this method only after 60 days have elapsed since the initial
// domain registration.
RetrieveAuthorizationCode(context.Context, *RetrieveAuthorizationCodeRequest) (*AuthorizationCode, error)
// Resets the authorization code of the `Registration` to a new random string.
//
// You can call this method only after 60 days have elapsed since the initial
// domain registration.
ResetAuthorizationCode(context.Context, *ResetAuthorizationCodeRequest) (*AuthorizationCode, error)
}DomainsServer is the server API for Domains service. All implementations should embed UnimplementedDomainsServer for forward compatibility
ExportRegistrationRequest
type ExportRegistrationRequest struct {
// Required. The name of the `Registration` to export,
// in the format `projects/*/locations/*/registrations/*`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request for the ExportRegistration method.
func (*ExportRegistrationRequest) Descriptor
func (*ExportRegistrationRequest) Descriptor() ([]byte, []int)Deprecated: Use ExportRegistrationRequest.ProtoReflect.Descriptor instead.
func (*ExportRegistrationRequest) GetName
func (x *ExportRegistrationRequest) GetName() stringfunc (*ExportRegistrationRequest) ProtoMessage
func (*ExportRegistrationRequest) ProtoMessage()func (*ExportRegistrationRequest) ProtoReflect
func (x *ExportRegistrationRequest) ProtoReflect() protoreflect.Messagefunc (*ExportRegistrationRequest) Reset
func (x *ExportRegistrationRequest) Reset()func (*ExportRegistrationRequest) String
func (x *ExportRegistrationRequest) String() stringGetRegistrationRequest
type GetRegistrationRequest struct {
// Required. The name of the `Registration` to get, in the format
// `projects/*/locations/*/registrations/*`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request for the GetRegistration method.
func (*GetRegistrationRequest) Descriptor
func (*GetRegistrationRequest) Descriptor() ([]byte, []int)Deprecated: Use GetRegistrationRequest.ProtoReflect.Descriptor instead.
func (*GetRegistrationRequest) GetName
func (x *GetRegistrationRequest) GetName() stringfunc (*GetRegistrationRequest) ProtoMessage
func (*GetRegistrationRequest) ProtoMessage()func (*GetRegistrationRequest) ProtoReflect
func (x *GetRegistrationRequest) ProtoReflect() protoreflect.Messagefunc (*GetRegistrationRequest) Reset
func (x *GetRegistrationRequest) Reset()func (*GetRegistrationRequest) String
func (x *GetRegistrationRequest) String() stringListRegistrationsRequest
type ListRegistrationsRequest struct {
// Required. The project and location from which to list `Registration`s, specified in
// the format `projects/*/locations/*`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Maximum number of results to return.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// When set to the `next_page_token` from a prior response, provides the next
// page of results.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Filter expression to restrict the `Registration`s returned.
//
// The expression must specify the field name, a comparison operator, and the
// value that you want to use for filtering. The value must be a string, a
// number, a boolean, or an enum value. The comparison operator should be one
// of =, !=, >, <,>=, <=, or="" :="" for="" prefix="" or="" wildcard="" matches.="" for="" example,="" to="" filter="" to="" a="" specific="" domain="" name,="" use="" an="" expression="" like="" `domainname="example.com" `.="" you="" can="" also="" check="" for="" the="" existence="" of="" a="" field;="" for="" example,="" to="" find="" domains="" using="" custom="" dns="" settings,="" use="" an="" expression="" like="" `dnssettings.customdns:*`.="" you="" can="" also="" create="" compound="" filters="" by="" combining="" expressions="" with="" the="" `and`="" and="" `or`="" operators.="" for="" example,="" to="" find="" domains="" that="" are="" suspended="" or="" have="" specific="" issues="" flagged,="" use="" an="" expression="" like="" `(state="SUSPENDED)" or="" (issue:*)`.="" filter="">string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// contains filtered or unexported fields
}Request for the ListRegistrations method.
func (*ListRegistrationsRequest) Descriptor
func (*ListRegistrationsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListRegistrationsRequest.ProtoReflect.Descriptor instead.
func (*ListRegistrationsRequest) GetFilter
func (x *ListRegistrationsRequest) GetFilter() stringfunc (*ListRegistrationsRequest) GetPageSize
func (x *ListRegistrationsRequest) GetPageSize() int32func (*ListRegistrationsRequest) GetPageToken
func (x *ListRegistrationsRequest) GetPageToken() stringfunc (*ListRegistrationsRequest) GetParent
func (x *ListRegistrationsRequest) GetParent() stringfunc (*ListRegistrationsRequest) ProtoMessage
func (*ListRegistrationsRequest) ProtoMessage()func (*ListRegistrationsRequest) ProtoReflect
func (x *ListRegistrationsRequest) ProtoReflect() protoreflect.Messagefunc (*ListRegistrationsRequest) Reset
func (x *ListRegistrationsRequest) Reset()func (*ListRegistrationsRequest) String
func (x *ListRegistrationsRequest) String() stringListRegistrationsResponse
type ListRegistrationsResponse struct {
// A list of `Registration`s.
Registrations []*Registration `protobuf:"bytes,1,rep,name=registrations,proto3" json:"registrations,omitempty"`
// When present, there are more results to retrieve. Set `page_token` to this
// value on a subsequent call to get the next page of results.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}Response for the ListRegistrations method.
func (*ListRegistrationsResponse) Descriptor
func (*ListRegistrationsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListRegistrationsResponse.ProtoReflect.Descriptor instead.
func (*ListRegistrationsResponse) GetNextPageToken
func (x *ListRegistrationsResponse) GetNextPageToken() stringfunc (*ListRegistrationsResponse) GetRegistrations
func (x *ListRegistrationsResponse) GetRegistrations() []*Registrationfunc (*ListRegistrationsResponse) ProtoMessage
func (*ListRegistrationsResponse) ProtoMessage()func (*ListRegistrationsResponse) ProtoReflect
func (x *ListRegistrationsResponse) ProtoReflect() protoreflect.Messagefunc (*ListRegistrationsResponse) Reset
func (x *ListRegistrationsResponse) Reset()func (*ListRegistrationsResponse) String
func (x *ListRegistrationsResponse) String() stringManagementSettings
type ManagementSettings struct {
// Output only. The renewal method for this `Registration`.
RenewalMethod ManagementSettings_RenewalMethod `protobuf:"varint,3,opt,name=renewal_method,json=renewalMethod,proto3,enum=google.cloud.domains.v1beta1.ManagementSettings_RenewalMethod" json:"renewal_method,omitempty"`
// Controls whether the domain can be transferred to another registrar.
TransferLockState TransferLockState `protobuf:"varint,4,opt,name=transfer_lock_state,json=transferLockState,proto3,enum=google.cloud.domains.v1beta1.TransferLockState" json:"transfer_lock_state,omitempty"`
// contains filtered or unexported fields
}Defines renewal, billing, and transfer settings for a Registration.
func (*ManagementSettings) Descriptor
func (*ManagementSettings) Descriptor() ([]byte, []int)Deprecated: Use ManagementSettings.ProtoReflect.Descriptor instead.
func (*ManagementSettings) GetRenewalMethod
func (x *ManagementSettings) GetRenewalMethod() ManagementSettings_RenewalMethodfunc (*ManagementSettings) GetTransferLockState
func (x *ManagementSettings) GetTransferLockState() TransferLockStatefunc (*ManagementSettings) ProtoMessage
func (*ManagementSettings) ProtoMessage()func (*ManagementSettings) ProtoReflect
func (x *ManagementSettings) ProtoReflect() protoreflect.Messagefunc (*ManagementSettings) Reset
func (x *ManagementSettings) Reset()func (*ManagementSettings) String
func (x *ManagementSettings) String() stringManagementSettings_RenewalMethod
type ManagementSettings_RenewalMethod int32Defines how the Registration is renewed.
ManagementSettings_RENEWAL_METHOD_UNSPECIFIED, ManagementSettings_AUTOMATIC_RENEWAL, ManagementSettings_MANUAL_RENEWAL
const (
// The renewal method is undefined.
ManagementSettings_RENEWAL_METHOD_UNSPECIFIED ManagementSettings_RenewalMethod = 0
// The domain is automatically renewed each year .
//
// To disable automatic renewals, delete the resource by calling
// `DeleteRegistration` or export it by calling `ExportRegistration`.
ManagementSettings_AUTOMATIC_RENEWAL ManagementSettings_RenewalMethod = 1
// The domain must be explicitly renewed each year before its
// `expire_time`. This option is only available when the `Registration`
// is in state `EXPORTED`.
//
// To manage the domain's current billing and
// renewal settings, go to [Google Domains](https://domains.google/).
ManagementSettings_MANUAL_RENEWAL ManagementSettings_RenewalMethod = 2
)func (ManagementSettings_RenewalMethod) Descriptor
func (ManagementSettings_RenewalMethod) Descriptor() protoreflect.EnumDescriptorfunc (ManagementSettings_RenewalMethod) Enum
func (x ManagementSettings_RenewalMethod) Enum() *ManagementSettings_RenewalMethodfunc (ManagementSettings_RenewalMethod) EnumDescriptor
func (ManagementSettings_RenewalMethod) EnumDescriptor() ([]byte, []int)Deprecated: Use ManagementSettings_RenewalMethod.Descriptor instead.
func (ManagementSettings_RenewalMethod) Number
func (x ManagementSettings_RenewalMethod) Number() protoreflect.EnumNumberfunc (ManagementSettings_RenewalMethod) String
func (x ManagementSettings_RenewalMethod) String() stringfunc (ManagementSettings_RenewalMethod) Type
func (ManagementSettings_RenewalMethod) Type() protoreflect.EnumTypeOperationMetadata
type OperationMetadata struct {
// The time the operation was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// The time the operation finished running.
EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// Server-defined resource path for the target of the operation.
Target string `protobuf:"bytes,3,opt,name=target,proto3" json:"target,omitempty"`
// Name of the verb executed by the operation.
Verb string `protobuf:"bytes,4,opt,name=verb,proto3" json:"verb,omitempty"`
// Human-readable status of the operation, if any.
StatusDetail string `protobuf:"bytes,5,opt,name=status_detail,json=statusDetail,proto3" json:"status_detail,omitempty"`
// API version used to start the operation.
ApiVersion string `protobuf:"bytes,6,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
// contains filtered or unexported fields
}Represents the metadata of the long-running operation. Output only.
func (*OperationMetadata) Descriptor
func (*OperationMetadata) Descriptor() ([]byte, []int)Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.
func (*OperationMetadata) GetApiVersion
func (x *OperationMetadata) GetApiVersion() stringfunc (*OperationMetadata) GetCreateTime
func (x *OperationMetadata) GetCreateTime() *timestamppb.Timestampfunc (*OperationMetadata) GetEndTime
func (x *OperationMetadata) GetEndTime() *timestamppb.Timestampfunc (*OperationMetadata) GetStatusDetail
func (x *OperationMetadata) GetStatusDetail() stringfunc (*OperationMetadata) GetTarget
func (x *OperationMetadata) GetTarget() stringfunc (*OperationMetadata) GetVerb
func (x *OperationMetadata) GetVerb() stringfunc (*OperationMetadata) ProtoMessage
func (*OperationMetadata) ProtoMessage()func (*OperationMetadata) ProtoReflect
func (x *OperationMetadata) ProtoReflect() protoreflect.Messagefunc (*OperationMetadata) Reset
func (x *OperationMetadata) Reset()func (*OperationMetadata) String
func (x *OperationMetadata) String() stringRegisterDomainRequest
type RegisterDomainRequest struct {
// Required. The parent resource of the `Registration`. Must be in the
// format `projects/*/locations/*`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The complete `Registration` resource to be created.
Registration *Registration `protobuf:"bytes,2,opt,name=registration,proto3" json:"registration,omitempty"`
// The list of domain notices that you acknowledge. Call
// `RetrieveRegisterParameters` to see the notices that need acknowledgement.
DomainNotices []DomainNotice `protobuf:"varint,3,rep,packed,name=domain_notices,json=domainNotices,proto3,enum=google.cloud.domains.v1beta1.DomainNotice" json:"domain_notices,omitempty"`
// The list of contact notices that the caller acknowledges. The notices
// needed here depend on the values specified in
// `registration.contact_settings`.
ContactNotices []ContactNotice `protobuf:"varint,4,rep,packed,name=contact_notices,json=contactNotices,proto3,enum=google.cloud.domains.v1beta1.ContactNotice" json:"contact_notices,omitempty"`
// Required. Yearly price to register or renew the domain.
// The value that should be put here can be obtained from
// RetrieveRegisterParameters or SearchDomains calls.
YearlyPrice *money.Money `protobuf:"bytes,5,opt,name=yearly_price,json=yearlyPrice,proto3" json:"yearly_price,omitempty"`
// When true, only validation is performed, without actually registering
// the domain. Follows:
// https://cloud.google.com/apis/design/design_patterns#request_validation
ValidateOnly bool `protobuf:"varint,6,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// contains filtered or unexported fields
}Request for the RegisterDomain method.
func (*RegisterDomainRequest) Descriptor
func (*RegisterDomainRequest) Descriptor() ([]byte, []int)Deprecated: Use RegisterDomainRequest.ProtoReflect.Descriptor instead.
func (*RegisterDomainRequest) GetContactNotices
func (x *RegisterDomainRequest) GetContactNotices() []ContactNoticefunc (*RegisterDomainRequest) GetDomainNotices
func (x *RegisterDomainRequest) GetDomainNotices() []DomainNoticefunc (*RegisterDomainRequest) GetParent
func (x *RegisterDomainRequest) GetParent() stringfunc (*RegisterDomainRequest) GetRegistration
func (x *RegisterDomainRequest) GetRegistration() *Registrationfunc (*RegisterDomainRequest) GetValidateOnly
func (x *RegisterDomainRequest) GetValidateOnly() boolfunc (*RegisterDomainRequest) GetYearlyPrice
func (x *RegisterDomainRequest) GetYearlyPrice() *money.Moneyfunc (*RegisterDomainRequest) ProtoMessage
func (*RegisterDomainRequest) ProtoMessage()func (*RegisterDomainRequest) ProtoReflect
func (x *RegisterDomainRequest) ProtoReflect() protoreflect.Messagefunc (*RegisterDomainRequest) Reset
func (x *RegisterDomainRequest) Reset()func (*RegisterDomainRequest) String
func (x *RegisterDomainRequest) String() stringRegisterParameters
type RegisterParameters struct {
// The domain name. Unicode domain names are expressed in Punycode format.
DomainName string `protobuf:"bytes,1,opt,name=domain_name,json=domainName,proto3" json:"domain_name,omitempty"`
// Indicates whether the domain is available for registration. This value is
// accurate when obtained by calling `RetrieveRegisterParameters`, but is
// approximate when obtained by calling `SearchDomains`.
Availability RegisterParameters_Availability `protobuf:"varint,2,opt,name=availability,proto3,enum=google.cloud.domains.v1beta1.RegisterParameters_Availability" json:"availability,omitempty"`
// Contact privacy options that the domain supports.
SupportedPrivacy []ContactPrivacy `protobuf:"varint,3,rep,packed,name=supported_privacy,json=supportedPrivacy,proto3,enum=google.cloud.domains.v1beta1.ContactPrivacy" json:"supported_privacy,omitempty"`
// Notices about special properties of the domain.
DomainNotices []DomainNotice `protobuf:"varint,4,rep,packed,name=domain_notices,json=domainNotices,proto3,enum=google.cloud.domains.v1beta1.DomainNotice" json:"domain_notices,omitempty"`
// Price to register or renew the domain for one year.
YearlyPrice *money.Money `protobuf:"bytes,5,opt,name=yearly_price,json=yearlyPrice,proto3" json:"yearly_price,omitempty"`
// contains filtered or unexported fields
}Parameters required to register a new domain.
func (*RegisterParameters) Descriptor
func (*RegisterParameters) Descriptor() ([]byte, []int)Deprecated: Use RegisterParameters.ProtoReflect.Descriptor instead.
func (*RegisterParameters) GetAvailability
func (x *RegisterParameters) GetAvailability() RegisterParameters_Availabilityfunc (*RegisterParameters) GetDomainName
func (x *RegisterParameters) GetDomainName() stringfunc (*RegisterParameters) GetDomainNotices
func (x *RegisterParameters) GetDomainNotices() []DomainNoticefunc (*RegisterParameters) GetSupportedPrivacy
func (x *RegisterParameters) GetSupportedPrivacy() []ContactPrivacyfunc (*RegisterParameters) GetYearlyPrice
func (x *RegisterParameters) GetYearlyPrice() *money.Moneyfunc (*RegisterParameters) ProtoMessage
func (*RegisterParameters) ProtoMessage()func (*RegisterParameters) ProtoReflect
func (x *RegisterParameters) ProtoReflect() protoreflect.Messagefunc (*RegisterParameters) Reset
func (x *RegisterParameters) Reset()func (*RegisterParameters) String
func (x *RegisterParameters) String() stringRegisterParameters_Availability
type RegisterParameters_Availability int32Possible availability states of a domain name.
RegisterParameters_AVAILABILITY_UNSPECIFIED, RegisterParameters_AVAILABLE, RegisterParameters_UNAVAILABLE, RegisterParameters_UNSUPPORTED, RegisterParameters_UNKNOWN
const (
// The availability is unspecified.
RegisterParameters_AVAILABILITY_UNSPECIFIED RegisterParameters_Availability = 0
// The domain is available for registration.
RegisterParameters_AVAILABLE RegisterParameters_Availability = 1
// The domain is not available for registration. Generally this means it is
// already registered to another party.
RegisterParameters_UNAVAILABLE RegisterParameters_Availability = 2
// The domain is not currently supported by Cloud Domains, but may
// be available elsewhere.
RegisterParameters_UNSUPPORTED RegisterParameters_Availability = 3
// Cloud Domains is unable to determine domain availability, generally
// due to system maintenance at the domain name registry.
RegisterParameters_UNKNOWN RegisterParameters_Availability = 4
)func (RegisterParameters_Availability) Descriptor
func (RegisterParameters_Availability) Descriptor() protoreflect.EnumDescriptorfunc (RegisterParameters_Availability) Enum
func (x RegisterParameters_Availability) Enum() *RegisterParameters_Availabilityfunc (RegisterParameters_Availability) EnumDescriptor
func (RegisterParameters_Availability) EnumDescriptor() ([]byte, []int)Deprecated: Use RegisterParameters_Availability.Descriptor instead.
func (RegisterParameters_Availability) Number
func (x RegisterParameters_Availability) Number() protoreflect.EnumNumberfunc (RegisterParameters_Availability) String
func (x RegisterParameters_Availability) String() stringfunc (RegisterParameters_Availability) Type
func (RegisterParameters_Availability) Type() protoreflect.EnumTypeRegistration
type Registration struct {
// Output only. Name of the `Registration` resource, in the format
// `projects/*/locations/*/registrations/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.
func (*Registration) Descriptor
func (*Registration) Descriptor() ([]byte, []int)Deprecated: Use Registration.ProtoReflect.Descriptor instead.
func (*Registration) GetContactSettings
func (x *Registration) GetContactSettings() *ContactSettingsfunc (*Registration) GetCreateTime
func (x *Registration) GetCreateTime() *timestamppb.Timestampfunc (*Registration) GetDnsSettings
func (x *Registration) GetDnsSettings() *DnsSettingsfunc (*Registration) GetDomainName
func (x *Registration) GetDomainName() stringfunc (*Registration) GetExpireTime
func (x *Registration) GetExpireTime() *timestamppb.Timestampfunc (*Registration) GetIssues
func (x *Registration) GetIssues() []Registration_Issuefunc (*Registration) GetLabels
func (x *Registration) GetLabels() map[string]stringfunc (*Registration) GetManagementSettings
func (x *Registration) GetManagementSettings() *ManagementSettingsfunc (*Registration) GetName
func (x *Registration) GetName() stringfunc (*Registration) GetPendingContactSettings
func (x *Registration) GetPendingContactSettings() *ContactSettingsfunc (*Registration) GetState
func (x *Registration) GetState() Registration_Statefunc (*Registration) GetSupportedPrivacy
func (x *Registration) GetSupportedPrivacy() []ContactPrivacyfunc (*Registration) ProtoMessage
func (*Registration) ProtoMessage()func (*Registration) ProtoReflect
func (x *Registration) ProtoReflect() protoreflect.Messagefunc (*Registration) Reset
func (x *Registration) Reset()func (*Registration) String
func (x *Registration) String() stringRegistration_Issue
type Registration_Issue int32Possible issues with a Registration that require attention.
Registration_ISSUE_UNSPECIFIED, Registration_CONTACT_SUPPORT, Registration_UNVERIFIED_EMAIL
const (
// The issue is undefined.
Registration_ISSUE_UNSPECIFIED Registration_Issue = 0
// Contact the Cloud Support team to resolve a problem with this domain.
Registration_CONTACT_SUPPORT Registration_Issue = 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`.
Registration_UNVERIFIED_EMAIL Registration_Issue = 2
)func (Registration_Issue) Descriptor
func (Registration_Issue) Descriptor() protoreflect.EnumDescriptorfunc (Registration_Issue) Enum
func (x Registration_Issue) Enum() *Registration_Issuefunc (Registration_Issue) EnumDescriptor
func (Registration_Issue) EnumDescriptor() ([]byte, []int)Deprecated: Use Registration_Issue.Descriptor instead.
func (Registration_Issue) Number
func (x Registration_Issue) Number() protoreflect.EnumNumberfunc (Registration_Issue) String
func (x Registration_Issue) String() stringfunc (Registration_Issue) Type
func (Registration_Issue) Type() protoreflect.EnumTypeRegistration_State
type Registration_State int32Possible states of a Registration.
Registration_STATE_UNSPECIFIED, Registration_REGISTRATION_PENDING, Registration_REGISTRATION_FAILED, Registration_TRANSFER_PENDING, Registration_TRANSFER_FAILED, Registration_ACTIVE, Registration_SUSPENDED, Registration_EXPORTED
const (
// The state is undefined.
Registration_STATE_UNSPECIFIED Registration_State = 0
// The domain is being registered.
Registration_REGISTRATION_PENDING Registration_State = 1
// The domain registration failed. You can delete resources in this state
// to allow registration to be retried.
Registration_REGISTRATION_FAILED Registration_State = 2
// The domain is being transferred from another registrar to Cloud Domains.
Registration_TRANSFER_PENDING Registration_State = 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.
Registration_TRANSFER_FAILED Registration_State = 4
// The domain is registered and operational. The domain renews automatically
// as long as it remains in this state.
Registration_ACTIVE Registration_State = 6
// The domain is suspended and inoperative. For more details, see the
// `issues` field.
Registration_SUSPENDED Registration_State = 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.
Registration_EXPORTED Registration_State = 8
)func (Registration_State) Descriptor
func (Registration_State) Descriptor() protoreflect.EnumDescriptorfunc (Registration_State) Enum
func (x Registration_State) Enum() *Registration_Statefunc (Registration_State) EnumDescriptor
func (Registration_State) EnumDescriptor() ([]byte, []int)Deprecated: Use Registration_State.Descriptor instead.
func (Registration_State) Number
func (x Registration_State) Number() protoreflect.EnumNumberfunc (Registration_State) String
func (x Registration_State) String() stringfunc (Registration_State) Type
func (Registration_State) Type() protoreflect.EnumTypeResetAuthorizationCodeRequest
type ResetAuthorizationCodeRequest struct {
// Required. The name of the `Registration` whose authorization code is being reset,
// in the format `projects/*/locations/*/registrations/*`.
Registration string `protobuf:"bytes,1,opt,name=registration,proto3" json:"registration,omitempty"`
// contains filtered or unexported fields
}Request for the ResetAuthorizationCode method.
func (*ResetAuthorizationCodeRequest) Descriptor
func (*ResetAuthorizationCodeRequest) Descriptor() ([]byte, []int)Deprecated: Use ResetAuthorizationCodeRequest.ProtoReflect.Descriptor instead.
func (*ResetAuthorizationCodeRequest) GetRegistration
func (x *ResetAuthorizationCodeRequest) GetRegistration() stringfunc (*ResetAuthorizationCodeRequest) ProtoMessage
func (*ResetAuthorizationCodeRequest) ProtoMessage()func (*ResetAuthorizationCodeRequest) ProtoReflect
func (x *ResetAuthorizationCodeRequest) ProtoReflect() protoreflect.Messagefunc (*ResetAuthorizationCodeRequest) Reset
func (x *ResetAuthorizationCodeRequest) Reset()func (*ResetAuthorizationCodeRequest) String
func (x *ResetAuthorizationCodeRequest) String() stringRetrieveAuthorizationCodeRequest
type RetrieveAuthorizationCodeRequest struct {
// Required. The name of the `Registration` whose authorization code is being retrieved,
// in the format `projects/*/locations/*/registrations/*`.
Registration string `protobuf:"bytes,1,opt,name=registration,proto3" json:"registration,omitempty"`
// contains filtered or unexported fields
}Request for the RetrieveAuthorizationCode method.
func (*RetrieveAuthorizationCodeRequest) Descriptor
func (*RetrieveAuthorizationCodeRequest) Descriptor() ([]byte, []int)Deprecated: Use RetrieveAuthorizationCodeRequest.ProtoReflect.Descriptor instead.
func (*RetrieveAuthorizationCodeRequest) GetRegistration
func (x *RetrieveAuthorizationCodeRequest) GetRegistration() stringfunc (*RetrieveAuthorizationCodeRequest) ProtoMessage
func (*RetrieveAuthorizationCodeRequest) ProtoMessage()func (*RetrieveAuthorizationCodeRequest) ProtoReflect
func (x *RetrieveAuthorizationCodeRequest) ProtoReflect() protoreflect.Messagefunc (*RetrieveAuthorizationCodeRequest) Reset
func (x *RetrieveAuthorizationCodeRequest) Reset()func (*RetrieveAuthorizationCodeRequest) String
func (x *RetrieveAuthorizationCodeRequest) String() stringRetrieveRegisterParametersRequest
type RetrieveRegisterParametersRequest struct {
// Required. The domain name. Unicode domain names must be expressed in Punycode format.
DomainName string `protobuf:"bytes,1,opt,name=domain_name,json=domainName,proto3" json:"domain_name,omitempty"`
// Required. The location. Must be in the format `projects/*/locations/*`.
Location string `protobuf:"bytes,2,opt,name=location,proto3" json:"location,omitempty"`
// contains filtered or unexported fields
}Request for the RetrieveRegisterParameters method.
func (*RetrieveRegisterParametersRequest) Descriptor
func (*RetrieveRegisterParametersRequest) Descriptor() ([]byte, []int)Deprecated: Use RetrieveRegisterParametersRequest.ProtoReflect.Descriptor instead.
func (*RetrieveRegisterParametersRequest) GetDomainName
func (x *RetrieveRegisterParametersRequest) GetDomainName() stringfunc (*RetrieveRegisterParametersRequest) GetLocation
func (x *RetrieveRegisterParametersRequest) GetLocation() stringfunc (*RetrieveRegisterParametersRequest) ProtoMessage
func (*RetrieveRegisterParametersRequest) ProtoMessage()func (*RetrieveRegisterParametersRequest) ProtoReflect
func (x *RetrieveRegisterParametersRequest) ProtoReflect() protoreflect.Messagefunc (*RetrieveRegisterParametersRequest) Reset
func (x *RetrieveRegisterParametersRequest) Reset()func (*RetrieveRegisterParametersRequest) String
func (x *RetrieveRegisterParametersRequest) String() stringRetrieveRegisterParametersResponse
type RetrieveRegisterParametersResponse struct {
// Parameters to use when calling the `RegisterDomain` method.
RegisterParameters *RegisterParameters `protobuf:"bytes,1,opt,name=register_parameters,json=registerParameters,proto3" json:"register_parameters,omitempty"`
// contains filtered or unexported fields
}Response for the RetrieveRegisterParameters method.
func (*RetrieveRegisterParametersResponse) Descriptor
func (*RetrieveRegisterParametersResponse) Descriptor() ([]byte, []int)Deprecated: Use RetrieveRegisterParametersResponse.ProtoReflect.Descriptor instead.
func (*RetrieveRegisterParametersResponse) GetRegisterParameters
func (x *RetrieveRegisterParametersResponse) GetRegisterParameters() *RegisterParametersfunc (*RetrieveRegisterParametersResponse) ProtoMessage
func (*RetrieveRegisterParametersResponse) ProtoMessage()func (*RetrieveRegisterParametersResponse) ProtoReflect
func (x *RetrieveRegisterParametersResponse) ProtoReflect() protoreflect.Messagefunc (*RetrieveRegisterParametersResponse) Reset
func (x *RetrieveRegisterParametersResponse) Reset()func (*RetrieveRegisterParametersResponse) String
func (x *RetrieveRegisterParametersResponse) String() stringRetrieveTransferParametersRequest
type RetrieveTransferParametersRequest struct {
// Required. The domain name. Unicode domain names must be expressed in Punycode format.
DomainName string `protobuf:"bytes,1,opt,name=domain_name,json=domainName,proto3" json:"domain_name,omitempty"`
// Required. The location. Must be in the format `projects/*/locations/*`.
Location string `protobuf:"bytes,2,opt,name=location,proto3" json:"location,omitempty"`
// contains filtered or unexported fields
}Request for the RetrieveTransferParameters method.
func (*RetrieveTransferParametersRequest) Descriptor
func (*RetrieveTransferParametersRequest) Descriptor() ([]byte, []int)Deprecated: Use RetrieveTransferParametersRequest.ProtoReflect.Descriptor instead.
func (*RetrieveTransferParametersRequest) GetDomainName
func (x *RetrieveTransferParametersRequest) GetDomainName() stringfunc (*RetrieveTransferParametersRequest) GetLocation
func (x *RetrieveTransferParametersRequest) GetLocation() stringfunc (*RetrieveTransferParametersRequest) ProtoMessage
func (*RetrieveTransferParametersRequest) ProtoMessage()func (*RetrieveTransferParametersRequest) ProtoReflect
func (x *RetrieveTransferParametersRequest) ProtoReflect() protoreflect.Messagefunc (*RetrieveTransferParametersRequest) Reset
func (x *RetrieveTransferParametersRequest) Reset()func (*RetrieveTransferParametersRequest) String
func (x *RetrieveTransferParametersRequest) String() stringRetrieveTransferParametersResponse
type RetrieveTransferParametersResponse struct {
// Parameters to use when calling the `TransferDomain` method.
TransferParameters *TransferParameters `protobuf:"bytes,1,opt,name=transfer_parameters,json=transferParameters,proto3" json:"transfer_parameters,omitempty"`
// contains filtered or unexported fields
}Response for the RetrieveTransferParameters method.
func (*RetrieveTransferParametersResponse) Descriptor
func (*RetrieveTransferParametersResponse) Descriptor() ([]byte, []int)Deprecated: Use RetrieveTransferParametersResponse.ProtoReflect.Descriptor instead.
func (*RetrieveTransferParametersResponse) GetTransferParameters
func (x *RetrieveTransferParametersResponse) GetTransferParameters() *TransferParametersfunc (*RetrieveTransferParametersResponse) ProtoMessage
func (*RetrieveTransferParametersResponse) ProtoMessage()func (*RetrieveTransferParametersResponse) ProtoReflect
func (x *RetrieveTransferParametersResponse) ProtoReflect() protoreflect.Messagefunc (*RetrieveTransferParametersResponse) Reset
func (x *RetrieveTransferParametersResponse) Reset()func (*RetrieveTransferParametersResponse) String
func (x *RetrieveTransferParametersResponse) String() stringSearchDomainsRequest
type SearchDomainsRequest struct {
// Required. String used to search for available domain names.
Query string `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
// Required. The location. Must be in the format `projects/*/locations/*`.
Location string `protobuf:"bytes,2,opt,name=location,proto3" json:"location,omitempty"`
// contains filtered or unexported fields
}Request for the SearchDomains method.
func (*SearchDomainsRequest) Descriptor
func (*SearchDomainsRequest) Descriptor() ([]byte, []int)Deprecated: Use SearchDomainsRequest.ProtoReflect.Descriptor instead.
func (*SearchDomainsRequest) GetLocation
func (x *SearchDomainsRequest) GetLocation() stringfunc (*SearchDomainsRequest) GetQuery
func (x *SearchDomainsRequest) GetQuery() stringfunc (*SearchDomainsRequest) ProtoMessage
func (*SearchDomainsRequest) ProtoMessage()func (*SearchDomainsRequest) ProtoReflect
func (x *SearchDomainsRequest) ProtoReflect() protoreflect.Messagefunc (*SearchDomainsRequest) Reset
func (x *SearchDomainsRequest) Reset()func (*SearchDomainsRequest) String
func (x *SearchDomainsRequest) String() stringSearchDomainsResponse
type SearchDomainsResponse struct {
// Results of the domain name search.
RegisterParameters []*RegisterParameters `protobuf:"bytes,1,rep,name=register_parameters,json=registerParameters,proto3" json:"register_parameters,omitempty"`
// contains filtered or unexported fields
}Response for the SearchDomains method.
func (*SearchDomainsResponse) Descriptor
func (*SearchDomainsResponse) Descriptor() ([]byte, []int)Deprecated: Use SearchDomainsResponse.ProtoReflect.Descriptor instead.
func (*SearchDomainsResponse) GetRegisterParameters
func (x *SearchDomainsResponse) GetRegisterParameters() []*RegisterParametersfunc (*SearchDomainsResponse) ProtoMessage
func (*SearchDomainsResponse) ProtoMessage()func (*SearchDomainsResponse) ProtoReflect
func (x *SearchDomainsResponse) ProtoReflect() protoreflect.Messagefunc (*SearchDomainsResponse) Reset
func (x *SearchDomainsResponse) Reset()func (*SearchDomainsResponse) String
func (x *SearchDomainsResponse) String() stringTransferDomainRequest
type TransferDomainRequest struct {
// Required. The parent resource of the `Registration`. Must be in the
// format `projects/*/locations/*`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The complete `Registration` resource to be created.
//
// You can leave `registration.dns_settings` unset to import the
// domain's current DNS configuration from its current registrar. Use this
// option only if you are sure that the domain's current DNS service
// does not cease upon transfer, as is often the case for DNS services
// provided for free by the registrar.
Registration *Registration `protobuf:"bytes,2,opt,name=registration,proto3" json:"registration,omitempty"`
// The list of contact notices that you acknowledge. The notices
// needed here depend on the values specified in
// `registration.contact_settings`.
ContactNotices []ContactNotice `protobuf:"varint,3,rep,packed,name=contact_notices,json=contactNotices,proto3,enum=google.cloud.domains.v1beta1.ContactNotice" json:"contact_notices,omitempty"`
// Required. Acknowledgement of the price to transfer or renew the domain for one year.
// Call `RetrieveTransferParameters` to obtain the price, which you must
// acknowledge.
YearlyPrice *money.Money `protobuf:"bytes,4,opt,name=yearly_price,json=yearlyPrice,proto3" json:"yearly_price,omitempty"`
// The domain's transfer authorization code. You can obtain this from the
// domain's current registrar.
AuthorizationCode *AuthorizationCode `protobuf:"bytes,5,opt,name=authorization_code,json=authorizationCode,proto3" json:"authorization_code,omitempty"`
// Validate the request without actually transferring the domain.
ValidateOnly bool `protobuf:"varint,6,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// contains filtered or unexported fields
}Request for the TransferDomain method.
func (*TransferDomainRequest) Descriptor
func (*TransferDomainRequest) Descriptor() ([]byte, []int)Deprecated: Use TransferDomainRequest.ProtoReflect.Descriptor instead.
func (*TransferDomainRequest) GetAuthorizationCode
func (x *TransferDomainRequest) GetAuthorizationCode() *AuthorizationCodefunc (*TransferDomainRequest) GetContactNotices
func (x *TransferDomainRequest) GetContactNotices() []ContactNoticefunc (*TransferDomainRequest) GetParent
func (x *TransferDomainRequest) GetParent() stringfunc (*TransferDomainRequest) GetRegistration
func (x *TransferDomainRequest) GetRegistration() *Registrationfunc (*TransferDomainRequest) GetValidateOnly
func (x *TransferDomainRequest) GetValidateOnly() boolfunc (*TransferDomainRequest) GetYearlyPrice
func (x *TransferDomainRequest) GetYearlyPrice() *money.Moneyfunc (*TransferDomainRequest) ProtoMessage
func (*TransferDomainRequest) ProtoMessage()func (*TransferDomainRequest) ProtoReflect
func (x *TransferDomainRequest) ProtoReflect() protoreflect.Messagefunc (*TransferDomainRequest) Reset
func (x *TransferDomainRequest) Reset()func (*TransferDomainRequest) String
func (x *TransferDomainRequest) String() stringTransferLockState
type TransferLockState int32Possible states of a Registration's transfer lock.
TransferLockState_TRANSFER_LOCK_STATE_UNSPECIFIED, TransferLockState_UNLOCKED, TransferLockState_LOCKED
const (
// The state is unspecified.
TransferLockState_TRANSFER_LOCK_STATE_UNSPECIFIED TransferLockState = 0
// The domain is unlocked and can be transferred to another registrar.
TransferLockState_UNLOCKED TransferLockState = 1
// The domain is locked and cannot be transferred to another registrar.
TransferLockState_LOCKED TransferLockState = 2
)func (TransferLockState) Descriptor
func (TransferLockState) Descriptor() protoreflect.EnumDescriptorfunc (TransferLockState) Enum
func (x TransferLockState) Enum() *TransferLockStatefunc (TransferLockState) EnumDescriptor
func (TransferLockState) EnumDescriptor() ([]byte, []int)Deprecated: Use TransferLockState.Descriptor instead.
func (TransferLockState) Number
func (x TransferLockState) Number() protoreflect.EnumNumberfunc (TransferLockState) String
func (x TransferLockState) String() stringfunc (TransferLockState) Type
func (TransferLockState) Type() protoreflect.EnumTypeTransferParameters
type TransferParameters struct {
// The domain name. Unicode domain names are expressed in Punycode format.
DomainName string `protobuf:"bytes,1,opt,name=domain_name,json=domainName,proto3" json:"domain_name,omitempty"`
// The registrar that currently manages the domain.
CurrentRegistrar string `protobuf:"bytes,2,opt,name=current_registrar,json=currentRegistrar,proto3" json:"current_registrar,omitempty"`
// The name servers that currently store the configuration of the domain.
NameServers []string `protobuf:"bytes,3,rep,name=name_servers,json=nameServers,proto3" json:"name_servers,omitempty"`
// Indicates whether the domain is protected by a transfer lock. For a
// transfer to succeed, this must show `UNLOCKED`. To unlock a domain,
// go to its current registrar.
TransferLockState TransferLockState `protobuf:"varint,4,opt,name=transfer_lock_state,json=transferLockState,proto3,enum=google.cloud.domains.v1beta1.TransferLockState" json:"transfer_lock_state,omitempty"`
// Contact privacy options that the domain supports.
SupportedPrivacy []ContactPrivacy `protobuf:"varint,5,rep,packed,name=supported_privacy,json=supportedPrivacy,proto3,enum=google.cloud.domains.v1beta1.ContactPrivacy" json:"supported_privacy,omitempty"`
// Price to transfer or renew the domain for one year.
YearlyPrice *money.Money `protobuf:"bytes,6,opt,name=yearly_price,json=yearlyPrice,proto3" json:"yearly_price,omitempty"`
// contains filtered or unexported fields
}Parameters required to transfer a domain from another registrar.
func (*TransferParameters) Descriptor
func (*TransferParameters) Descriptor() ([]byte, []int)Deprecated: Use TransferParameters.ProtoReflect.Descriptor instead.
func (*TransferParameters) GetCurrentRegistrar
func (x *TransferParameters) GetCurrentRegistrar() stringfunc (*TransferParameters) GetDomainName
func (x *TransferParameters) GetDomainName() stringfunc (*TransferParameters) GetNameServers
func (x *TransferParameters) GetNameServers() []stringfunc (*TransferParameters) GetSupportedPrivacy
func (x *TransferParameters) GetSupportedPrivacy() []ContactPrivacyfunc (*TransferParameters) GetTransferLockState
func (x *TransferParameters) GetTransferLockState() TransferLockStatefunc (*TransferParameters) GetYearlyPrice
func (x *TransferParameters) GetYearlyPrice() *money.Moneyfunc (*TransferParameters) ProtoMessage
func (*TransferParameters) ProtoMessage()func (*TransferParameters) ProtoReflect
func (x *TransferParameters) ProtoReflect() protoreflect.Messagefunc (*TransferParameters) Reset
func (x *TransferParameters) Reset()func (*TransferParameters) String
func (x *TransferParameters) String() stringUnimplementedDomainsServer
type UnimplementedDomainsServer struct {
}UnimplementedDomainsServer should be embedded to have forward compatible implementations.
func (UnimplementedDomainsServer) ConfigureContactSettings
func (UnimplementedDomainsServer) ConfigureContactSettings(context.Context, *ConfigureContactSettingsRequest) (*longrunningpb.Operation, error)func (UnimplementedDomainsServer) ConfigureDnsSettings
func (UnimplementedDomainsServer) ConfigureDnsSettings(context.Context, *ConfigureDnsSettingsRequest) (*longrunningpb.Operation, error)func (UnimplementedDomainsServer) ConfigureManagementSettings
func (UnimplementedDomainsServer) ConfigureManagementSettings(context.Context, *ConfigureManagementSettingsRequest) (*longrunningpb.Operation, error)func (UnimplementedDomainsServer) DeleteRegistration
func (UnimplementedDomainsServer) DeleteRegistration(context.Context, *DeleteRegistrationRequest) (*longrunningpb.Operation, error)func (UnimplementedDomainsServer) ExportRegistration
func (UnimplementedDomainsServer) ExportRegistration(context.Context, *ExportRegistrationRequest) (*longrunningpb.Operation, error)func (UnimplementedDomainsServer) GetRegistration
func (UnimplementedDomainsServer) GetRegistration(context.Context, *GetRegistrationRequest) (*Registration, error)func (UnimplementedDomainsServer) ListRegistrations
func (UnimplementedDomainsServer) ListRegistrations(context.Context, *ListRegistrationsRequest) (*ListRegistrationsResponse, error)func (UnimplementedDomainsServer) RegisterDomain
func (UnimplementedDomainsServer) RegisterDomain(context.Context, *RegisterDomainRequest) (*longrunningpb.Operation, error)func (UnimplementedDomainsServer) ResetAuthorizationCode
func (UnimplementedDomainsServer) ResetAuthorizationCode(context.Context, *ResetAuthorizationCodeRequest) (*AuthorizationCode, error)func (UnimplementedDomainsServer) RetrieveAuthorizationCode
func (UnimplementedDomainsServer) RetrieveAuthorizationCode(context.Context, *RetrieveAuthorizationCodeRequest) (*AuthorizationCode, error)func (UnimplementedDomainsServer) RetrieveRegisterParameters
func (UnimplementedDomainsServer) RetrieveRegisterParameters(context.Context, *RetrieveRegisterParametersRequest) (*RetrieveRegisterParametersResponse, error)func (UnimplementedDomainsServer) RetrieveTransferParameters
func (UnimplementedDomainsServer) RetrieveTransferParameters(context.Context, *RetrieveTransferParametersRequest) (*RetrieveTransferParametersResponse, error)func (UnimplementedDomainsServer) SearchDomains
func (UnimplementedDomainsServer) SearchDomains(context.Context, *SearchDomainsRequest) (*SearchDomainsResponse, error)func (UnimplementedDomainsServer) TransferDomain
func (UnimplementedDomainsServer) TransferDomain(context.Context, *TransferDomainRequest) (*longrunningpb.Operation, error)func (UnimplementedDomainsServer) UpdateRegistration
func (UnimplementedDomainsServer) UpdateRegistration(context.Context, *UpdateRegistrationRequest) (*longrunningpb.Operation, error)UnsafeDomainsServer
type UnsafeDomainsServer interface {
// contains filtered or unexported methods
}UnsafeDomainsServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DomainsServer will result in compilation errors.
UpdateRegistrationRequest
type UpdateRegistrationRequest struct {
// Fields of the `Registration` to update.
Registration *Registration `protobuf:"bytes,1,opt,name=registration,proto3" json:"registration,omitempty"`
// Required. The field mask describing which fields to update as a comma-separated list.
// For example, if only the labels are being updated, the `update_mask` is
// `"labels"`.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}Request for the UpdateRegistration method.
func (*UpdateRegistrationRequest) Descriptor
func (*UpdateRegistrationRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateRegistrationRequest.ProtoReflect.Descriptor instead.
func (*UpdateRegistrationRequest) GetRegistration
func (x *UpdateRegistrationRequest) GetRegistration() *Registrationfunc (*UpdateRegistrationRequest) GetUpdateMask
func (x *UpdateRegistrationRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateRegistrationRequest) ProtoMessage
func (*UpdateRegistrationRequest) ProtoMessage()func (*UpdateRegistrationRequest) ProtoReflect
func (x *UpdateRegistrationRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateRegistrationRequest) Reset
func (x *UpdateRegistrationRequest) Reset()func (*UpdateRegistrationRequest) String
func (x *UpdateRegistrationRequest) String() string