Google Cloud Domains V1alpha2 Client - Class RegisterParameters (0.5.5)

Reference documentation and code samples for the Google Cloud Domains V1alpha2 Client class RegisterParameters.

Parameters required to register a new domain.

Generated from protobuf message google.cloud.domains.v1alpha2.RegisterParameters

Namespace

Google \ Cloud \ Domains \ V1alpha2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ domain_name string

The domain name. Unicode domain names are expressed in Punycode format.

↳ availability int

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.

↳ supported_privacy array

Contact privacy options that the domain supports.

↳ domain_notices array

Notices about special properties of the domain.

↳ yearly_price Google\Type\Money

Price to register or renew the domain for one year.

getDomainName

The domain name. Unicode domain names are expressed in Punycode format.

Returns
Type Description
string

setDomainName

The domain name. Unicode domain names are expressed in Punycode format.

Parameter
Name Description
var string
Returns
Type Description
$this

getAvailability

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.

Returns
Type Description
int

setAvailability

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getSupportedPrivacy

Contact privacy options that the domain supports.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSupportedPrivacy

Contact privacy options that the domain supports.

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

getDomainNotices

Notices about special properties of the domain.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDomainNotices

Notices about special properties of the domain.

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

getYearlyPrice

Price to register or renew the domain for one year.

Returns
Type Description
Google\Type\Money|null

hasYearlyPrice

clearYearlyPrice

setYearlyPrice

Price to register or renew the domain for one year.

Parameter
Name Description
var Google\Type\Money
Returns
Type Description
$this