Console
    Contact Us Start free

    Google Cloud Domains V1 Client - Class Registration (0.4.2)

    Reference documentation and code samples for the Google Cloud Domains V1 Client class Registration.

    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 .

    Generated from protobuf message google.cloud.domains.v1.Registration

    Namespace

    Google \ Cloud \ Domains \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

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

    ↳ domain_name
    string

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

    ↳ create_time
    Google\Protobuf\Timestamp

    Output only. The creation timestamp of the Registration resource.

    ↳ expire_time
    Google\Protobuf\Timestamp

    Output only. The expiration timestamp of the Registration .

    ↳ state
    int

    Output only. The state of the Registration

    ↳ issues
    array

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

    ↳ labels
    array| Google\Protobuf\Internal\MapField

    Set of labels associated with the Registration .

    ↳ management_settings
    Google\Cloud\Domains\V1\ManagementSettings

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

    ↳ dns_settings
    Google\Cloud\Domains\V1\DnsSettings

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

    ↳ contact_settings
    Google\Cloud\Domains\V1\ContactSettings

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

    ↳ pending_contact_settings
    Google\Cloud\Domains\V1\ContactSettings

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

    ↳ supported_privacy
    array

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

    getName

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

    Returns
    Type
    Description
    string

    setName

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDomainName

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

    Returns
    Type
    Description
    string

    setDomainName

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. The creation timestamp of the Registration resource.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. The creation timestamp of the Registration resource.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getExpireTime

    Output only. The expiration timestamp of the Registration .

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasExpireTime

    clearExpireTime

    setExpireTime

    Output only. The expiration timestamp of the Registration .

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getState

    Output only. The state of the Registration

    Returns
    Type
    Description
    int

    setState

    Output only. The state of the Registration

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getIssues

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

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setIssues

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

    Parameter
    Name
    Description
    var
    int[]
    Returns
    Type
    Description
    $this

    getLabels

    Set of labels associated with the Registration .

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    setLabels

    Set of labels associated with the Registration .

    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this

    getManagementSettings

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

    Returns
    Type
    Description
    Google\Cloud\Domains\V1\ManagementSettings |null

    hasManagementSettings

    clearManagementSettings

    setManagementSettings

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

    Parameter
    Name
    Description
    var
    Google\Cloud\Domains\V1\ManagementSettings
    Returns
    Type
    Description
    $this

    getDnsSettings

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

    Returns
    Type
    Description
    Google\Cloud\Domains\V1\DnsSettings |null

    hasDnsSettings

    clearDnsSettings

    setDnsSettings

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

    Parameter
    Name
    Description
    var
    Google\Cloud\Domains\V1\DnsSettings
    Returns
    Type
    Description
    $this

    getContactSettings

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

    Returns
    Type
    Description
    Google\Cloud\Domains\V1\ContactSettings |null

    hasContactSettings

    clearContactSettings

    setContactSettings

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

    Parameter
    Name
    Description
    var
    Google\Cloud\Domains\V1\ContactSettings
    Returns
    Type
    Description
    $this

    getPendingContactSettings

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

    Returns
    Type
    Description
    Google\Cloud\Domains\V1\ContactSettings |null

    hasPendingContactSettings

    clearPendingContactSettings

    setPendingContactSettings

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

    Parameter
    Name
    Description
    var
    Google\Cloud\Domains\V1\ContactSettings
    Returns
    Type
    Description
    $this

    getSupportedPrivacy

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

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setSupportedPrivacy

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

    Parameter
    Name
    Description
    var
    int[]
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: