Google Cloud Domains V1 Client - Class RegisterParameters (0.4.2)

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

Parameters required to register a new domain.

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

Namespace

Google \ Cloud \ Domains \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
string

setDomainName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$this

getSupportedPrivacy

Contact privacy options that the domain supports.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSupportedPrivacy

Contact privacy options that the domain supports.

Parameter
NameDescription
var int[]
Returns
TypeDescription
$this

getDomainNotices

Notices about special properties of the domain.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setDomainNotices

Notices about special properties of the domain.

Parameter
NameDescription
var int[]
Returns
TypeDescription
$this

getYearlyPrice

Price to register or renew the domain for one year.

Returns
TypeDescription
Google\Type\Money|null

hasYearlyPrice

clearYearlyPrice

setYearlyPrice

Price to register or renew the domain for one year.

Parameter
NameDescription
var Google\Type\Money
Returns
TypeDescription
$this