Google Cloud Domains V1 Client - Class TransferDomainRequest (1.0.2)

Version latest

• 1.0.2 (latest)
• 1.0.1
• 0.5.5
• 0.4.2
• 0.3.1
• 0.2.11

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

Request for the TransferDomain method.

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

Namespace

Google \ Cloud \ Domains \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The parent resource of the Registration. Must be in the format projects/*/locations/*.
↳ registration	Registration 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.
↳ contact_notices	array The list of contact notices that you acknowledge. The notices needed here depend on the values specified in registration.contact_settings.
↳ yearly_price	Google\Type\Money Required. Acknowledgement of the price to transfer or renew the domain for one year. Call RetrieveTransferParameters to obtain the price, which you must acknowledge.
↳ authorization_code	AuthorizationCode The domain's transfer authorization code. You can obtain this from the domain's current registrar.
↳ validate_only	bool Validate the request without actually transferring the domain.

getParent

Required. The parent resource of the Registration. Must be in the format projects/*/locations/*.

Returns
Type	Description
string

setParent

Required. The parent resource of the Registration. Must be in the format projects/*/locations/*.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getRegistration

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.

Returns
Type	Description
Registration|null

hasRegistration

clearRegistration

setRegistration

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.

Parameter
Name	Description
var	Registration

Returns
Type	Description
$this

getContactNotices

The list of contact notices that you acknowledge. The notices needed here depend on the values specified in registration.contact_settings.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setContactNotices

The list of contact notices that you acknowledge. The notices needed here depend on the values specified in registration.contact_settings.

Parameter
Name	Description
var	int[]

Returns
Type	Description
$this

getYearlyPrice

Required. Acknowledgement of the price to transfer or renew the domain for one year.

Call RetrieveTransferParameters to obtain the price, which you must acknowledge.

Returns
Type	Description
Google\Type\Money|null

hasYearlyPrice

clearYearlyPrice

setYearlyPrice

Required. Acknowledgement of the price to transfer or renew the domain for one year.

Call RetrieveTransferParameters to obtain the price, which you must acknowledge.

Parameter
Name	Description
var	Google\Type\Money

Returns
Type	Description
$this

getAuthorizationCode

The domain's transfer authorization code. You can obtain this from the domain's current registrar.

Returns
Type	Description
AuthorizationCode|null

hasAuthorizationCode

clearAuthorizationCode

setAuthorizationCode

The domain's transfer authorization code. You can obtain this from the domain's current registrar.

Parameter
Name	Description
var	AuthorizationCode

Returns
Type	Description
$this

getValidateOnly

Validate the request without actually transferring the domain.

Returns
Type	Description
bool

setValidateOnly

Validate the request without actually transferring the domain.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

static::build

Parameters
Name	Description
parent	string Required. The parent resource of the Registration. Must be in the format projects/*/locations/*. Please see DomainsClient::locationName() for help formatting this field.
registration	Registration 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.
yearlyPrice	Google\Type\Money Required. Acknowledgement of the price to transfer or renew the domain for one year. Call RetrieveTransferParameters to obtain the price, which you must acknowledge.
authorizationCode	AuthorizationCode The domain's transfer authorization code. You can obtain this from the domain's current registrar.

Returns
Type	Description
TransferDomainRequest