@googleapis/dns
Version:
863 lines • 248 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace dns_v1beta2 {
export interface Options extends GlobalOptions {
version: 'v1beta2';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud DNS API
*
*
*
* @example
* ```js
* const {google} = require('googleapis');
* const dns = google.dns('v1beta2');
* ```
*/
export class Dns {
context: APIRequestContext;
changes: Resource$Changes;
dnsKeys: Resource$Dnskeys;
managedZoneOperations: Resource$Managedzoneoperations;
managedZones: Resource$Managedzones;
policies: Resource$Policies;
projects: Resource$Projects;
resourceRecordSets: Resource$Resourcerecordsets;
responsePolicies: Resource$Responsepolicies;
responsePolicyRules: Resource$Responsepolicyrules;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* 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.
*/
export interface Schema$Change {
/**
* Which ResourceRecordSets to add?
*/
additions?: Schema$ResourceRecordSet[];
/**
* Which ResourceRecordSets to remove? Must match existing data exactly.
*/
deletions?: Schema$ResourceRecordSet[];
/**
* Unique identifier for the resource; defined by the server (output only).
*/
id?: string | null;
/**
* If the DNS queries for the zone will be served.
*/
isServing?: boolean | null;
kind?: string | null;
/**
* The time that this operation was started by the server (output only). This is in RFC3339 text format.
*/
startTime?: string | null;
/**
* Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet.
*/
status?: string | null;
}
/**
* The response to a request to enumerate Changes to a ResourceRecordSets collection.
*/
export interface Schema$ChangesListResponse {
/**
* The requested changes.
*/
changes?: Schema$Change[];
/**
* Type of resource.
*/
kind?: string | null;
/**
* This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection 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 can't retrieve a consistent snapshot of a collection larger than the maximum page size.
*/
nextPageToken?: string | null;
}
/**
* A DNSSEC key pair.
*/
export interface Schema$DnsKey {
/**
* String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
*/
algorithm?: string | null;
/**
* The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
*/
creationTime?: string | null;
/**
* A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
*/
description?: string | null;
/**
* Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
*/
digests?: Schema$DnsKeyDigest[];
/**
* Unique identifier for the resource; defined by the server (output only).
*/
id?: string | null;
/**
* Active keys are used to sign subsequent changes to the ManagedZone. Inactive keys are still present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
*/
isActive?: boolean | null;
/**
* Length of the key in bits. Specified at creation time, and then immutable.
*/
keyLength?: number | null;
/**
* The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
*/
keyTag?: number | null;
kind?: string | null;
/**
* Base64 encoded public half of this key. Output only.
*/
publicKey?: string | null;
/**
* One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, are used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag is cleared, and this key is used to sign only resource record sets of other types. Immutable after creation time.
*/
type?: string | null;
}
export interface Schema$DnsKeyDigest {
/**
* The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
*/
digest?: string | null;
/**
* Specifies the algorithm used to calculate this digest.
*/
type?: string | null;
}
/**
* The response to a request to enumerate DnsKeys in a ManagedZone.
*/
export interface Schema$DnsKeysListResponse {
/**
* The requested resources.
*/
dnsKeys?: Schema$DnsKey[];
/**
* Type of resource.
*/
kind?: string | null;
/**
* This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection 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 can't retrieve a consistent snapshot of a collection larger than the maximum page size.
*/
nextPageToken?: string | null;
}
/**
* Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
*/
export interface Schema$DnsKeySpec {
/**
* String mnemonic specifying the DNSSEC algorithm of this key.
*/
algorithm?: string | null;
/**
* Length of the keys in bits.
*/
keyLength?: number | null;
/**
* Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, are only used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and are used to sign all other types of resource record sets.
*/
keyType?: string | null;
kind?: string | null;
}
/**
* 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.
*/
export interface Schema$Expr {
/**
* Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
*/
description?: string | null;
/**
* Textual representation of an expression in Common Expression Language syntax.
*/
expression?: string | null;
/**
* Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
*/
location?: string | null;
/**
* Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
*/
title?: string | null;
}
/**
* 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.
*/
export interface Schema$GoogleIamV1AuditConfig {
/**
* The configuration for logging of each type of permission.
*/
auditLogConfigs?: Schema$GoogleIamV1AuditLogConfig[];
/**
* Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
*/
service?: string | null;
}
/**
* 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.
*/
export interface Schema$GoogleIamV1AuditLogConfig {
/**
* Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
*/
exemptedMembers?: string[] | null;
/**
* The log type that this config enables.
*/
logType?: string | null;
}
/**
* Associates `members`, or principals, with a `role`.
*/
export interface Schema$GoogleIamV1Binding {
/**
* The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
condition?: Schema$Expr;
/**
* Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `deleted:user:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid\}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid\}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid\}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
*/
members?: string[] | null;
/**
* Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
*/
role?: string | null;
}
/**
* Request message for `GetIamPolicy` method.
*/
export interface Schema$GoogleIamV1GetIamPolicyRequest {
/**
* OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
*/
options?: Schema$GoogleIamV1GetPolicyOptions;
}
/**
* Encapsulates settings provided to GetIamPolicy.
*/
export interface Schema$GoogleIamV1GetPolicyOptions {
/**
* Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
requestedPolicyVersion?: number | null;
}
/**
* 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](https://cloud.google.com/iam/help/conditions/resource-policies). **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](https://cloud.google.com/iam/docs/).
*/
export interface Schema$GoogleIamV1Policy {
/**
* Specifies cloud audit logging configuration for this policy.
*/
auditConfigs?: Schema$GoogleIamV1AuditConfig[];
/**
* Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
*/
bindings?: Schema$GoogleIamV1Binding[];
/**
* `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
*/
etag?: string | null;
/**
* Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
version?: number | null;
}
/**
* Request message for `SetIamPolicy` method.
*/
export interface Schema$GoogleIamV1SetIamPolicyRequest {
/**
* REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
*/
policy?: Schema$GoogleIamV1Policy;
/**
* OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
*/
updateMask?: string | null;
}
/**
* Request message for `TestIamPermissions` method.
*/
export interface Schema$GoogleIamV1TestIamPermissionsRequest {
/**
* The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
*/
permissions?: string[] | null;
}
/**
* Response message for `TestIamPermissions` method.
*/
export interface Schema$GoogleIamV1TestIamPermissionsResponse {
/**
* A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
*/
permissions?: string[] | null;
}
/**
* 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.
*/
export interface Schema$ManagedZone {
cloudLoggingConfig?: Schema$ManagedZoneCloudLoggingConfig;
/**
* The time that this resource was created on the server. This is in RFC3339 text format. Output only.
*/
creationTime?: string | null;
/**
* 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 | null;
/**
* The DNS name of this managed zone, for instance "example.com.".
*/
dnsName?: string | null;
/**
* DNSSEC configuration.
*/
dnssecConfig?: Schema$ManagedZoneDnsSecConfig;
/**
* The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
*/
forwardingConfig?: Schema$ManagedZoneForwardingConfig;
/**
* Unique identifier for the resource; defined by the server (output only)
*/
id?: string | null;
kind?: string | null;
/**
* User labels.
*/
labels?: {
[key: string]: string;
} | null;
/**
* User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
*/
name?: string | null;
/**
* Delegate your managed_zone to these virtual name servers; defined by the server (output only)
*/
nameServers?: string[] | null;
/**
* Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
*/
nameServerSet?: string | null;
/**
* The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
*/
peeringConfig?: Schema$ManagedZonePeeringConfig;
/**
* For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
*/
privateVisibilityConfig?: Schema$ManagedZonePrivateVisibilityConfig;
/**
* The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
*/
reverseLookupConfig?: Schema$ManagedZoneReverseLookupConfig;
/**
* This field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
*/
serviceDirectoryConfig?: Schema$ManagedZoneServiceDirectoryConfig;
/**
* The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
*/
visibility?: string | null;
}
/**
* Cloud Logging configurations for publicly visible zones.
*/
export interface Schema$ManagedZoneCloudLoggingConfig {
/**
* If set, enable query logging for this ManagedZone. False by default, making logging opt-in.
*/
enableLogging?: boolean | null;
kind?: string | null;
}
export interface Schema$ManagedZoneDnsSecConfig {
/**
* Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
*/
defaultKeySpecs?: Schema$DnsKeySpec[];
kind?: string | null;
/**
* Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
*/
nonExistence?: string | null;
/**
* Specifies whether DNSSEC is enabled, and what mode it is in.
*/
state?: string | null;
}
export interface Schema$ManagedZoneForwardingConfig {
kind?: string | null;
/**
* List of target name servers to forward to. Cloud DNS selects the best available name server if more than one target is given.
*/
targetNameServers?: Schema$ManagedZoneForwardingConfigNameServerTarget[];
}
export interface Schema$ManagedZoneForwardingConfigNameServerTarget {
/**
* Fully qualified domain name for the forwarding target.
*/
domainName?: string | null;
/**
* 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.
*/
forwardingPath?: string | null;
/**
* IPv4 address of a target name server.
*/
ipv4Address?: string | null;
/**
* IPv6 address of a target name server. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022.
*/
ipv6Address?: string | null;
kind?: string | null;
}
export interface Schema$ManagedZoneOperationsListResponse {
/**
* Type of resource.
*/
kind?: string | null;
/**
* This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection 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 can't retrieve a consistent snapshot of a collection larger than the maximum page size.
*/
nextPageToken?: string | null;
/**
* The operation resources.
*/
operations?: Schema$Operation[];
}
export interface Schema$ManagedZonePeeringConfig {
kind?: string | null;
/**
* The network with which to peer.
*/
targetNetwork?: Schema$ManagedZonePeeringConfigTargetNetwork;
}
export interface Schema$ManagedZonePeeringConfigTargetNetwork {
/**
* 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.
*/
deactivateTime?: string | null;
kind?: string | null;
/**
* 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\}`
*/
networkUrl?: string | null;
}
export interface Schema$ManagedZonePrivateVisibilityConfig {
/**
* The list of Google Kubernetes Engine clusters that can see this zone.
*/
gkeClusters?: Schema$ManagedZonePrivateVisibilityConfigGKECluster[];
kind?: string | null;
/**
* The list of VPC networks that can see this zone.
*/
networks?: Schema$ManagedZonePrivateVisibilityConfigNetwork[];
}
export interface Schema$ManagedZonePrivateVisibilityConfigGKECluster {
/**
* The resource name of the cluster to bind this ManagedZone to. This should be specified in the format like: projects/x/locations/x/clusters/x. This is referenced from GKE projects.locations.clusters.get API: https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/get
*/
gkeClusterName?: string | null;
kind?: string | null;
}
export interface Schema$ManagedZonePrivateVisibilityConfigNetwork {
kind?: string | null;
/**
* 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\}`
*/
networkUrl?: string | null;
}
export interface Schema$ManagedZoneReverseLookupConfig {
kind?: string | null;
}
/**
* Contains information about Service Directory-backed zones.
*/
export interface Schema$ManagedZoneServiceDirectoryConfig {
kind?: string | null;
/**
* Contains information about the namespace associated with the zone.
*/
namespace?: Schema$ManagedZoneServiceDirectoryConfigNamespace;
}
export interface Schema$ManagedZoneServiceDirectoryConfigNamespace {
/**
* 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.
*/
deletionTime?: string | null;
kind?: string | null;
/**
* 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\}`
*/
namespaceUrl?: string | null;
}
export interface Schema$ManagedZonesListResponse {
/**
* Type of resource.
*/
kind?: string | null;
/**
* The managed zone resources.
*/
managedZones?: Schema$ManagedZone[];
/**
* This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection 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 can't retrieve a consistent snapshot of a collection larger than the maximum page size.
*/
nextPageToken?: string | null;
}
/**
* 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.
*/
export interface Schema$Operation {
/**
* Only populated if the operation targeted a DnsKey (output only).
*/
dnsKeyContext?: Schema$OperationDnsKeyContext;
/**
* Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only)
*/
id?: string | null;
kind?: string | null;
/**
* The time that this operation was started by the server. This is in RFC3339 text format (output only).
*/
startTime?: string | null;
/**
* Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only). A status of "DONE" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet.
*/
status?: string | null;
/**
* Type of the operation. Operations include insert, update, and delete (output only).
*/
type?: string | null;
/**
* User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only)
*/
user?: string | null;
/**
* Only populated if the operation targeted a ManagedZone (output only).
*/
zoneContext?: Schema$OperationManagedZoneContext;
}
export interface Schema$OperationDnsKeyContext {
/**
* The post-operation DnsKey resource.
*/
newValue?: Schema$DnsKey;
/**
* The pre-operation DnsKey resource.
*/
oldValue?: Schema$DnsKey;
}
export interface Schema$OperationManagedZoneContext {
/**
* The post-operation ManagedZone resource.
*/
newValue?: Schema$ManagedZone;
/**
* The pre-operation ManagedZone resource.
*/
oldValue?: Schema$ManagedZone;
}
export interface Schema$PoliciesListResponse {
/**
* Type of resource.
*/
kind?: string | null;
/**
* This field indicates that more results are available beyond the last page displayed. To fetch the results, make another list request and use this value as your page token. This lets you retrieve the complete contents of a very large collection 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 can't retrieve a consistent snapshot of a collection larger than the maximum page size.
*/
nextPageToken?: string | null;
/**
* The policy resources.
*/
policies?: Schema$Policy[];
}
export interface Schema$PoliciesPatchResponse {
policy?: Schema$Policy;
}
export interface Schema$PoliciesUpdateResponse {
policy?: Schema$Policy;
}
/**
* A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
*/
export interface Schema$Policy {
/**
* 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.
*/
alternativeNameServerConfig?: Schema$PolicyAlternativeNameServerConfig;
/**
* A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.
*/
description?: string | null;
/**
* Configurations related to DNS64 for this policy.
*/
dns64Config?: Schema$PolicyDns64Config;
/**
* Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address is allocated from each of the subnetworks that are bound to this policy.
*/
enableInboundForwarding?: boolean | null;
/**
* Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
*/
enableLogging?: boolean | null;
/**
* Unique identifier for the resource; defined by the server (output only).
*/
id?: string | null;
kind?: string | null;
/**
* User-assigned name for this policy.
*/
name?: string | null;
/**
* List of network names specifying networks to which this policy is applied.
*/
networks?: Schema$PolicyNetwork[];
}
export interface Schema$PolicyAlternativeNameServerConfig {
kind?: string | null;
/**
* 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.
*/
targetNameServers?: Schema$PolicyAlternativeNameServerConfigTargetNameServer[];
}
export interface Schema$PolicyAlternativeNameServerConfigTargetNameServer {
/**
* 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.
*/
forwardingPath?: string | null;
/**
* IPv4 address to forward queries to.
*/
ipv4Address?: string | null;
/**
* IPv6 address to forward to. Does not accept both fields (ipv4 & ipv6) being populated. Public preview as of November 2022.
*/
ipv6Address?: string | null;
kind?: string | null;
}
/**
* DNS64 policies
*/
export interface Schema$PolicyDns64Config {
kind?: string | null;
/**
* The scope to which DNS64 config will be applied to.
*/
scope?: Schema$PolicyDns64ConfigScope;
}
export interface Schema$PolicyDns64ConfigScope {
/**
* Controls whether DNS64 is enabled globally for all networks bound to the policy.
*/
allQueries?: boolean | null;
kind?: string | null;
}
export interface Schema$PolicyNetwork {
kind?: string | null;
/**
* 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\}
*/
networkUrl?: string | null;
}
/**
* 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.
*/
export interface Schema$Project {
/**
* User assigned unique identifier for the resource (output only).
*/
id?: string | null;
kind?: string | null;
/**
* Unique numeric identifier for the resource; defined by the server (output only).
*/
number?: string | null;
/**
* Quotas assigned to this project (output only).
*/
quota?: Schema$Quota;
}
/**
* Limits associated with a Project.
*/
export interface Schema$Quota {
/**
* Maximum allowed number of DnsKeys per ManagedZone.
*/
dnsKeysPerManagedZone?: number | null;
/**
* Maximum allowed number of GKE clusters to which a privately scoped zone can be attached.
*/
gkeClustersPerManagedZone?: number | null;
/**
* Maximum allowed number of GKE clusters per policy.
*/
gkeClustersPerPolicy?: number | null;
/**
* Maximum allowed number of GKE clusters per response policy.
*/
gkeClustersPerResponsePolicy?: number | null;
internetHealthChecksPerManagedZone?: number | null;
/**
* Maximum allowed number of items per routing policy.
*/
itemsPerRoutingPolicy?: number | null;
kind?: string | null;
/**
* Maximum allowed number of managed zones in the project.
*/
managedZones?: number | null;
/**
* Maximum allowed number of managed zones which can be attached to a GKE cluster.
*/
managedZonesPerGkeCluster?: number | null;
/**
* Maximum allowed number of managed zones which can be attached to a network.
*/
managedZonesPerNetwork?: number | null;
/**
* Maximum number of nameservers per delegation, meant to prevent abuse
*/
nameserversPerDelegation?: number | null;
/**
* Maximum allowed number of networks to which a privately scoped zone can be attached.
*/
networksPerManagedZone?: number | null;
/**
* Maximum allowed number of networks per policy.
*/
networksPerPolicy?: number | null;
/**
* Maximum allowed number of networks per response policy.
*/
networksPerResponsePolicy?: number | null;
/**
* Maximum allowed number of consumer peering zones per target network owned by this producer project
*/
peeringZonesPerTargetNetwork?: number | null;
/**
* Maximum allowed number of policies per project.
*/
policies?: number | null;
/**
* Maximum allowed number of ResourceRecords per ResourceRecordSet.
*/
resourceRecordsPerRrset?: number | null;
/**
* Maximum allowed number of response policies per project.
*/
responsePolicies?: number | null;
/**
* Maximum allowed number of rules per response policy.
*/
responsePolicyRulesPerResponsePolicy?: number | null;
/**
* Maximum allowed number of ResourceRecordSets to add per ChangesCreateRequest.
*/
rrsetAdditionsPerChange?: number | null;
/**
* Maximum allowed number of ResourceRecordSets to delete per ChangesCreateRequest.
*/
rrsetDeletionsPerChange?: number | null;
/**
* Maximum allowed number of ResourceRecordSets per zone in the project.
*/
rrsetsPerManagedZone?: number | null;
/**
* Maximum allowed number of target name servers per managed forwarding zone.
*/
targetNameServersPerManagedZone?: number | null;
/**
* Maximum allowed number of alternative target name servers per policy.
*/
targetNameServersPerPolicy?: number | null;
/**
* Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes.
*/
totalRrdataSizePerChange?: number | null;
/**
* DNSSEC algorithm and key length types that can be used for DnsKeys.
*/
whitelistedKeySpecs?: Schema$DnsKeySpec[];
}
/**
* A unit of data that is returned by the DNS servers.
*/
export interface Schema$ResourceRecordSet {
kind?: string | null;
/**
* For example, www.example.com.
*/
name?: string | null;
/**
* Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution).
*/
routingPolicy?: Schema$RRSetRoutingPolicy;
/**
* As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
*/
r