Class DnsBatch (2.10.0)

public class DnsBatch

A batch of operations to be submitted to Google Cloud DNS using a single RPC request.

Inheritance

java.lang.Object > DnsBatch

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

applyChangeRequest(String zoneName, ChangeRequestInfo changeRequest, Dns.ChangeRequestOption[] options)

public DnsBatchResult<ChangeRequest> applyChangeRequest(String zoneName, ChangeRequestInfo changeRequest, Dns.ChangeRequestOption[] options)

Adds a request representing the "apply change request" operation to the zone specified by zoneName to this batch. The options can be used to restrict the fields returned in the same way as for Dns#applyChangeRequest(String, ChangeRequestInfo, Dns.ChangeRequestOption...). Calling DnsBatchResult#get() on the return value yields the created ChangeRequest if successful or throws a DnsException if the operation failed or the zone does not exist.

Parameters

Name	Description
`zoneName`	`String`
`changeRequest`	`ChangeRequestInfo`
`options`	`ChangeRequestOption[]`

Returns

Type	Description
`DnsBatchResult<ChangeRequest>`

createZone(ZoneInfo zone, Dns.ZoneOption[] options)

public DnsBatchResult<Zone> createZone(ZoneInfo zone, Dns.ZoneOption[] options)

Adds a request representing the "create zone" operation to this batch. The options can be used to restrict the fields returned in the same way as for Dns#create(ZoneInfo, Dns.ZoneOption...). Calling DnsBatchResult#get() on the return value yields the created Zone if successful and throws a DnsException otherwise.

Parameters

Name	Description
`zone`	`ZoneInfo`
`options`	`ZoneOption[]`

Returns

Type	Description
`DnsBatchResult<Zone>`

deleteZone(String zoneName)

public DnsBatchResult<Boolean> deleteZone(String zoneName)

Adds a request representing the "delete zone" operation to this batch. Calling DnsBatchResult#get() on the return value yields true upon successful deletion, false if the zone was not found, or throws a DnsException if the operation failed.

Parameter

Name	Description
`zoneName`	`String`

Returns

Type	Description
`DnsBatchResult<Boolean>`

getChangeRequest(String zoneName, String changeRequestId, Dns.ChangeRequestOption[] options)

public DnsBatchResult<ChangeRequest> getChangeRequest(String zoneName, String changeRequestId, Dns.ChangeRequestOption[] options)

Adds a request representing the "get change request" operation for the zone specified by zoneName to this batch. The options can be used to restrict the fields returned in the same way as for Dns#getChangeRequest(String, String, Dns.ChangeRequestOption...). Calling DnsBatchResult#get() on the return value yields the requested ChangeRequest if successful, null if the change request does not exist, or throws a DnsException if the operation failed or the zone does not exist.

Parameters

Name	Description
`zoneName`	`String`
`changeRequestId`	`String`
`options`	`ChangeRequestOption[]`

Returns

Type	Description
`DnsBatchResult<ChangeRequest>`

getProject(Dns.ProjectOption[] options)

public DnsBatchResult<ProjectInfo> getProject(Dns.ProjectOption[] options)

Adds a request representing the "get project" operation to this batch. The options can be used to restrict the fields returned in the same way as for Dns#getProject(Dns.ProjectOption...). Calling DnsBatchResult#get() on the return value yields the created ProjectInfo if successful and throws a DnsException if the operation failed.

Parameter

Name	Description
`options`	`ProjectOption[]`

Returns

Type	Description
`DnsBatchResult<ProjectInfo>`

getZone(String zoneName, Dns.ZoneOption[] options)

public DnsBatchResult<Zone> getZone(String zoneName, Dns.ZoneOption[] options)

Adds a request representing the "get zone" operation to this batch. The options can be used to restrict the fields returned in the same way as for Dns#getZone(String, Dns.ZoneOption...). Calling DnsBatchResult#get() on the return value yields the requested Zone if successful, null if no such zone exists, or throws a DnsException if the operation failed.

Parameters

Name	Description
`zoneName`	`String`
`options`	`ZoneOption[]`

Returns

Type	Description
`DnsBatchResult<Zone>`

listChangeRequests(String zoneName, Dns.ChangeRequestListOption[] options)

public DnsBatchResult<Page<ChangeRequest>> listChangeRequests(String zoneName, Dns.ChangeRequestListOption[] options)

Adds a request representing the "list change requests" operation in the zone specified by zoneName to this batch. The options can be used to restrict the fields returned or provide page size limits in the same way as for Dns#listChangeRequests(String, Dns.ChangeRequestListOption...). Calling DnsBatchResult#get() on the return value yields a page of change requests if successful and throws a DnsException if the operation failed or the zone does not exist.

Parameters

Name	Description
`zoneName`	`String`
`options`	`ChangeRequestListOption[]`

Returns

Type	Description
`DnsBatchResult<Page<ChangeRequest>>`

listRecordSets(String zoneName, Dns.RecordSetListOption[] options)

public DnsBatchResult<Page<RecordSet>> listRecordSets(String zoneName, Dns.RecordSetListOption[] options)

Adds a request representing the "list record sets" operation in the zone specified by zoneName to this batch. The options can be used to restrict the fields returned or provide page size limits in the same way as for Dns#listRecordSets(String, Dns.RecordSetListOption...). Calling DnsBatchResult#get() on the return value yields a page of record sets if successful and throws a DnsException if the operation failed or the zone does not exist.

Parameters

Name	Description
`zoneName`	`String`
`options`	`RecordSetListOption[]`

Returns

Type	Description
`DnsBatchResult<Page<RecordSet>>`

listZones(Dns.ZoneListOption[] options)

public DnsBatchResult<Page<Zone>> listZones(Dns.ZoneListOption[] options)

Adds a request representing the "list zones" operation to this batch. The options can be used to restrict the fields returned or provide page size limits in the same way as for Dns#listZones(Dns.ZoneListOption...). Calling DnsBatchResult#get() on the return value yields a page of zones if successful and throws a DnsException otherwise.

Parameter

Name	Description
`options`	`ZoneListOption[]`

Returns

Type	Description
`DnsBatchResult<Page<Zone>>`

submit()

public void submit()

Submits this batch for processing using a single RPC request.