com.google.cloud.dns.spi.v1

Interface DnsRpc

All Superinterfaces:

ServiceRpc

All Known Implementing Classes:

HttpDnsRpc

public interface DnsRpc
extends ServiceRpc

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DnsRpc.ListResult<T>
static class	DnsRpc.Option

Method Summary

Modifier and Type	Method and Description
com.google.api.services.dns.model.Change	applyChangeRequest(String zoneName, com.google.api.services.dns.model.Change changeRequest, Map<DnsRpc.Option,?> options) Applies change request to a zone.
com.google.api.services.dns.model.ManagedZone	create(com.google.api.services.dns.model.ManagedZone zone, Map<DnsRpc.Option,?> options) Creates a new zone.
RpcBatch	createBatch() Creates an empty batch.
boolean	deleteZone(String zoneName) Deletes the zone identified by the name.
com.google.api.services.dns.model.Change	getChangeRequest(String zoneName, String changeRequestId, Map<DnsRpc.Option,?> options) Returns an existing change request.
com.google.api.services.dns.model.Project	getProject(Map<DnsRpc.Option,?> options) Returns information about the current project.
com.google.api.services.dns.model.ManagedZone	getZone(String zoneName, Map<DnsRpc.Option,?> options) Retrieves and returns an existing zone.
DnsRpc.ListResult<com.google.api.services.dns.model.Change>	listChangeRequests(String zoneName, Map<DnsRpc.Option,?> options) List existing change requests for a zone.
DnsRpc.ListResult<com.google.api.services.dns.model.ResourceRecordSet>	listRecordSets(String zoneName, Map<DnsRpc.Option,?> options) Lists record sets for a given zone.
DnsRpc.ListResult<com.google.api.services.dns.model.ManagedZone>	listZones(Map<DnsRpc.Option,?> options) Lists the zones that exist within the project.

Method Detail

create

com.google.api.services.dns.model.ManagedZone create(com.google.api.services.dns.model.ManagedZone zone,
                                                     Map<DnsRpc.Option,?> options)
                                              throws DnsException

Creates a new zone.

Parameters:

zone - a zone to be created

options - a map of options for the service call

Returns:

Updated ManagedZone object

Throws:

DnsException - upon failure

getZone

com.google.api.services.dns.model.ManagedZone getZone(String zoneName,
                                                      Map<DnsRpc.Option,?> options)
                                               throws DnsException

Retrieves and returns an existing zone.

Parameters:

zoneName - name of the zone to be returned

options - a map of options for the service call

Returns:

a zone or null if not found

Throws:

DnsException - upon failure

listZones

DnsRpc.ListResult<com.google.api.services.dns.model.ManagedZone> listZones(Map<DnsRpc.Option,?> options)
                                                                    throws DnsException

Lists the zones that exist within the project.

Parameters:

options - a map of options for the service call

Throws:

DnsException - upon failure

deleteZone

boolean deleteZone(String zoneName)
            throws DnsException

Deletes the zone identified by the name.

Returns:

true if the zone was deleted and false otherwise

Throws:

DnsException - upon failure

listRecordSets

DnsRpc.ListResult<com.google.api.services.dns.model.ResourceRecordSet> listRecordSets(String zoneName,
                                                                                      Map<DnsRpc.Option,?> options)
                                                                               throws DnsException

Lists record sets for a given zone.

Parameters:

zoneName - name of the zone to be listed

options - a map of options for the service call

Throws:

DnsException - upon failure or if zone was not found

getProject

com.google.api.services.dns.model.Project getProject(Map<DnsRpc.Option,?> options)
                                              throws DnsException

Returns information about the current project.

Parameters:

options - a map of options for the service call

Returns:

up-to-date project information

Throws:

DnsException - upon failure or if the project is not found

applyChangeRequest

com.google.api.services.dns.model.Change applyChangeRequest(String zoneName,
                                                            com.google.api.services.dns.model.Change changeRequest,
                                                            Map<DnsRpc.Option,?> options)
                                                     throws DnsException

Applies change request to a zone.

Parameters:

zoneName - the name of a zone to which the Change should be applied

changeRequest - change to be applied

options - a map of options for the service call

Returns:

updated change object with server-assigned ID

Throws:

DnsException - upon failure or if zone was not found

getChangeRequest

com.google.api.services.dns.model.Change getChangeRequest(String zoneName,
                                                          String changeRequestId,
                                                          Map<DnsRpc.Option,?> options)
                                                   throws DnsException

Returns an existing change request.

Parameters:

zoneName - the name of a zone to which the Change was be applied

changeRequestId - the unique id assigned to the change by the server

options - a map of options for the service call

Returns:

up-to-date change object or null if change was not found

Throws:

DnsException - upon failure or if zone was not found

listChangeRequests

DnsRpc.ListResult<com.google.api.services.dns.model.Change> listChangeRequests(String zoneName,
                                                                               Map<DnsRpc.Option,?> options)
                                                                        throws DnsException

List existing change requests for a zone.

Parameters:

zoneName - the name of a zone to which the Changes were be applied

options - a map of options for the service call

Throws:

DnsException - upon failure or if zone was not found

createBatch

RpcBatch createBatch()

Creates an empty batch.