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
Successful response
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. |
Successful response
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. |
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 | maxResults , pageToken , sortBy , sortOrder | Enumerates Changes to a ResourceRecordSet collection. |
create | insert | project , managedZone | clientOperationId | Atomically updates the ResourceRecordSet collection. |
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 maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}';
INSERT
examples
- create
- Manifest
Atomically updates the ResourceRecordSet collection.
INSERT INTO google.dns.changes (
data__additions,
data__deletions,
data__startTime,
data__id,
data__status,
data__isServing,
data__kind,
project,
managedZone,
clientOperationId
)
SELECT
'{{ additions }}',
'{{ deletions }}',
'{{ startTime }}',
'{{ id }}',
'{{ status }}',
{{ isServing }},
'{{ kind }}',
'{{ project }}',
'{{ managedZone }}',
'{{ clientOperationId }}'
RETURNING
id,
additions,
deletions,
isServing,
kind,
startTime,
status
;
# Description fields are for documentation purposes
- name: changes
props:
- name: project
value: string
description: Required parameter for the changes resource.
- name: managedZone
value: string
description: Required parameter for the changes resource.
- name: additions
value: array
description: >
Which ResourceRecordSets to add?
- name: deletions
value: array
description: >
Which ResourceRecordSets to remove? Must match existing data exactly.
- name: startTime
value: string
description: >
The time that this operation was started by the server (output only). This is in RFC3339 text format.
- name: id
value: string
description: >
Unique identifier for the resource; defined by the server (output only).
- name: status
value: string
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: isServing
value: boolean
description: >
If the DNS queries for the zone will be served.
- name: kind
value: string
default: dns#change
- name: clientOperationId
value: string