Files
google-apis-rs/google_dns1/api/index.html
2021-04-02 00:20:57 +08:00

85 lines
23 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `api` mod in crate `google_dns1`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_dns1::api - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../google_dns1/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module api</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class="location"><a href="../index.html">google_dns1</a></p><div id="sidebar-vars" data-name="api" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><button type="button" class="help-button">?</button>
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">google_dns1</a>::<wbr><a class="mod" href="">api</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../../src/google_dns1/api.rs.html#1-9537" title="goto source code">[src]</a></span></h1><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<table><tr class="module-item"><td><a class="struct" href="struct.Change.html" title="google_dns1::api::Change struct">Change</a></td><td class="docblock-short"><p>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.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ChangeCreateCall.html" title="google_dns1::api::ChangeCreateCall struct">ChangeCreateCall</a></td><td class="docblock-short"><p>Atomically updates the ResourceRecordSet collection.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ChangeGetCall.html" title="google_dns1::api::ChangeGetCall struct">ChangeGetCall</a></td><td class="docblock-short"><p>Fetches the representation of an existing Change.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ChangeListCall.html" title="google_dns1::api::ChangeListCall struct">ChangeListCall</a></td><td class="docblock-short"><p>Enumerates Changes to a ResourceRecordSet collection.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ChangeMethods.html" title="google_dns1::api::ChangeMethods struct">ChangeMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>change</em> resources.
It is not used directly, but through the <code>Dns</code> hub.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ChangesListResponse.html" title="google_dns1::api::ChangesListResponse struct">ChangesListResponse</a></td><td class="docblock-short"><p>The response to a request to enumerate Changes to a ResourceRecordSets collection.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Dns.html" title="google_dns1::api::Dns struct">Dns</a></td><td class="docblock-short"><p>Central instance to access all Dns related resource activities</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DnsKey.html" title="google_dns1::api::DnsKey struct">DnsKey</a></td><td class="docblock-short"><p>A DNSSEC key pair.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DnsKeyDigest.html" title="google_dns1::api::DnsKeyDigest struct">DnsKeyDigest</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DnsKeyGetCall.html" title="google_dns1::api::DnsKeyGetCall struct">DnsKeyGetCall</a></td><td class="docblock-short"><p>Fetches the representation of an existing DnsKey.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DnsKeyListCall.html" title="google_dns1::api::DnsKeyListCall struct">DnsKeyListCall</a></td><td class="docblock-short"><p>Enumerates DnsKeys to a ResourceRecordSet collection.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DnsKeyMethods.html" title="google_dns1::api::DnsKeyMethods struct">DnsKeyMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>dnsKey</em> resources.
It is not used directly, but through the <code>Dns</code> hub.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DnsKeySpec.html" title="google_dns1::api::DnsKeySpec struct">DnsKeySpec</a></td><td class="docblock-short"><p>Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DnsKeysListResponse.html" title="google_dns1::api::DnsKeysListResponse struct">DnsKeysListResponse</a></td><td class="docblock-short"><p>The response to a request to enumerate DnsKeys in a ManagedZone.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZone.html" title="google_dns1::api::ManagedZone struct">ManagedZone</a></td><td class="docblock-short"><p>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.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZoneCreateCall.html" title="google_dns1::api::ManagedZoneCreateCall struct">ManagedZoneCreateCall</a></td><td class="docblock-short"><p>Creates a new ManagedZone.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZoneDeleteCall.html" title="google_dns1::api::ManagedZoneDeleteCall struct">ManagedZoneDeleteCall</a></td><td class="docblock-short"><p>Deletes a previously created ManagedZone.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZoneDnsSecConfig.html" title="google_dns1::api::ManagedZoneDnsSecConfig struct">ManagedZoneDnsSecConfig</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZoneForwardingConfig.html" title="google_dns1::api::ManagedZoneForwardingConfig struct">ManagedZoneForwardingConfig</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZoneForwardingConfigNameServerTarget.html" title="google_dns1::api::ManagedZoneForwardingConfigNameServerTarget struct">ManagedZoneForwardingConfigNameServerTarget</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZoneGetCall.html" title="google_dns1::api::ManagedZoneGetCall struct">ManagedZoneGetCall</a></td><td class="docblock-short"><p>Fetches the representation of an existing ManagedZone.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZoneListCall.html" title="google_dns1::api::ManagedZoneListCall struct">ManagedZoneListCall</a></td><td class="docblock-short"><p>Enumerates ManagedZones that have been created but not yet deleted.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZoneMethods.html" title="google_dns1::api::ManagedZoneMethods struct">ManagedZoneMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>managedZone</em> resources.
It is not used directly, but through the <code>Dns</code> hub.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZoneOperationGetCall.html" title="google_dns1::api::ManagedZoneOperationGetCall struct">ManagedZoneOperationGetCall</a></td><td class="docblock-short"><p>Fetches the representation of an existing Operation.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZoneOperationListCall.html" title="google_dns1::api::ManagedZoneOperationListCall struct">ManagedZoneOperationListCall</a></td><td class="docblock-short"><p>Enumerates Operations for the given ManagedZone.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZoneOperationMethods.html" title="google_dns1::api::ManagedZoneOperationMethods struct">ManagedZoneOperationMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>managedZoneOperation</em> resources.
It is not used directly, but through the <code>Dns</code> hub.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZoneOperationsListResponse.html" title="google_dns1::api::ManagedZoneOperationsListResponse struct">ManagedZoneOperationsListResponse</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZonePatchCall.html" title="google_dns1::api::ManagedZonePatchCall struct">ManagedZonePatchCall</a></td><td class="docblock-short"><p>Applies a partial update to an existing ManagedZone.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZonePeeringConfig.html" title="google_dns1::api::ManagedZonePeeringConfig struct">ManagedZonePeeringConfig</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZonePeeringConfigTargetNetwork.html" title="google_dns1::api::ManagedZonePeeringConfigTargetNetwork struct">ManagedZonePeeringConfigTargetNetwork</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZonePrivateVisibilityConfig.html" title="google_dns1::api::ManagedZonePrivateVisibilityConfig struct">ManagedZonePrivateVisibilityConfig</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZonePrivateVisibilityConfigNetwork.html" title="google_dns1::api::ManagedZonePrivateVisibilityConfigNetwork struct">ManagedZonePrivateVisibilityConfigNetwork</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZoneReverseLookupConfig.html" title="google_dns1::api::ManagedZoneReverseLookupConfig struct">ManagedZoneReverseLookupConfig</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZoneServiceDirectoryConfig.html" title="google_dns1::api::ManagedZoneServiceDirectoryConfig struct">ManagedZoneServiceDirectoryConfig</a></td><td class="docblock-short"><p>Contains information about Service Directory-backed zones.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZoneServiceDirectoryConfigNamespace.html" title="google_dns1::api::ManagedZoneServiceDirectoryConfigNamespace struct">ManagedZoneServiceDirectoryConfigNamespace</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZoneUpdateCall.html" title="google_dns1::api::ManagedZoneUpdateCall struct">ManagedZoneUpdateCall</a></td><td class="docblock-short"><p>Updates an existing ManagedZone.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ManagedZonesListResponse.html" title="google_dns1::api::ManagedZonesListResponse struct">ManagedZonesListResponse</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Operation.html" title="google_dns1::api::Operation struct">Operation</a></td><td class="docblock-short"><p>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.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OperationDnsKeyContext.html" title="google_dns1::api::OperationDnsKeyContext struct">OperationDnsKeyContext</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OperationManagedZoneContext.html" title="google_dns1::api::OperationManagedZoneContext struct">OperationManagedZoneContext</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PoliciesListResponse.html" title="google_dns1::api::PoliciesListResponse struct">PoliciesListResponse</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PoliciesPatchResponse.html" title="google_dns1::api::PoliciesPatchResponse struct">PoliciesPatchResponse</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PoliciesUpdateResponse.html" title="google_dns1::api::PoliciesUpdateResponse struct">PoliciesUpdateResponse</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Policy.html" title="google_dns1::api::Policy struct">Policy</a></td><td class="docblock-short"><p>A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PolicyAlternativeNameServerConfig.html" title="google_dns1::api::PolicyAlternativeNameServerConfig struct">PolicyAlternativeNameServerConfig</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PolicyAlternativeNameServerConfigTargetNameServer.html" title="google_dns1::api::PolicyAlternativeNameServerConfigTargetNameServer struct">PolicyAlternativeNameServerConfigTargetNameServer</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PolicyCreateCall.html" title="google_dns1::api::PolicyCreateCall struct">PolicyCreateCall</a></td><td class="docblock-short"><p>Creates a new Policy.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PolicyDeleteCall.html" title="google_dns1::api::PolicyDeleteCall struct">PolicyDeleteCall</a></td><td class="docblock-short"><p>Deletes a previously created Policy. Fails if the policy is still being referenced by a network.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PolicyGetCall.html" title="google_dns1::api::PolicyGetCall struct">PolicyGetCall</a></td><td class="docblock-short"><p>Fetches the representation of an existing Policy.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PolicyListCall.html" title="google_dns1::api::PolicyListCall struct">PolicyListCall</a></td><td class="docblock-short"><p>Enumerates all Policies associated with a project.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PolicyMethods.html" title="google_dns1::api::PolicyMethods struct">PolicyMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>policy</em> resources.
It is not used directly, but through the <code>Dns</code> hub.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PolicyNetwork.html" title="google_dns1::api::PolicyNetwork struct">PolicyNetwork</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PolicyPatchCall.html" title="google_dns1::api::PolicyPatchCall struct">PolicyPatchCall</a></td><td class="docblock-short"><p>Applies a partial update to an existing Policy.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PolicyUpdateCall.html" title="google_dns1::api::PolicyUpdateCall struct">PolicyUpdateCall</a></td><td class="docblock-short"><p>Updates an existing Policy.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Project.html" title="google_dns1::api::Project struct">Project</a></td><td class="docblock-short"><p>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.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectGetCall.html" title="google_dns1::api::ProjectGetCall struct">ProjectGetCall</a></td><td class="docblock-short"><p>Fetches the representation of an existing Project.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectManagedZoneRrsetCreateCall.html" title="google_dns1::api::ProjectManagedZoneRrsetCreateCall struct">ProjectManagedZoneRrsetCreateCall</a></td><td class="docblock-short"><p>Creates a new ResourceRecordSet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectManagedZoneRrsetDeleteCall.html" title="google_dns1::api::ProjectManagedZoneRrsetDeleteCall struct">ProjectManagedZoneRrsetDeleteCall</a></td><td class="docblock-short"><p>Deletes a previously created ResourceRecordSet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectManagedZoneRrsetGetCall.html" title="google_dns1::api::ProjectManagedZoneRrsetGetCall struct">ProjectManagedZoneRrsetGetCall</a></td><td class="docblock-short"><p>Fetches the representation of an existing ResourceRecordSet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectManagedZoneRrsetPatchCall.html" title="google_dns1::api::ProjectManagedZoneRrsetPatchCall struct">ProjectManagedZoneRrsetPatchCall</a></td><td class="docblock-short"><p>Applies a partial update to an existing ResourceRecordSet.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectMethods.html" title="google_dns1::api::ProjectMethods struct">ProjectMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>project</em> resources.
It is not used directly, but through the <code>Dns</code> hub.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Quota.html" title="google_dns1::api::Quota struct">Quota</a></td><td class="docblock-short"><p>Limits associated with a Project.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ResourceRecordSet.html" title="google_dns1::api::ResourceRecordSet struct">ResourceRecordSet</a></td><td class="docblock-short"><p>A unit of data that is returned by the DNS servers.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ResourceRecordSetListCall.html" title="google_dns1::api::ResourceRecordSetListCall struct">ResourceRecordSetListCall</a></td><td class="docblock-short"><p>Enumerates ResourceRecordSets that you have created but not yet deleted.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ResourceRecordSetMethods.html" title="google_dns1::api::ResourceRecordSetMethods struct">ResourceRecordSetMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>resourceRecordSet</em> resources.
It is not used directly, but through the <code>Dns</code> hub.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ResourceRecordSetsDeleteResponse.html" title="google_dns1::api::ResourceRecordSetsDeleteResponse struct">ResourceRecordSetsDeleteResponse</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ResourceRecordSetsListResponse.html" title="google_dns1::api::ResourceRecordSetsListResponse struct">ResourceRecordSetsListResponse</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ResponseHeader.html" title="google_dns1::api::ResponseHeader struct">ResponseHeader</a></td><td class="docblock-short"><p>Elements common to every response.</p>
</td></tr></table><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
<table><tr class="module-item"><td><a class="enum" href="enum.Scope.html" title="google_dns1::api::Scope enum">Scope</a></td><td class="docblock-short"><p>Identifies the an OAuth2 authorization scope.
A scope is needed when requesting an
<a href="https://developers.google.com/youtube/v3/guides/authentication">authorization token</a>.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="google_dns1"></div>
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>