Google Cloud Domains V1 Client - Class ConfigureContactSettingsRequest (0.4.2)

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

Request for the ConfigureContactSettings method.

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

Namespace

Google \ Cloud \ Domains \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ registration string

Required. The name of the Registration whose contact settings are being updated, in the format projects/*/locations/*/registrations/*.

↳ contact_settings Google\Cloud\Domains\V1\ContactSettings

Fields of the ContactSettings to update.

↳ update_mask Google\Protobuf\FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the registrant contact is being updated, the update_mask is "registrant_contact".

↳ contact_notices array

The list of contact notices that the caller acknowledges. The notices needed here depend on the values specified in contact_settings.

↳ validate_only bool

Validate the request without actually updating the contact settings.

getRegistration

Required. The name of the Registration whose contact settings are being updated, in the format projects/*/locations/*/registrations/*.

Returns
TypeDescription
string

setRegistration

Required. The name of the Registration whose contact settings are being updated, in the format projects/*/locations/*/registrations/*.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getContactSettings

Fields of the ContactSettings to update.

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

hasContactSettings

clearContactSettings

setContactSettings

Fields of the ContactSettings to update.

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

getUpdateMask

Required. The field mask describing which fields to update as a comma-separated list.

For example, if only the registrant contact is being updated, the update_mask is "registrant_contact".

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. The field mask describing which fields to update as a comma-separated list.

For example, if only the registrant contact is being updated, the update_mask is "registrant_contact".

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this

getContactNotices

The list of contact notices that the caller acknowledges. The notices needed here depend on the values specified in contact_settings.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setContactNotices

The list of contact notices that the caller acknowledges. The notices needed here depend on the values specified in contact_settings.

Parameter
NameDescription
var int[]
Returns
TypeDescription
$this

getValidateOnly

Validate the request without actually updating the contact settings.

Returns
TypeDescription
bool

setValidateOnly

Validate the request without actually updating the contact settings.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
registration string

Required. The name of the Registration whose contact settings are being updated, in the format projects/*/locations/*/registrations/*. Please see Google\Cloud\Domains\V1\DomainsClient::registrationName() for help formatting this field.

contactSettings Google\Cloud\Domains\V1\ContactSettings

Fields of the ContactSettings to update.

updateMask Google\Protobuf\FieldMask

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the registrant contact is being updated, the update_mask is "registrant_contact".

Returns
TypeDescription
Google\Cloud\Domains\V1\ConfigureContactSettingsRequest