Google Cloud Domains V1 Client - Class ConfigureContactSettingsRequest (1.0.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
Name	Description
`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`	`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
Type	Description
`string`

setRegistration

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getContactSettings

Fields of the ContactSettings to update.

Returns
Type	Description
`ContactSettings\|null`

hasContactSettings

clearContactSettings

setContactSettings

Fields of the ContactSettings to update.

Parameter
Name	Description
`var`	`ContactSettings`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`Google\Protobuf\FieldMask`

Returns
Type	Description
`$this`

getContactNotices

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

Parameter
Name	Description
`var`	`int[]`

Returns
Type	Description
`$this`

getValidateOnly

Validate the request without actually updating the contact settings.

Returns
Type	Description
`bool`

setValidateOnly

Validate the request without actually updating the contact settings.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`registration`	`string` Required. The name of the `Registration` whose contact settings are being updated, in the format `projects//locations//registrations/*`. Please see DomainsClient::registrationName() for help formatting this field.
`contactSettings`	`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
Type	Description
`ConfigureContactSettingsRequest`