OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-31 22:34:01 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
37ba635de2b0340299e6a35431c2efd0ca3aa555
google-apis-rs/google_servicecontrol2/api/index.html
Sebastian Thiel 37ba635de2 Update documentation
2021-04-02 00:20:57 +08:00

28 lines
12 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_servicecontrol2`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_servicecontrol2::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_servicecontrol2/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_servicecontrol2</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_servicecontrol2</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_servicecontrol2/api.rs.html#1-1146" 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.Api.html" title="google_servicecontrol2::api::Api struct">Api</a></td><td class="docblock-short"><p>This message defines attributes associated with API operations, such as a network API request. The terminology is based on the conventions used by Google APIs, Istio, and OpenAPI.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AttributeContext.html" title="google_servicecontrol2::api::AttributeContext struct">AttributeContext</a></td><td class="docblock-short"><p>This message defines the standard attribute vocabulary for Google APIs. An attribute is a piece of metadata that describes an activity on a network service. For example, the size of an HTTP request, or the status code of an HTTP response. Each attribute has a type and a name, which is logically defined as a proto message field in <code>AttributeContext</code>. The field type becomes the attribute type, and the field path becomes the attribute name. For example, the attribute <code>source.ip</code> maps to field <code>AttributeContext.source.ip</code>. This message definition is guaranteed not to have any wire breaking change. So you can use it directly for passing attributes across different systems. NOTE: Different system may generate different subset of attributes. Please verify the system specification before relying on an attribute generated a system.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Auth.html" title="google_servicecontrol2::api::Auth struct">Auth</a></td><td class="docblock-short"><p>This message defines request authentication attributes. Terminology is based on the JSON Web Token (JWT) standard, but the terms also correlate to concepts in other standards.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CheckRequest.html" title="google_servicecontrol2::api::CheckRequest struct">CheckRequest</a></td><td class="docblock-short"><p>Request message for the Check method.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CheckResponse.html" title="google_servicecontrol2::api::CheckResponse struct">CheckResponse</a></td><td class="docblock-short"><p>Response message for the Check method.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Peer.html" title="google_servicecontrol2::api::Peer struct">Peer</a></td><td class="docblock-short"><p>This message defines attributes for a node that handles a network request. The node can be either a service or an application that sends, forwards, or receives the request. Service peers should fill in <code>principal</code> and <code>labels</code> as appropriate.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ReportRequest.html" title="google_servicecontrol2::api::ReportRequest struct">ReportRequest</a></td><td class="docblock-short"><p>Request message for the Report method.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ReportResponse.html" title="google_servicecontrol2::api::ReportResponse struct">ReportResponse</a></td><td class="docblock-short"><p>Response message for the Report method. If the request contains any invalid data, the server returns an RPC error.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Request.html" title="google_servicecontrol2::api::Request struct">Request</a></td><td class="docblock-short"><p>This message defines attributes for an HTTP request. If the actual request is not an HTTP request, the runtime system should try to map the actual request to an equivalent HTTP request.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Resource.html" title="google_servicecontrol2::api::Resource struct">Resource</a></td><td class="docblock-short"><p>This message defines core attributes for a resource. A resource is an addressable (named) entity provided by the destination service. For example, a file stored on a network storage service.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ResourceInfo.html" title="google_servicecontrol2::api::ResourceInfo struct">ResourceInfo</a></td><td class="docblock-short"><p>Describes a resource referenced in the request.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Response.html" title="google_servicecontrol2::api::Response struct">Response</a></td><td class="docblock-short"><p>This message defines attributes for a typical network response. It generally models semantics of an HTTP response.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ServiceCheckCall.html" title="google_servicecontrol2::api::ServiceCheckCall struct">ServiceCheckCall</a></td><td class="docblock-short"><p>Private Preview. This feature is only available for approved services. This method provides admission control for services that are integrated with <a href="/service-infrastructure">Service Infrastructure</a>. It checks whether an operation should be allowed based on the service configuration and relevant policies. It must be called before the operation is executed. For more information, see <a href="/service-infrastructure/docs/admission-control">Admission Control</a>. NOTE: The admission control has an expected policy propagation delay of 60s. The caller <strong>must</strong> not depend on the most recent policy changes. NOTE: The admission control has a hard limit of 1 referenced resources per call. If an operation refers to more than 1 resources, the caller must call the Check method multiple times. This method requires the <code>servicemanagement.services.check</code> permission on the specified service. For more information, see <a href="https://cloud.google.com/service-infrastructure/docs/service-control/access-control">Service Control API Access Control</a>.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ServiceControl.html" title="google_servicecontrol2::api::ServiceControl struct">ServiceControl</a></td><td class="docblock-short"><p>Central instance to access all ServiceControl related resource activities</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ServiceMethods.html" title="google_servicecontrol2::api::ServiceMethods struct">ServiceMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>service</em> resources.
It is not used directly, but through the <code>ServiceControl</code> hub.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ServiceReportCall.html" title="google_servicecontrol2::api::ServiceReportCall struct">ServiceReportCall</a></td><td class="docblock-short"><p>Private Preview. This feature is only available for approved services. This method provides telemetry reporting for services that are integrated with <a href="/service-infrastructure">Service Infrastructure</a>. It reports a list of operations that have occurred on a service. It must be called after the operations have been executed. For more information, see <a href="/service-infrastructure/docs/telemetry-reporting">Telemetry Reporting</a>. NOTE: The telemetry reporting has a hard limit of 1000 operations and 1MB per Report call. It is recommended to have no more than 100 operations per call. This method requires the <code>servicemanagement.services.report</code> permission on the specified service. For more information, see <a href="https://cloud.google.com/service-infrastructure/docs/service-control/access-control">Service Control API Access Control</a>.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Status.html" title="google_servicecontrol2::api::Status struct">Status</a></td><td class="docblock-short"><p>The <code>Status</code> type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by <a href="https://github.com/grpc">gRPC</a>. Each <code>Status</code> message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the <a href="https://cloud.google.com/apis/design/errors">API Design Guide</a>.</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_servicecontrol2::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_servicecontrol2"></div>
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink