Google Cloud Domains V1 Client - Class ConfigureDnsSettingsRequest (1.0.4)

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

Request for the ConfigureDnsSettings method.

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

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 DNS settings are being updated, in the format projects/*/locations/*/registrations/* .

↳ dns_settings
DnsSettings

Fields of the DnsSettings 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 name servers are being updated for an existing Custom DNS configuration, the update_mask is "custom_dns.name_servers" . When changing the DNS provider from one type to another, pass the new provider's field name as part of the field mask. For example, when changing from a Google Domains DNS configuration to a Custom DNS configuration, the update_mask is "custom_dns" . //

↳ validate_only
bool

Validate the request without actually updating the DNS settings.

getRegistration

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

Returns
Type
Description
string

setRegistration

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDnsSettings

Fields of the DnsSettings to update.

Returns
Type
Description
DnsSettings |null

hasDnsSettings

clearDnsSettings

setDnsSettings

Fields of the DnsSettings to update.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateMask

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

For example, if only the name servers are being updated for an existing Custom DNS configuration, the update_mask is "custom_dns.name_servers" . When changing the DNS provider from one type to another, pass the new provider's field name as part of the field mask. For example, when changing from a Google Domains DNS configuration to a Custom DNS configuration, the update_mask is "custom_dns" . //

Returns
Type
Description

hasUpdateMask

clearUpdateMask

setUpdateMask

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

For example, if only the name servers are being updated for an existing Custom DNS configuration, the update_mask is "custom_dns.name_servers" . When changing the DNS provider from one type to another, pass the new provider's field name as part of the field mask. For example, when changing from a Google Domains DNS configuration to a Custom DNS configuration, the update_mask is "custom_dns" . //

Parameter
Name
Description
Returns
Type
Description
$this

getValidateOnly

Validate the request without actually updating the DNS settings.

Returns
Type
Description
bool

setValidateOnly

Validate the request without actually updating the DNS settings.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

static::build

Parameters
Name
Description
registration
string

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

dnsSettings
DnsSettings

Fields of the DnsSettings 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 name servers are being updated for an existing Custom DNS configuration, the update_mask is "custom_dns.name_servers" .

When changing the DNS provider from one type to another, pass the new provider's field name as part of the field mask. For example, when changing from a Google Domains DNS configuration to a Custom DNS configuration, the update_mask is "custom_dns" . //

Returns
Type
Description
Design a Mobile Site
View Site in Mobile | Classic
Share by: