dns

package
v0.0.0-...-375ceb8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 31, 2015 License: BSD-3-Clause Imports: 11 Imported by: 0

Documentation

Overview

Package dns provides access to the Google Cloud DNS API.

See https://developers.google.com/cloud-dns

Usage example: 

import "google.golang.org/api/dns/v1beta1"
...
dnsService, err := dns.New(oauthHttpClient)

Index

Constants

View Source 
const (
	// View and manage your data across Google Cloud Platform services
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"

	// View your DNS records hosted by Google Cloud DNS
	NdevClouddnsReadonlyScope = "https://www.googleapis.com/auth/ndev.clouddns.readonly"

	// View and manage your DNS records hosted by Google Cloud DNS
	NdevClouddnsReadwriteScope = "https://www.googleapis.com/auth/ndev.clouddns.readwrite"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type Change 

type Change struct {
	// Additions: Which ResourceRecordSets to add?
	Additions []*ResourceRecordSet `json:"additions,omitempty"`

	// Deletions: Which ResourceRecordSets to remove? Must match existing
	// data exactly.
	Deletions []*ResourceRecordSet `json:"deletions,omitempty"`

	// Id: Unique identifier for the resource; defined by the server (output
	// only).
	Id string `json:"id,omitempty"`

	// Kind: Identifies what kind of resource this is. Value: the fixed
	// string "dns#change".
	Kind string `json:"kind,omitempty"`

	// StartTime: The time that this operation was started by the server.
	// This is in RFC3339 text format.
	StartTime string `json:"startTime,omitempty"`

	// Status: Status of the operation (output only).
	Status string `json:"status,omitempty"`
}

Change: An atomic update to a collection of ResourceRecordSets.

type ChangesCreateCall 

type ChangesCreateCall struct {
	// contains filtered or unexported fields
}

func (*ChangesCreateCall) Do 

func (c *ChangesCreateCall) Do() (*Change, error)

func (*ChangesCreateCall) Fields 

func (c *ChangesCreateCall) Fields(s ...googleapi.Field) *ChangesCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type ChangesGetCall 

type ChangesGetCall struct {
	// contains filtered or unexported fields
}

func (*ChangesGetCall) Do 

func (c *ChangesGetCall) Do() (*Change, error)

func (*ChangesGetCall) Fields 

func (c *ChangesGetCall) Fields(s ...googleapi.Field) *ChangesGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type ChangesListCall 

type ChangesListCall struct {
	// contains filtered or unexported fields
}

func (*ChangesListCall) Do 

func (c *ChangesListCall) Do() (*ChangesListResponse, error)

func (*ChangesListCall) Fields 

func (c *ChangesListCall) Fields(s ...googleapi.Field) *ChangesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ChangesListCall) MaxResults 

func (c *ChangesListCall) MaxResults(maxResults int64) *ChangesListCall

MaxResults sets the optional parameter "maxResults": Maximum number of results to be returned. If unspecified, the server will decide how many results to return.

func (*ChangesListCall) PageToken 

func (c *ChangesListCall) PageToken(pageToken string) *ChangesListCall

PageToken sets the optional parameter "pageToken": A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.

func (*ChangesListCall) SortBy 

func (c *ChangesListCall) SortBy(sortBy string) *ChangesListCall

SortBy sets the optional parameter "sortBy": Sorting criterion. The only supported value is change sequence.

Possible values: 

"changeSequence" (default)

func (*ChangesListCall) SortOrder 

func (c *ChangesListCall) SortOrder(sortOrder string) *ChangesListCall

SortOrder sets the optional parameter "sortOrder": Sorting order direction: 'ascending' or 'descending'.

type ChangesListResponse 

type ChangesListResponse struct {
	// Changes: The requested changes.
	Changes []*Change `json:"changes,omitempty"`

	// Kind: Type of resource.
	Kind string `json:"kind,omitempty"`

	// NextPageToken: The presence of this field indicates that there exist
	// more results following your last page of results in pagination order.
	// To fetch them, make another list request using this value as your
	// pagination token.
	//
	// In this way you can retrieve the complete contents of even very large
	// collections one page at a time. However, if the contents of the
	// collection change between the first and last paginated list request,
	// the set of all elements returned will be an inconsistent view of the
	// collection. There is no way to retrieve a "snapshot" of collections
	// larger than the maximum page size.
	NextPageToken string `json:"nextPageToken,omitempty"`
}

ChangesListResponse: The response to a request to enumerate Changes to a ResourceRecordSets collection.

type ChangesService 

type ChangesService struct {
	// contains filtered or unexported fields
}

func NewChangesService 

func NewChangesService(s *Service) *ChangesService

func (*ChangesService) Create 

func (r *ChangesService) Create(project string, managedZone string, change *Change) *ChangesCreateCall

Create: Atomically update the ResourceRecordSet collection.

func (*ChangesService) Get 

func (r *ChangesService) Get(project string, managedZone string, changeId string) *ChangesGetCall

Get: Fetch the representation of an existing Change.

func (*ChangesService) List 

func (r *ChangesService) List(project string, managedZone string) *ChangesListCall

List: Enumerate Changes to a ResourceRecordSet collection.

type ManagedZone 

type ManagedZone struct {
	// CreationTime: The time that this resource was created on the server.
	// This is in RFC3339 text format. Output only.
	CreationTime string `json:"creationTime,omitempty"`

	// Description: A mutable string of at most 1024 characters associated
	// with this resource for the user's convenience. Has no effect on the
	// managed zone's function.
	Description string `json:"description,omitempty"`

	// DnsName: The DNS name of this managed zone, for instance
	// "example.com.".
	DnsName string `json:"dnsName,omitempty"`

	// Id: Unique identifier for the resource; defined by the server (output
	// only)
	Id uint64 `json:"id,omitempty,string"`

	// Kind: Identifies what kind of resource this is. Value: the fixed
	// string "dns#managedZone".
	Kind string `json:"kind,omitempty"`

	// Name: User assigned name for this resource. Must be unique within the
	// project. The name must be 1-32 characters long, must begin with a
	// letter, end with a letter or digit, and only contain lowercase
	// letters, digits or dashes.
	Name string `json:"name,omitempty"`

	// NameServerSet: Optionally specifies the NameServerSet for this
	// ManagedZone. A NameServerSet is a set of DNS name servers that all
	// host the same ManagedZones. Most users will leave this field unset.
	NameServerSet string `json:"nameServerSet,omitempty"`

	// NameServers: Delegate your managed_zone to these virtual name
	// servers; defined by the server (output only)
	NameServers []string `json:"nameServers,omitempty"`
}

ManagedZone: A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.

type ManagedZonesCreateCall 

type ManagedZonesCreateCall struct {
	// contains filtered or unexported fields
}

func (*ManagedZonesCreateCall) Do 

func (c *ManagedZonesCreateCall) Do() (*ManagedZone, error)

func (*ManagedZonesCreateCall) Fields 

func (c *ManagedZonesCreateCall) Fields(s ...googleapi.Field) *ManagedZonesCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type ManagedZonesDeleteCall 

type ManagedZonesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ManagedZonesDeleteCall) Do 

func (c *ManagedZonesDeleteCall) Do() error

func (*ManagedZonesDeleteCall) Fields 

func (c *ManagedZonesDeleteCall) Fields(s ...googleapi.Field) *ManagedZonesDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type ManagedZonesGetCall 

type ManagedZonesGetCall struct {
	// contains filtered or unexported fields
}

func (*ManagedZonesGetCall) Do 

func (c *ManagedZonesGetCall) Do() (*ManagedZone, error)

func (*ManagedZonesGetCall) Fields 

func (c *ManagedZonesGetCall) Fields(s ...googleapi.Field) *ManagedZonesGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type ManagedZonesListCall 

type ManagedZonesListCall struct {
	// contains filtered or unexported fields
}

func (*ManagedZonesListCall) DnsName 

func (c *ManagedZonesListCall) DnsName(dnsName string) *ManagedZonesListCall

DnsName sets the optional parameter "dnsName": Restricts the list to return only zones with this domain name.

func (*ManagedZonesListCall) Do 

func (c *ManagedZonesListCall) Do() (*ManagedZonesListResponse, error)

func (*ManagedZonesListCall) Fields 

func (c *ManagedZonesListCall) Fields(s ...googleapi.Field) *ManagedZonesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ManagedZonesListCall) MaxResults 

func (c *ManagedZonesListCall) MaxResults(maxResults int64) *ManagedZonesListCall

MaxResults sets the optional parameter "maxResults": Maximum number of results to be returned. If unspecified, the server will decide how many results to return.

func (*ManagedZonesListCall) PageToken 

func (c *ManagedZonesListCall) PageToken(pageToken string) *ManagedZonesListCall

PageToken sets the optional parameter "pageToken": A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.

type ManagedZonesListResponse 

type ManagedZonesListResponse struct {
	// Kind: Type of resource.
	Kind string `json:"kind,omitempty"`

	// ManagedZones: The managed zone resources.
	ManagedZones []*ManagedZone `json:"managedZones,omitempty"`

	// NextPageToken: The presence of this field indicates that there exist
	// more results following your last page of results in pagination order.
	// To fetch them, make another list request using this value as your
	// page token.
	//
	// In this way you can retrieve the complete contents of even very large
	// collections one page at a time. However, if the contents of the
	// collection change between the first and last paginated list request,
	// the set of all elements returned will be an inconsistent view of the
	// collection. There is no way to retrieve a consistent snapshot of a
	// collection larger than the maximum page size.
	NextPageToken string `json:"nextPageToken,omitempty"`
}

type ManagedZonesService 

type ManagedZonesService struct {
	// contains filtered or unexported fields
}

func NewManagedZonesService 

func NewManagedZonesService(s *Service) *ManagedZonesService

func (*ManagedZonesService) Create 

func (r *ManagedZonesService) Create(project string, managedzone *ManagedZone) *ManagedZonesCreateCall

Create: Create a new ManagedZone.

func (*ManagedZonesService) Delete 

func (r *ManagedZonesService) Delete(project string, managedZone string) *ManagedZonesDeleteCall

Delete: Delete a previously created ManagedZone.

func (*ManagedZonesService) Get 

func (r *ManagedZonesService) Get(project string, managedZone string) *ManagedZonesGetCall

Get: Fetch the representation of an existing ManagedZone.

func (*ManagedZonesService) List 

func (r *ManagedZonesService) List(project string) *ManagedZonesListCall

List: Enumerate ManagedZones that have been created but not yet deleted.

type Project 

type Project struct {
	// Id: User assigned unique identifier for the resource (output only).
	Id string `json:"id,omitempty"`

	// Kind: Identifies what kind of resource this is. Value: the fixed
	// string "dns#project".
	Kind string `json:"kind,omitempty"`

	// Number: Unique numeric identifier for the resource; defined by the
	// server (output only).
	Number uint64 `json:"number,omitempty,string"`

	// Quota: Quotas assigned to this project (output only).
	Quota *Quota `json:"quota,omitempty"`
}

Project: A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console.

type ProjectsGetCall 

type ProjectsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsGetCall) Do 

func (c *ProjectsGetCall) Do() (*Project, error)

func (*ProjectsGetCall) Fields 

func (c *ProjectsGetCall) Fields(s ...googleapi.Field) *ProjectsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type ProjectsService 

type ProjectsService struct {
	// contains filtered or unexported fields
}

func NewProjectsService 

func NewProjectsService(s *Service) *ProjectsService

func (*ProjectsService) Get 

func (r *ProjectsService) Get(project string) *ProjectsGetCall

Get: Fetch the representation of an existing Project.

type Quota 

type Quota struct {
	// Kind: Identifies what kind of resource this is. Value: the fixed
	// string "dns#quota".
	Kind string `json:"kind,omitempty"`

	// ManagedZones: Maximum allowed number of managed zones in the project.
	ManagedZones int64 `json:"managedZones,omitempty"`

	// ResourceRecordsPerRrset: Maximum allowed number of ResourceRecords
	// per ResourceRecordSet.
	ResourceRecordsPerRrset int64 `json:"resourceRecordsPerRrset,omitempty"`

	// RrsetAdditionsPerChange: Maximum allowed number of ResourceRecordSets
	// to add per ChangesCreateRequest.
	RrsetAdditionsPerChange int64 `json:"rrsetAdditionsPerChange,omitempty"`

	// RrsetDeletionsPerChange: Maximum allowed number of ResourceRecordSets
	// to delete per ChangesCreateRequest.
	RrsetDeletionsPerChange int64 `json:"rrsetDeletionsPerChange,omitempty"`

	// RrsetsPerManagedZone: Maximum allowed number of ResourceRecordSets
	// per zone in the project.
	RrsetsPerManagedZone int64 `json:"rrsetsPerManagedZone,omitempty"`

	// TotalRrdataSizePerChange: Maximum allowed size for total rrdata in
	// one ChangesCreateRequest in bytes.
	TotalRrdataSizePerChange int64 `json:"totalRrdataSizePerChange,omitempty"`
}

Quota: Limits associated with a Project.

type ResourceRecordSet 

type ResourceRecordSet struct {
	// Kind: Identifies what kind of resource this is. Value: the fixed
	// string "dns#resourceRecordSet".
	Kind string `json:"kind,omitempty"`

	// Name: For example, www.example.com.
	Name string `json:"name,omitempty"`

	// Rrdatas: As defined in RFC 1035 (section 5) and RFC 1034 (section
	// 3.6.1).
	Rrdatas []string `json:"rrdatas,omitempty"`

	// Ttl: Number of seconds that this ResourceRecordSet can be cached by
	// resolvers.
	Ttl int64 `json:"ttl,omitempty"`

	// Type: The identifier of a supported record type, for example, A,
	// AAAA, MX, TXT, and so on.
	Type string `json:"type,omitempty"`
}

ResourceRecordSet: A unit of data that will be returned by the DNS servers.

type ResourceRecordSetsListCall 

type ResourceRecordSetsListCall struct {
	// contains filtered or unexported fields
}

func (*ResourceRecordSetsListCall) Do 

func (c *ResourceRecordSetsListCall) Do() (*ResourceRecordSetsListResponse, error)

func (*ResourceRecordSetsListCall) Fields 

func (c *ResourceRecordSetsListCall) Fields(s ...googleapi.Field) *ResourceRecordSetsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ResourceRecordSetsListCall) MaxResults 

func (c *ResourceRecordSetsListCall) MaxResults(maxResults int64) *ResourceRecordSetsListCall

MaxResults sets the optional parameter "maxResults": Maximum number of results to be returned. If unspecified, the server will decide how many results to return.

func (*ResourceRecordSetsListCall) Name 

func (c *ResourceRecordSetsListCall) Name(name string) *ResourceRecordSetsListCall

Name sets the optional parameter "name": Restricts the list to return only records with this fully qualified domain name.

func (*ResourceRecordSetsListCall) PageToken 

func (c *ResourceRecordSetsListCall) PageToken(pageToken string) *ResourceRecordSetsListCall

PageToken sets the optional parameter "pageToken": A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.

func (*ResourceRecordSetsListCall) Type 

func (c *ResourceRecordSetsListCall) Type(type_ string) *ResourceRecordSetsListCall

Type sets the optional parameter "type": Restricts the list to return only records of this type. If present, the "name" parameter must also be present.

type ResourceRecordSetsListResponse 

type ResourceRecordSetsListResponse struct {
	// Kind: Type of resource.
	Kind string `json:"kind,omitempty"`

	// NextPageToken: The presence of this field indicates that there exist
	// more results following your last page of results in pagination order.
	// To fetch them, make another list request using this value as your
	// pagination token.
	//
	// In this way you can retrieve the complete contents of even very large
	// collections one page at a time. However, if the contents of the
	// collection change between the first and last paginated list request,
	// the set of all elements returned will be an inconsistent view of the
	// collection. There is no way to retrieve a consistent snapshot of a
	// collection larger than the maximum page size.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Rrsets: The resource record set resources.
	Rrsets []*ResourceRecordSet `json:"rrsets,omitempty"`
}

type ResourceRecordSetsService 

type ResourceRecordSetsService struct {
	// contains filtered or unexported fields
}

func NewResourceRecordSetsService 

func NewResourceRecordSetsService(s *Service) *ResourceRecordSetsService

func (*ResourceRecordSetsService) List 

func (r *ResourceRecordSetsService) List(project string, managedZone string) *ResourceRecordSetsListCall

List: Enumerate ResourceRecordSets that have been created but not yet deleted.

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Changes *ChangesService

	ManagedZones *ManagedZonesService

	Projects *ProjectsService

	ResourceRecordSets *ResourceRecordSetsService
	// contains filtered or unexported fields
}

func New 

func New(client *http.Client) (*Service, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.