Class Changes (0.36.0)

Changes(zone)

Parameter

NameDescription
zoneManagedZone

A zone which holds one or more record sets.

Properties

additions

Resource record sets to be added to the zone.

Returns
TypeDescription
sequence ofResourceRecordSet.record sets appended viaadd_record_set.

deletions

Resource record sets to be deleted from the zone.

Returns
TypeDescription
sequence ofResourceRecordSet.record sets appended viadelete_record_set.

name

Name of the change set.

Returns
TypeDescription
str orNoneTypeName, as set by the back-end, or None.

path

URL path for change set APIs.

Returns
TypeDescription
strthe path based on project, zone, and change set names.

started

Time when the change set was started.

Returns
TypeDescription
datetime.datetime orNoneTypeTime, as set by the back-end, or None.

status

Status of the change set.

Returns
TypeDescription
str orNoneTypeStatus, as set by the back-end, or None.

Methods

add_record_set

add_record_set(record_set)

Append a record set to the 'additions' for the change set.

Parameter
NameDescription
record_setResourceRecordSet

the record set to append.

Exceptions
TypeDescription
`ValueErrorifrecord_set is not of the required type.

create

create(client=None)

API call: create the change set via a POST request.

Seehttps://cloud.google.com/dns/api/v1/changes/create

Parameter
NameDescription
clientClient

(Optional) the client to use. If not passed, falls back to theclient stored on the current zone.

delete_record_set

delete_record_set(record_set)

Append a record set to the 'deletions' for the change set.

Parameter
NameDescription
record_setResourceRecordSet

the record set to append.

Exceptions
TypeDescription
`ValueErrorifrecord_set is not of the required type.

exists

exists(client=None)

API call: test for the existence of the change set via a GET request.

Seehttps://cloud.google.com/dns/api/v1/changes/get

Parameter
NameDescription
clientClient

(Optional) the client to use. If not passed, falls back to theclient stored on the current zone.

Returns
TypeDescription
boolBoolean indicating existence of the changes.

from_api_repr

from_api_repr(resource,zone)

Factory: construct a change set given its API representation

Parameters
NameDescription
resourcedict

change set representation returned from the API.

zoneManagedZone

A zone which holds zero or more change sets.

Returns
TypeDescription
ChangesRRS parsed fromresource.

reload

reload(client=None)

API call: refresh zone properties via a GET request.

Seehttps://cloud.google.com/dns/api/v1/changes/get

Parameter
NameDescription
clientClient

(Optional) the client to use. If not passed, falls back to theclient stored on the current zone.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-01-10 UTC.