View Source API Reference google_api_dns v0.29.0
Modules
API client metadata for GoogleApi.DNS.V1.
API calls for all endpoints tagged Changes.
API calls for all endpoints tagged DnsKeys.
API calls for all endpoints tagged ManagedZoneOperations.
API calls for all endpoints tagged ManagedZones.
API calls for all endpoints tagged Policies.
API calls for all endpoints tagged Projects.
API calls for all endpoints tagged ResourceRecordSets.
API calls for all endpoints tagged ResponsePolicies.
API calls for all endpoints tagged ResponsePolicyRules.
Handle Tesla connections for GoogleApi.DNS.V1.
A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence.
The response to a request to enumerate Changes to a ResourceRecordSets collection.
A DNSSEC key pair.
Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
The response to a request to enumerate DnsKeys in a ManagedZone.
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
Associates members, or principals, with a role.
Request message for GetIamPolicy method.
Encapsulates settings provided to GetIamPolicy.
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation.
Request message for SetIamPolicy method.
Request message for TestIamPermissions method.
Response message for TestIamPermissions method.
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.
Cloud Logging configurations for publicly visible zones.
Attributes
-
defaultKeySpecs(type:list(GoogleApi.DNS.V1.Model.DnsKeySpec.t), default:nil) - Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF. -
kind(type:String.t, default:dns#managedZoneDnsSecConfig) - -
nonExistence(type:String.t, default:nil) - Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF. -
state(type:String.t, default:nil) - Specifies whether DNSSEC is enabled, and what mode it is in.
Attributes
-
kind(type:String.t, default:dns#managedZoneForwardingConfig) - -
targetNameServers(type:list(GoogleApi.DNS.V1.Model.ManagedZoneForwardingConfigNameServerTarget.t), default:nil) - List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
Attributes
-
forwardingPath(type:String.t, default:nil) - Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on IP address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target. -
ipv4Address(type:String.t, default:nil) - IPv4 address of a target name server. -
ipv6Address(type:String.t, default:nil) - IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022. -
kind(type:String.t, default:dns#managedZoneForwardingConfigNameServerTarget) -
Attributes
-
header(type:GoogleApi.DNS.V1.Model.ResponseHeader.t, default:nil) - -
kind(type:String.t, default:dns#managedZoneOperationsListResponse) - Type of resource. -
nextPageToken(type:String.t, default:nil) - 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. This lets you 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 are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size. -
operations(type:list(GoogleApi.DNS.V1.Model.Operation.t), default:nil) - The operation resources.
Attributes
-
deactivateTime(type:String.t, default:nil) - The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only. -
kind(type:String.t, default:dns#managedZonePeeringConfigTargetNetwork) - -
networkUrl(type:String.t, default:nil) - The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
Attributes
-
gkeClusters(type:list(GoogleApi.DNS.V1.Model.ManagedZonePrivateVisibilityConfigGKECluster.t), default:nil) - The list of Google Kubernetes Engine clusters that can see this zone. -
kind(type:String.t, default:dns#managedZonePrivateVisibilityConfig) - -
networks(type:list(GoogleApi.DNS.V1.Model.ManagedZonePrivateVisibilityConfigNetwork.t), default:nil) - The list of VPC networks that can see this zone.
Attributes
-
gkeClusterName(type:String.t, default:nil) - The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects//locations//clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get -
kind(type:String.t, default:dns#managedZonePrivateVisibilityConfigGKECluster) -
Attributes
-
kind(type:String.t, default:dns#managedZonePrivateVisibilityConfigNetwork) - -
networkUrl(type:String.t, default:nil) - The fully qualified URL of the VPC network to bind to. Format this URL like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
Contains information about Service Directory-backed zones.
Attributes
-
deletionTime(type:String.t, default:nil) - The time that the namespace backing this zone was deleted; an empty string if it still exists. This is in RFC3339 text format. Output only. -
kind(type:String.t, default:dns#managedZoneServiceDirectoryConfigNamespace) - -
namespaceUrl(type:String.t, default:nil) - The fully qualified URL of the namespace associated with the zone. Format must be https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}
Attributes
-
header(type:GoogleApi.DNS.V1.Model.ResponseHeader.t, default:nil) - -
kind(type:String.t, default:dns#managedZonesListResponse) - Type of resource. -
managedZones(type:list(GoogleApi.DNS.V1.Model.ManagedZone.t), default:nil) - The managed zone resources. -
nextPageToken(type:String.t, default:nil) - 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. This lets you 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 are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size.
An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id.
Attributes
-
header(type:GoogleApi.DNS.V1.Model.ResponseHeader.t, default:nil) - -
kind(type:String.t, default:dns#policiesListResponse) - Type of resource. -
nextPageToken(type:String.t, default:nil) - 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. This lets you 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 are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size. -
policies(type:list(GoogleApi.DNS.V1.Model.Policy.t), default:nil) - The policy resources.
A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
Attributes
-
kind(type:String.t, default:dns#policyAlternativeNameServerConfig) - -
targetNameServers(type:list(GoogleApi.DNS.V1.Model.PolicyAlternativeNameServerConfigTargetNameServer.t), default:nil) - Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
Attributes
-
forwardingPath(type:String.t, default:nil) - Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS makes forwarding decisions based on address ranges; that is, RFC1918 addresses go to the VPC network, non-RFC1918 addresses go to the internet. When set to PRIVATE, Cloud DNS always sends queries through the VPC network for this target. -
ipv4Address(type:String.t, default:nil) - IPv4 address to forward queries to. -
ipv6Address(type:String.t, default:nil) - IPv6 address to forward to. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022. -
kind(type:String.t, default:dns#policyAlternativeNameServerConfigTargetNameServer) -
Attributes
-
kind(type:String.t, default:dns#policyNetwork) - -
networkUrl(type:String.t, default:nil) - The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
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. Next tag: 7.
Limits associated with a Project.
A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection.
Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user.
ResourceRecordSet data for one geo location.
HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Only one of internal_load_balancer and external_endpoints should be set.
The configuration for an individual load balancer to health check.
Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy.
Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion.
A routing block which contains the routing information for one WRR item.
A unit of data that is returned by the DNS servers.
Attributes
-
header(type:GoogleApi.DNS.V1.Model.ResponseHeader.t, default:nil) - -
kind(type:String.t, default:dns#resourceRecordSetsListResponse) - Type of resource. -
nextPageToken(type:String.t, default:nil) - 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. This lets you retrieve the complete contents of even larger collections, one page at a time. However, if the collection changes between paginated list requests, the set of elements returned is an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size. -
rrsets(type:list(GoogleApi.DNS.V1.Model.ResourceRecordSet.t), default:nil) - The resource record set resources.
Elements common to every response.
Attributes
-
header(type:GoogleApi.DNS.V1.Model.ResponseHeader.t, default:nil) - -
nextPageToken(type:String.t, default:nil) - The presence of this field indicates that more results exist following your last page of results in pagination order. To fetch them, make another list request by using this value as your page token. This lets you view 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 are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size. -
responsePolicies(type:list(GoogleApi.DNS.V1.Model.ResponsePolicy.t), default:nil) - The Response Policy resources.
A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
Attributes
-
gkeClusterName(type:String.t, default:nil) - The resource name of the cluster to bind this response policy to. This should be specified in the format like: projects//locations//clusters/*. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get -
kind(type:String.t, default:dns#responsePolicyGKECluster) -
Attributes
-
kind(type:String.t, default:dns#responsePolicyNetwork) - -
networkUrl(type:String.t, default:nil) - The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
A Response Policy Rule is a selector that applies its behavior to queries that match the selector. Selectors are DNS names, which may be wildcards or exact matches. Each DNS query subject to a Response Policy matches at most one ResponsePolicyRule, as identified by the dns_name field with the longest matching suffix.
Attributes
-
header(type:GoogleApi.DNS.V1.Model.ResponseHeader.t, default:nil) - -
nextPageToken(type:String.t, default:nil) - 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. This lets you 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 are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size. -
responsePolicyRules(type:list(GoogleApi.DNS.V1.Model.ResponsePolicyRule.t), default:nil) - The Response Policy Rule resources.