Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Configures and serves authoritative DNS records.
- dNSService :: ServiceConfig
- ndevClouddnsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/ndev.clouddns.readonly"]
- cloudPlatformReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform.read-only"]
- ndevClouddnsReadwriteScope :: Proxy '["https://www.googleapis.com/auth/ndev.clouddns.readwrite"]
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- type DNSAPI = ChangesListResource :<|> (ChangesGetResource :<|> (ChangesCreateResource :<|> (ResourceRecordSetsListResource :<|> (ManagedZonesListResource :<|> (ManagedZonesGetResource :<|> (ManagedZonesCreateResource :<|> (ManagedZonesDeleteResource :<|> ProjectsGetResource)))))))
- module Network.Google.Resource.DNS.Changes.Create
- module Network.Google.Resource.DNS.Changes.Get
- module Network.Google.Resource.DNS.Changes.List
- module Network.Google.Resource.DNS.ManagedZones.Create
- module Network.Google.Resource.DNS.ManagedZones.Delete
- module Network.Google.Resource.DNS.ManagedZones.Get
- module Network.Google.Resource.DNS.ManagedZones.List
- module Network.Google.Resource.DNS.Projects.Get
- module Network.Google.Resource.DNS.ResourceRecordSets.List
- data ChangesListResponse
- changesListResponse :: ChangesListResponse
- clrNextPageToken :: Lens' ChangesListResponse (Maybe Text)
- clrChanges :: Lens' ChangesListResponse [Change]
- clrKind :: Lens' ChangesListResponse Text
- data Project
- project :: Project
- pKind :: Lens' Project Text
- pId :: Lens' Project (Maybe Text)
- pNumber :: Lens' Project (Maybe Word64)
- pQuota :: Lens' Project (Maybe Quota)
- data ChangesListSortBy = ChangeSequence
- data Change
- change :: Change
- cStatus :: Lens' Change (Maybe ChangeStatus)
- cAdditions :: Lens' Change [ResourceRecordSet]
- cStartTime :: Lens' Change (Maybe Text)
- cKind :: Lens' Change Text
- cDeletions :: Lens' Change [ResourceRecordSet]
- cId :: Lens' Change (Maybe Text)
- data ResourceRecordSetsListResponse
- resourceRecordSetsListResponse :: ResourceRecordSetsListResponse
- rrslrNextPageToken :: Lens' ResourceRecordSetsListResponse (Maybe Text)
- rrslrKind :: Lens' ResourceRecordSetsListResponse Text
- rrslrRrSets :: Lens' ResourceRecordSetsListResponse [ResourceRecordSet]
- data ChangeStatus
- data ResourceRecordSet
- resourceRecordSet :: ResourceRecordSet
- rrsTtl :: Lens' ResourceRecordSet (Maybe Int32)
- rrsKind :: Lens' ResourceRecordSet Text
- rrsName :: Lens' ResourceRecordSet (Maybe Text)
- rrsType :: Lens' ResourceRecordSet (Maybe Text)
- rrsRrDatas :: Lens' ResourceRecordSet [Text]
- data ManagedZone
- managedZone :: ManagedZone
- mzCreationTime :: Lens' ManagedZone (Maybe Text)
- mzKind :: Lens' ManagedZone Text
- mzNameServerSet :: Lens' ManagedZone (Maybe Text)
- mzName :: Lens' ManagedZone (Maybe Text)
- mzId :: Lens' ManagedZone (Maybe Word64)
- mzDNSName :: Lens' ManagedZone (Maybe Text)
- mzDescription :: Lens' ManagedZone (Maybe Text)
- mzNameServers :: Lens' ManagedZone [Text]
- data Quota
- quota :: Quota
- qRrSetDeletionsPerChange :: Lens' Quota (Maybe Int32)
- qRrSetsPerManagedZone :: Lens' Quota (Maybe Int32)
- qKind :: Lens' Quota Text
- qResourceRecordsPerRrSet :: Lens' Quota (Maybe Int32)
- qRrSetAdditionsPerChange :: Lens' Quota (Maybe Int32)
- qManagedZones :: Lens' Quota (Maybe Int32)
- qTotalRrDataSizePerChange :: Lens' Quota (Maybe Int32)
- data ManagedZonesListResponse
- managedZonesListResponse :: ManagedZonesListResponse
- mzlrNextPageToken :: Lens' ManagedZonesListResponse (Maybe Text)
- mzlrKind :: Lens' ManagedZonesListResponse Text
- mzlrManagedZones :: Lens' ManagedZonesListResponse [ManagedZone]
Service Configuration
dNSService :: ServiceConfig Source #
Default request referring to version v1
of the Google Cloud DNS API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
ndevClouddnsReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/ndev.clouddns.readonly"] Source #
View your DNS records hosted by Google Cloud DNS
cloudPlatformReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform.read-only"] Source #
View your data across Google Cloud Platform services
ndevClouddnsReadwriteScope :: Proxy '["https://www.googleapis.com/auth/ndev.clouddns.readwrite"] Source #
View and manage your DNS records hosted by Google Cloud DNS
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] Source #
View and manage your data across Google Cloud Platform services
API Declaration
type DNSAPI = ChangesListResource :<|> (ChangesGetResource :<|> (ChangesCreateResource :<|> (ResourceRecordSetsListResource :<|> (ManagedZonesListResource :<|> (ManagedZonesGetResource :<|> (ManagedZonesCreateResource :<|> (ManagedZonesDeleteResource :<|> ProjectsGetResource))))))) Source #
Represents the entirety of the methods and resources available for the Google Cloud DNS API service.
Resources
dns.changes.create
dns.changes.get
dns.changes.list
dns.managedZones.create
dns.managedZones.delete
dns.managedZones.get
dns.managedZones.list
dns.projects.get
dns.resourceRecordSets.list
Types
ChangesListResponse
data ChangesListResponse Source #
The response to a request to enumerate Changes to a ResourceRecordSets collection.
See: changesListResponse
smart constructor.
changesListResponse :: ChangesListResponse Source #
Creates a value of ChangesListResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
clrNextPageToken :: Lens' ChangesListResponse (Maybe Text) Source #
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.
clrChanges :: Lens' ChangesListResponse [Change] Source #
The requested changes.
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.
See: project
smart constructor.
pKind :: Lens' Project Text Source #
Identifies what kind of resource this is. Value: the fixed string "dns#project".
pId :: Lens' Project (Maybe Text) Source #
User assigned unique identifier for the resource (output only).
pNumber :: Lens' Project (Maybe Word64) Source #
Unique numeric identifier for the resource; defined by the server (output only).
ChangesListSortBy
data ChangesListSortBy Source #
Sorting criterion. The only supported value is change sequence.
ChangeSequence | changeSequence |
Change
An atomic update to a collection of ResourceRecordSets.
See: change
smart constructor.
Creates a value of Change
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cAdditions :: Lens' Change [ResourceRecordSet] Source #
Which ResourceRecordSets to add?
cStartTime :: Lens' Change (Maybe Text) Source #
The time that this operation was started by the server (output only). This is in RFC3339 text format.
cKind :: Lens' Change Text Source #
Identifies what kind of resource this is. Value: the fixed string "dns#change".
cDeletions :: Lens' Change [ResourceRecordSet] Source #
Which ResourceRecordSets to remove? Must match existing data exactly.
cId :: Lens' Change (Maybe Text) Source #
Unique identifier for the resource; defined by the server (output only).
ResourceRecordSetsListResponse
data ResourceRecordSetsListResponse Source #
resourceRecordSetsListResponse :: ResourceRecordSetsListResponse Source #
Creates a value of ResourceRecordSetsListResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrslrNextPageToken :: Lens' ResourceRecordSetsListResponse (Maybe Text) Source #
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.
rrslrRrSets :: Lens' ResourceRecordSetsListResponse [ResourceRecordSet] Source #
The resource record set resources.
ChangeStatus
data ChangeStatus Source #
Status of the operation (output only).
ResourceRecordSet
data ResourceRecordSet Source #
A unit of data that will be returned by the DNS servers.
See: resourceRecordSet
smart constructor.
resourceRecordSet :: ResourceRecordSet Source #
Creates a value of ResourceRecordSet
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrsTtl :: Lens' ResourceRecordSet (Maybe Int32) Source #
Number of seconds that this ResourceRecordSet can be cached by resolvers.
rrsKind :: Lens' ResourceRecordSet Text Source #
Identifies what kind of resource this is. Value: the fixed string "dns#resourceRecordSet".
rrsType :: Lens' ResourceRecordSet (Maybe Text) Source #
The identifier of a supported record type, for example, A, AAAA, MX, TXT, and so on.
rrsRrDatas :: Lens' ResourceRecordSet [Text] Source #
As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
ManagedZone
data ManagedZone Source #
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.
See: managedZone
smart constructor.
managedZone :: ManagedZone Source #
Creates a value of ManagedZone
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mzCreationTime :: Lens' ManagedZone (Maybe Text) Source #
The time that this resource was created on the server. This is in RFC3339 text format. Output only.
mzKind :: Lens' ManagedZone Text Source #
Identifies what kind of resource this is. Value: the fixed string "dns#managedZone".
mzNameServerSet :: Lens' ManagedZone (Maybe Text) Source #
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.
mzName :: Lens' ManagedZone (Maybe Text) Source #
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.
mzId :: Lens' ManagedZone (Maybe Word64) Source #
Unique identifier for the resource; defined by the server (output only)
mzDNSName :: Lens' ManagedZone (Maybe Text) Source #
The DNS name of this managed zone, for instance "example.com.".
mzDescription :: Lens' ManagedZone (Maybe Text) Source #
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.
mzNameServers :: Lens' ManagedZone [Text] Source #
Delegate your managed_zone to these virtual name servers; defined by the server (output only)
Quota
Limits associated with a Project.
See: quota
smart constructor.
Creates a value of Quota
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qRrSetDeletionsPerChange :: Lens' Quota (Maybe Int32) Source #
Maximum allowed number of ResourceRecordSets to delete per ChangesCreateRequest.
qRrSetsPerManagedZone :: Lens' Quota (Maybe Int32) Source #
Maximum allowed number of ResourceRecordSets per zone in the project.
qKind :: Lens' Quota Text Source #
Identifies what kind of resource this is. Value: the fixed string "dns#quota".
qResourceRecordsPerRrSet :: Lens' Quota (Maybe Int32) Source #
Maximum allowed number of ResourceRecords per ResourceRecordSet.
qRrSetAdditionsPerChange :: Lens' Quota (Maybe Int32) Source #
Maximum allowed number of ResourceRecordSets to add per ChangesCreateRequest.
qManagedZones :: Lens' Quota (Maybe Int32) Source #
Maximum allowed number of managed zones in the project.
qTotalRrDataSizePerChange :: Lens' Quota (Maybe Int32) Source #
Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes.
ManagedZonesListResponse
managedZonesListResponse :: ManagedZonesListResponse Source #
Creates a value of ManagedZonesListResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mzlrNextPageToken :: Lens' ManagedZonesListResponse (Maybe Text) Source #
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.
mzlrManagedZones :: Lens' ManagedZonesListResponse [ManagedZone] Source #
The managed zone resources.