changes
Creates, updates, deletes, gets or lists a changes resource.
Overview
| Name | changes |
| Type | Resource |
| Id | google.dns.changes |
Fields
The following fields are returned by SELECT queries:
- get
- list
| Name | Datatype | Description |
|---|---|---|
id | string | Unique identifier for the resource; defined by the server (output only). |
additions | array | Which ResourceRecordSets to add? |
deletions | array | Which ResourceRecordSets to remove? Must match existing data exactly. |
isServing | boolean | If the DNS queries for the zone will be served. |
kind | string | (default: dns#change) |
startTime | string | The time that this operation was started by the server (output only). This is in RFC3339 text format. |
status | string | Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. (pending, done) |
| Name | Datatype | Description |
|---|---|---|
id | string | Unique identifier for the resource; defined by the server (output only). |
additions | array | Which ResourceRecordSets to add? |
deletions | array | Which ResourceRecordSets to remove? Must match existing data exactly. |
isServing | boolean | If the DNS queries for the zone will be served. |
kind | string | (default: dns#change) |
startTime | string | The time that this operation was started by the server (output only). This is in RFC3339 text format. |
status | string | Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. (pending, done) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | project, managedZone, changeId | clientOperationId | Fetches the representation of an existing Change. |
list | select | project, managedZone | pageToken, sortOrder, maxResults, sortBy | Enumerates Changes to a ResourceRecordSet collection. |
create | insert | project, managedZone | clientOperationId | Atomically updates the ResourceRecordSet collection. Note: While dns.changes.create is the baseline permission required to invoke this method, additional permissions are checked depending on the specific additions or deletions contained in the payload. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
changeId | string | |
managedZone | string | |
project | string | |
clientOperationId | string | |
maxResults | integer (int32) | |
pageToken | string | |
sortBy | string | |
sortOrder | string |
SELECT examples
- get
- list
Fetches the representation of an existing Change.
SELECT
id,
additions,
deletions,
isServing,
kind,
startTime,
status
FROM google.dns.changes
WHERE project = '{{ project }}' -- required
AND managedZone = '{{ managedZone }}' -- required
AND changeId = '{{ changeId }}' -- required
AND clientOperationId = '{{ clientOperationId }}'
;
Enumerates Changes to a ResourceRecordSet collection.
SELECT
id,
additions,
deletions,
isServing,
kind,
startTime,
status
FROM google.dns.changes
WHERE project = '{{ project }}' -- required
AND managedZone = '{{ managedZone }}' -- required
AND pageToken = '{{ pageToken }}'
AND sortOrder = '{{ sortOrder }}'
AND maxResults = '{{ maxResults }}'
AND sortBy = '{{ sortBy }}'
;
INSERT examples
- create
- Manifest
Atomically updates the ResourceRecordSet collection. Note: While dns.changes.create is the baseline permission required to invoke this method, additional permissions are checked depending on the specific additions or deletions contained in the payload.
INSERT INTO google.dns.changes (
data__deletions,
data__status,
data__kind,
data__isServing,
data__id,
data__additions,
data__startTime,
project,
managedZone,
clientOperationId
)
SELECT
'{{ deletions }}',
'{{ status }}',
'{{ kind }}',
{{ isServing }},
'{{ id }}',
'{{ additions }}',
'{{ startTime }}',
'{{ project }}',
'{{ managedZone }}',
'{{ clientOperationId }}'
RETURNING
id,
additions,
deletions,
isServing,
kind,
startTime,
status
;
# Description fields are for documentation purposes
- name: changes
props:
- name: project
value: "{{ project }}"
description: Required parameter for the changes resource.
- name: managedZone
value: "{{ managedZone }}"
description: Required parameter for the changes resource.
- name: deletions
description: |
Which ResourceRecordSets to remove? Must match existing data exactly.
value:
- routingPolicy:
geo:
enableFencing: {{ enableFencing }}
kind: "{{ kind }}"
items:
- kind: "{{ kind }}"
location: "{{ location }}"
rrdatas: "{{ rrdatas }}"
signatureRrdatas: "{{ signatureRrdatas }}"
healthCheckedTargets:
internalLoadBalancers: "{{ internalLoadBalancers }}"
externalEndpoints: "{{ externalEndpoints }}"
primaryBackup:
primaryTargets:
internalLoadBalancers:
- ipAddress: "{{ ipAddress }}"
kind: "{{ kind }}"
ipProtocol: "{{ ipProtocol }}"
region: "{{ region }}"
project: "{{ project }}"
loadBalancerType: "{{ loadBalancerType }}"
networkUrl: "{{ networkUrl }}"
port: "{{ port }}"
externalEndpoints:
- "{{ externalEndpoints }}"
kind: "{{ kind }}"
trickleTraffic: {{ trickleTraffic }}
backupGeoTargets:
enableFencing: {{ enableFencing }}
kind: "{{ kind }}"
items:
- kind: "{{ kind }}"
location: "{{ location }}"
rrdatas: "{{ rrdatas }}"
signatureRrdatas: "{{ signatureRrdatas }}"
healthCheckedTargets:
internalLoadBalancers: "{{ internalLoadBalancers }}"
externalEndpoints: "{{ externalEndpoints }}"
healthCheck: "{{ healthCheck }}"
kind: "{{ kind }}"
wrr:
items:
- weight: {{ weight }}
kind: "{{ kind }}"
rrdatas: "{{ rrdatas }}"
signatureRrdatas: "{{ signatureRrdatas }}"
healthCheckedTargets:
internalLoadBalancers: "{{ internalLoadBalancers }}"
externalEndpoints: "{{ externalEndpoints }}"
kind: "{{ kind }}"
kind: "{{ kind }}"
ttl: {{ ttl }}
rrdatas: "{{ rrdatas }}"
signatureRrdatas: "{{ signatureRrdatas }}"
type: "{{ type }}"
name: "{{ name }}"
- name: status
value: "{{ status }}"
description: |
Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet.
valid_values: ['pending', 'done']
- name: kind
value: "{{ kind }}"
default: dns#change
- name: isServing
value: {{ isServing }}
description: |
If the DNS queries for the zone will be served.
- name: id
value: "{{ id }}"
description: |
Unique identifier for the resource; defined by the server (output only).
- name: additions
description: |
Which ResourceRecordSets to add?
value:
- routingPolicy:
geo:
enableFencing: {{ enableFencing }}
kind: "{{ kind }}"
items:
- kind: "{{ kind }}"
location: "{{ location }}"
rrdatas: "{{ rrdatas }}"
signatureRrdatas: "{{ signatureRrdatas }}"
healthCheckedTargets:
internalLoadBalancers: "{{ internalLoadBalancers }}"
externalEndpoints: "{{ externalEndpoints }}"
primaryBackup:
primaryTargets:
internalLoadBalancers:
- ipAddress: "{{ ipAddress }}"
kind: "{{ kind }}"
ipProtocol: "{{ ipProtocol }}"
region: "{{ region }}"
project: "{{ project }}"
loadBalancerType: "{{ loadBalancerType }}"
networkUrl: "{{ networkUrl }}"
port: "{{ port }}"
externalEndpoints:
- "{{ externalEndpoints }}"
kind: "{{ kind }}"
trickleTraffic: {{ trickleTraffic }}
backupGeoTargets:
enableFencing: {{ enableFencing }}
kind: "{{ kind }}"
items:
- kind: "{{ kind }}"
location: "{{ location }}"
rrdatas: "{{ rrdatas }}"
signatureRrdatas: "{{ signatureRrdatas }}"
healthCheckedTargets:
internalLoadBalancers: "{{ internalLoadBalancers }}"
externalEndpoints: "{{ externalEndpoints }}"
healthCheck: "{{ healthCheck }}"
kind: "{{ kind }}"
wrr:
items:
- weight: {{ weight }}
kind: "{{ kind }}"
rrdatas: "{{ rrdatas }}"
signatureRrdatas: "{{ signatureRrdatas }}"
healthCheckedTargets:
internalLoadBalancers: "{{ internalLoadBalancers }}"
externalEndpoints: "{{ externalEndpoints }}"
kind: "{{ kind }}"
kind: "{{ kind }}"
ttl: {{ ttl }}
rrdatas: "{{ rrdatas }}"
signatureRrdatas: "{{ signatureRrdatas }}"
type: "{{ type }}"
name: "{{ name }}"
- name: startTime
value: "{{ startTime }}"
description: |
The time that this operation was started by the server (output only). This is in RFC3339 text format.
- name: clientOperationId
value: "{{ clientOperationId }}"