Module api

Module api 

Source

Structs§

Change
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.
ChangeCreateCall
Atomically updates the ResourceRecordSet collection.
ChangeGetCall
Fetches the representation of an existing Change.
ChangeListCall
Enumerates Changes to a ResourceRecordSet collection.
ChangeMethods
A builder providing access to all methods supported on change resources. It is not used directly, but through the Dns hub.
ChangesListResponse
The response to a request to enumerate Changes to a ResourceRecordSets collection.
Dns
Central instance to access all Dns related resource activities
DnsKey
A DNSSEC key pair.
DnsKeyDigest
There is no detailed description.
DnsKeyGetCall
Fetches the representation of an existing DnsKey.
DnsKeyListCall
Enumerates DnsKeys to a ResourceRecordSet collection.
DnsKeyMethods
A builder providing access to all methods supported on dnsKey resources. It is not used directly, but through the Dns hub.
DnsKeySpec
Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
DnsKeysListResponse
The response to a request to enumerate DnsKeys in a ManagedZone.
Expr
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.
GoogleIamV1AuditConfig
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.
GoogleIamV1AuditLogConfig
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.
GoogleIamV1Binding
Associates members, or principals, with a role.
GoogleIamV1GetIamPolicyRequest
Request message for GetIamPolicy method.
GoogleIamV1GetPolicyOptions
Encapsulates settings provided to GetIamPolicy.
GoogleIamV1Policy
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.
GoogleIamV1SetIamPolicyRequest
Request message for SetIamPolicy method.
GoogleIamV1TestIamPermissionsRequest
Request message for TestIamPermissions method.
GoogleIamV1TestIamPermissionsResponse
Response message for TestIamPermissions method.
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.
ManagedZoneCloudLoggingConfig
Cloud Logging configurations for publicly visible zones.
ManagedZoneCreateCall
Creates a new ManagedZone.
ManagedZoneDeleteCall
Deletes a previously created ManagedZone.
ManagedZoneDnsSecConfig
There is no detailed description.
ManagedZoneForwardingConfig
There is no detailed description.
ManagedZoneForwardingConfigNameServerTarget
There is no detailed description.
ManagedZoneGetCall
Fetches the representation of an existing ManagedZone.
ManagedZoneGetIamPolicyCall
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ManagedZoneListCall
Enumerates ManagedZones that have been created but not yet deleted.
ManagedZoneMethods
A builder providing access to all methods supported on managedZone resources. It is not used directly, but through the Dns hub.
ManagedZoneOperationGetCall
Fetches the representation of an existing Operation.
ManagedZoneOperationListCall
Enumerates Operations for the given ManagedZone.
ManagedZoneOperationMethods
A builder providing access to all methods supported on managedZoneOperation resources. It is not used directly, but through the Dns hub.
ManagedZoneOperationsListResponse
There is no detailed description.
ManagedZonePatchCall
Applies a partial update to an existing ManagedZone.
ManagedZonePeeringConfig
There is no detailed description.
ManagedZonePeeringConfigTargetNetwork
There is no detailed description.
ManagedZonePrivateVisibilityConfig
There is no detailed description.
ManagedZonePrivateVisibilityConfigGKECluster
There is no detailed description.
ManagedZonePrivateVisibilityConfigNetwork
There is no detailed description.
ManagedZoneReverseLookupConfig
There is no detailed description.
ManagedZoneServiceDirectoryConfig
Contains information about Service Directory-backed zones.
ManagedZoneServiceDirectoryConfigNamespace
There is no detailed description.
ManagedZoneSetIamPolicyCall
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ManagedZoneTestIamPermissionCall
Returns permissions that a caller has on the specified resource. If the resource does not exist, this returns an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.
ManagedZoneUpdateCall
Updates an existing ManagedZone.
ManagedZonesListResponse
There is no detailed description.
Operation
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.
OperationDnsKeyContext
There is no detailed description.
OperationManagedZoneContext
There is no detailed description.
PoliciesListResponse
There is no detailed description.
PoliciesPatchResponse
There is no detailed description.
PoliciesUpdateResponse
There is no detailed description.
Policy
A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
PolicyAlternativeNameServerConfig
There is no detailed description.
PolicyAlternativeNameServerConfigTargetNameServer
There is no detailed description.
PolicyCreateCall
Creates a new policy.
PolicyDeleteCall
Deletes a previously created policy. Fails if the policy is still being referenced by a network.
PolicyDns64Config
DNS64 policies
PolicyDns64ConfigScope
There is no detailed description.
PolicyGetCall
Fetches the representation of an existing policy.
PolicyListCall
Enumerates all policies associated with a project.
PolicyMethods
A builder providing access to all methods supported on policy resources. It is not used directly, but through the Dns hub.
PolicyNetwork
There is no detailed description.
PolicyPatchCall
Applies a partial update to an existing policy.
PolicyUpdateCall
Updates an existing policy.
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.
ProjectGetCall
Fetches the representation of an existing Project.
ProjectMethods
A builder providing access to all methods supported on project resources. It is not used directly, but through the Dns hub.
Quota
Limits associated with a Project.
RRSetRoutingPolicy
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.
RRSetRoutingPolicyGeoPolicy
Configures a RRSetRoutingPolicy that routes based on the geo location of the querying user.
RRSetRoutingPolicyGeoPolicyGeoPolicyItem
ResourceRecordSet data for one geo location.
RRSetRoutingPolicyHealthCheckTargets
HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. Set either internal_load_balancer or external_endpoints. Do not set both.
RRSetRoutingPolicyLoadBalancerTarget
The configuration for an individual load balancer to health check.
RRSetRoutingPolicyPrimaryBackupPolicy
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.
RRSetRoutingPolicyWrrPolicy
Configures a RRSetRoutingPolicy that routes in a weighted round robin fashion.
RRSetRoutingPolicyWrrPolicyWrrPolicyItem
A routing block which contains the routing information for one WRR item.
ResourceRecordSet
A unit of data that is returned by the DNS servers.
ResourceRecordSetCreateCall
Creates a new ResourceRecordSet.
ResourceRecordSetDeleteCall
Deletes a previously created ResourceRecordSet.
ResourceRecordSetGetCall
Fetches the representation of an existing ResourceRecordSet.
ResourceRecordSetListCall
Enumerates ResourceRecordSets that you have created but not yet deleted.
ResourceRecordSetMethods
A builder providing access to all methods supported on resourceRecordSet resources. It is not used directly, but through the Dns hub.
ResourceRecordSetPatchCall
Applies a partial update to an existing ResourceRecordSet.
ResourceRecordSetsListResponse
There is no detailed description.
ResponsePoliciesListResponse
There is no detailed description.
ResponsePoliciesPatchResponse
There is no detailed description.
ResponsePoliciesUpdateResponse
There is no detailed description.
ResponsePolicy
A Response Policy is a collection of selectors that apply to queries made against one or more Virtual Private Cloud networks.
ResponsePolicyCreateCall
Creates a new Response Policy
ResponsePolicyDeleteCall
Deletes a previously created Response Policy. Fails if the response policy is non-empty or still being referenced by a network.
ResponsePolicyGKECluster
There is no detailed description.
ResponsePolicyGetCall
Fetches the representation of an existing Response Policy.
ResponsePolicyListCall
Enumerates all Response Policies associated with a project.
ResponsePolicyMethods
A builder providing access to all methods supported on responsePolicy resources. It is not used directly, but through the Dns hub.
ResponsePolicyNetwork
There is no detailed description.
ResponsePolicyPatchCall
Applies a partial update to an existing Response Policy.
ResponsePolicyRule
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.
ResponsePolicyRuleCreateCall
Creates a new Response Policy Rule.
ResponsePolicyRuleDeleteCall
Deletes a previously created Response Policy Rule.
ResponsePolicyRuleGetCall
Fetches the representation of an existing Response Policy Rule.
ResponsePolicyRuleListCall
Enumerates all Response Policy Rules associated with a project.
ResponsePolicyRuleLocalData
There is no detailed description.
ResponsePolicyRuleMethods
A builder providing access to all methods supported on responsePolicyRule resources. It is not used directly, but through the Dns hub.
ResponsePolicyRulePatchCall
Applies a partial update to an existing Response Policy Rule.
ResponsePolicyRuleUpdateCall
Updates an existing Response Policy Rule.
ResponsePolicyRulesListResponse
There is no detailed description.
ResponsePolicyRulesPatchResponse
There is no detailed description.
ResponsePolicyRulesUpdateResponse
There is no detailed description.
ResponsePolicyUpdateCall
Updates an existing Response Policy.

Enums§

Scope
Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.