Google Cloud Domains V1 Client - Class TransferDomainRequest (0.5.0)

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
NameDescription
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 Google\Cloud\Domains\V1\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 Google\Cloud\Domains\V1\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
TypeDescription
string

setParent

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
Google\Cloud\Domains\V1\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
NameDescription
var Google\Cloud\Domains\V1\Registration
Returns
TypeDescription
$this

getContactNotices

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

Returns
TypeDescription
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
NameDescription
var int[]
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Type\Money
Returns
TypeDescription
$this

getAuthorizationCode

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

Returns
TypeDescription
Google\Cloud\Domains\V1\AuthorizationCode|null

hasAuthorizationCode

clearAuthorizationCode

setAuthorizationCode

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

Parameter
NameDescription
var Google\Cloud\Domains\V1\AuthorizationCode
Returns
TypeDescription
$this

getValidateOnly

Validate the request without actually transferring the domain.

Returns
TypeDescription
bool

setValidateOnly

Validate the request without actually transferring the domain.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parent string

Required. The parent resource of the Registration. Must be in the format projects/*/locations/*. Please see Google\Cloud\Domains\V1\DomainsClient::locationName() for help formatting this field.

registration Google\Cloud\Domains\V1\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 Google\Cloud\Domains\V1\AuthorizationCode

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

Returns
TypeDescription
Google\Cloud\Domains\V1\TransferDomainRequest