Cloud DNS API, REST: DnsFirewall.Update

Field

Description

dnsFirewallId

string

Required field. ID of the DNS firewall to update.

To get the DNS firewall ID, make a DnsFirewallService.List request.

Field

Description

updateMask

string (field-mask)

A comma-separated names off ALL fields to be updated.
Only the specified fields will be changed. The others will be left untouched.
If the field is specified in updateMask and no value for that field was sent in the request,
the field's value will be reset to the default. The default value for most fields is null or 0.

If updateMask is not sent in the request, all fields' values will be updated.
Fields specified in the request will be updated to provided values.
The rest of the fields will be reset to the default.

name

string

New name for the DNS firewall.
The name must be unique within the folder.

Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])?.

description

string

New description of the DNS firewall.

The maximum string length in characters is 256.

labels

object (map<string, string>)

DNS firewall labels as key:value pairs.
Existing set of labels is completely replaced by the provided set, so if you just want
to add or remove a label:

1. Get the current set of labels with a DnsFirewallService.Get request.
2. Add or remove a label in this set.
3. Send the new set in this field.

The maximum string length in characters for each value is 63. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\@0-9a-z]*. Each value must match the regular expression [-_./\@0-9a-z]*. No more than 64 per resource.

deletionProtection

boolean

Prevents accidental firewall removal.

enabled

boolean

Whether the DNS firewall is enabled.

resourceConfig

ResourceConfig

Resource settings.
Specifies resources that the DNS firewall applies to.

whitelistFqdns[]

string

List of FQDNs that the DNS firewall allows to pass.

The maximum string length in characters for each value is 255. The maximum number of elements is 255.

blacklistFqdns[]

string

List of FQDNs that the DNS firewall blocks.

The maximum string length in characters for each value is 255. The maximum number of elements is 255.

Field

Description

type

enum (ResourceType)

Type of the resource.

• NETWORK: VPC network resource type.
• FOLDER: Folder resource type.
• CLOUD: Cloud resource type.

resourceIds[]

string

Resource ids.

The maximum string length in characters for each value is 64. The number of elements must be in the range 0-100.

lockingPolicyEnabled

boolean

Whether the locking policy is enabled.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

object

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

object

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.