Google Cloud Domains V1 Client - Class RegisterDomainRequest (0.4.2)

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

Request for the RegisterDomain method.

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

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`	`Google\Cloud\Domains\V1\Registration` Required. The complete `Registration` resource to be created.
`↳ domain_notices`	`array` The list of domain notices that you acknowledge. Call `RetrieveRegisterParameters` to see the notices that need acknowledgement.
`↳ contact_notices`	`array` The list of contact notices that the caller acknowledges. The notices needed here depend on the values specified in `registration.contact_settings`.
`↳ yearly_price`	`Google\Type\Money` Required. Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.
`↳ validate_only`	`bool` When true, only validation is performed, without actually registering the domain. Follows: https://cloud.google.com/apis/design/design_patterns#request_validation

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.

Returns
Type	Description
`Google\Cloud\Domains\V1\Registration\|null`

hasRegistration

clearRegistration

setRegistration

Required. The complete Registration resource to be created.

Parameter
Name	Description
`var`	`Google\Cloud\Domains\V1\Registration`

Returns
Type	Description
`$this`

getDomainNotices

The list of domain notices that you acknowledge. Call RetrieveRegisterParameters to see the notices that need acknowledgement.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setDomainNotices

The list of domain notices that you acknowledge. Call RetrieveRegisterParameters to see the notices that need acknowledgement.

Parameter
Name	Description
`var`	`int[]`

Returns
Type	Description
`$this`

getContactNotices

The list of contact notices that the caller acknowledges. 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 the caller acknowledges. The notices needed here depend on the values specified in registration.contact_settings.

Parameter
Name	Description
`var`	`int[]`

Returns
Type	Description
`$this`

getYearlyPrice

Required. Yearly price to register or renew the domain.

The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.

Returns
Type	Description
`Google\Type\Money\|null`

hasYearlyPrice

clearYearlyPrice

setYearlyPrice

Required. Yearly price to register or renew the domain.

The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.

Parameter
Name	Description
`var`	`Google\Type\Money`

Returns
Type	Description
`$this`

getValidateOnly

When true, only validation is performed, without actually registering the domain. Follows: https://cloud.google.com/apis/design/design_patterns#request_validation

Returns
Type	Description
`bool`

setValidateOnly

When true, only validation is performed, without actually registering the domain. Follows: https://cloud.google.com/apis/design/design_patterns#request_validation

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 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.
`yearlyPrice`	`Google\Type\Money` Required. Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.

Returns
Type	Description
`Google\Cloud\Domains\V1\RegisterDomainRequest`