mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-29 05:12:45 +01:00
61 lines
20 KiB
HTML
61 lines
20 KiB
HTML
<!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_logging2_beta1`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_logging2_beta1::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">☰</div><a href='../../google_logging2_beta1/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_logging2_beta1</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_logging2_beta1</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">−</span>]</a></span><a class="srclink" href="../../src/google_logging2_beta1/api.rs.html#1-4976" 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.BucketOptions.html" title="google_logging2_beta1::api::BucketOptions struct">BucketOptions</a></td><td class="docblock-short"><p>BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Empty.html" title="google_logging2_beta1::api::Empty struct">Empty</a></td><td class="docblock-short"><p>A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
|
||
service Foo {
|
||
rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
||
}
|
||
The JSON representation for Empty is empty JSON object {}.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.EntryListCall.html" title="google_logging2_beta1::api::EntryListCall struct">EntryListCall</a></td><td class="docblock-short"><p>Lists log entries. Use this method to retrieve log entries that originated from a project/folder/organization/billing account. For ways to export log entries, see Exporting Logs.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.EntryMethods.html" title="google_logging2_beta1::api::EntryMethods struct">EntryMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>entry</em> resources.
|
||
It is not used directly, but through the <code>Logging</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.EntryWriteCall.html" title="google_logging2_beta1::api::EntryWriteCall struct">EntryWriteCall</a></td><td class="docblock-short"><p>Writes log entries to Logging. This API method is the only way to send log entries to Logging. This method is used, directly or indirectly, by the Logging agent (fluentd) and all logging libraries configured to use Logging. A single request may contain log entries for a maximum of 1000 different resources (projects, organizations, billing accounts or folders)</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Explicit.html" title="google_logging2_beta1::api::Explicit struct">Explicit</a></td><td class="docblock-short"><p>Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Exponential.html" title="google_logging2_beta1::api::Exponential struct">Exponential</a></td><td class="docblock-short"><p>Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.HttpRequest.html" title="google_logging2_beta1::api::HttpRequest struct">HttpRequest</a></td><td class="docblock-short"><p>A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.LabelDescriptor.html" title="google_logging2_beta1::api::LabelDescriptor struct">LabelDescriptor</a></td><td class="docblock-short"><p>A description of a label.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Linear.html" title="google_logging2_beta1::api::Linear struct">Linear</a></td><td class="docblock-short"><p>Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)).</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListLogEntriesRequest.html" title="google_logging2_beta1::api::ListLogEntriesRequest struct">ListLogEntriesRequest</a></td><td class="docblock-short"><p>The parameters to ListLogEntries.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListLogEntriesResponse.html" title="google_logging2_beta1::api::ListLogEntriesResponse struct">ListLogEntriesResponse</a></td><td class="docblock-short"><p>Result returned from ListLogEntries.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListLogMetricsResponse.html" title="google_logging2_beta1::api::ListLogMetricsResponse struct">ListLogMetricsResponse</a></td><td class="docblock-short"><p>Result returned from ListLogMetrics.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListMonitoredResourceDescriptorsResponse.html" title="google_logging2_beta1::api::ListMonitoredResourceDescriptorsResponse struct">ListMonitoredResourceDescriptorsResponse</a></td><td class="docblock-short"><p>Result returned from ListMonitoredResourceDescriptors.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListSinksResponse.html" title="google_logging2_beta1::api::ListSinksResponse struct">ListSinksResponse</a></td><td class="docblock-short"><p>Result returned from ListSinks.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.LogEntry.html" title="google_logging2_beta1::api::LogEntry struct">LogEntry</a></td><td class="docblock-short"><p>An individual entry in a log.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.LogEntryOperation.html" title="google_logging2_beta1::api::LogEntryOperation struct">LogEntryOperation</a></td><td class="docblock-short"><p>Additional information about a potentially long-running operation with which a log entry is associated.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.LogEntrySourceLocation.html" title="google_logging2_beta1::api::LogEntrySourceLocation struct">LogEntrySourceLocation</a></td><td class="docblock-short"><p>Additional information about the source code location that produced the log entry.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.LogMetric.html" title="google_logging2_beta1::api::LogMetric struct">LogMetric</a></td><td class="docblock-short"><p>Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval.Logs-based metric can also be used to extract values from logs and create a a distribution of the values. The distribution records the statistics of the extracted values along with an optional histogram of the values as specified by the bucket options.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.LogSink.html" title="google_logging2_beta1::api::LogSink struct">LogSink</a></td><td class="docblock-short"><p>Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Logging.html" title="google_logging2_beta1::api::Logging struct">Logging</a></td><td class="docblock-short"><p>Central instance to access all Logging related resource activities</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MetricDescriptor.html" title="google_logging2_beta1::api::MetricDescriptor struct">MetricDescriptor</a></td><td class="docblock-short"><p>Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MetricDescriptorMetadata.html" title="google_logging2_beta1::api::MetricDescriptorMetadata struct">MetricDescriptorMetadata</a></td><td class="docblock-short"><p>Additional annotations that can be used to guide the usage of a metric.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MonitoredResource.html" title="google_logging2_beta1::api::MonitoredResource struct">MonitoredResource</a></td><td class="docblock-short"><p>An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and "zone":
|
||
{ "type": "gce_instance",
|
||
"labels": { "instance_id": "12345678901234",
|
||
"zone": "us-central1-a" }}</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MonitoredResourceDescriptor.html" title="google_logging2_beta1::api::MonitoredResourceDescriptor struct">MonitoredResourceDescriptor</a></td><td class="docblock-short"><p>An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MonitoredResourceDescriptorListCall.html" title="google_logging2_beta1::api::MonitoredResourceDescriptorListCall struct">MonitoredResourceDescriptorListCall</a></td><td class="docblock-short"><p>Lists the descriptors for monitored resource types used by Logging.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MonitoredResourceDescriptorMethods.html" title="google_logging2_beta1::api::MonitoredResourceDescriptorMethods struct">MonitoredResourceDescriptorMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>monitoredResourceDescriptor</em> resources.
|
||
It is not used directly, but through the <code>Logging</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MonitoredResourceMetadata.html" title="google_logging2_beta1::api::MonitoredResourceMetadata struct">MonitoredResourceMetadata</a></td><td class="docblock-short"><p>Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectMethods.html" title="google_logging2_beta1::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>Logging</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectMetricCreateCall.html" title="google_logging2_beta1::api::ProjectMetricCreateCall struct">ProjectMetricCreateCall</a></td><td class="docblock-short"><p>Creates a logs-based metric.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectMetricDeleteCall.html" title="google_logging2_beta1::api::ProjectMetricDeleteCall struct">ProjectMetricDeleteCall</a></td><td class="docblock-short"><p>Deletes a logs-based metric.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectMetricGetCall.html" title="google_logging2_beta1::api::ProjectMetricGetCall struct">ProjectMetricGetCall</a></td><td class="docblock-short"><p>Gets a logs-based metric.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectMetricListCall.html" title="google_logging2_beta1::api::ProjectMetricListCall struct">ProjectMetricListCall</a></td><td class="docblock-short"><p>Lists logs-based metrics.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectMetricUpdateCall.html" title="google_logging2_beta1::api::ProjectMetricUpdateCall struct">ProjectMetricUpdateCall</a></td><td class="docblock-short"><p>Creates or updates a logs-based metric.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectSinkCreateCall.html" title="google_logging2_beta1::api::ProjectSinkCreateCall struct">ProjectSinkCreateCall</a></td><td class="docblock-short"><p>Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectSinkDeleteCall.html" title="google_logging2_beta1::api::ProjectSinkDeleteCall struct">ProjectSinkDeleteCall</a></td><td class="docblock-short"><p>Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectSinkGetCall.html" title="google_logging2_beta1::api::ProjectSinkGetCall struct">ProjectSinkGetCall</a></td><td class="docblock-short"><p>Gets a sink.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectSinkListCall.html" title="google_logging2_beta1::api::ProjectSinkListCall struct">ProjectSinkListCall</a></td><td class="docblock-short"><p>Lists sinks.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectSinkUpdateCall.html" title="google_logging2_beta1::api::ProjectSinkUpdateCall struct">ProjectSinkUpdateCall</a></td><td class="docblock-short"><p>Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.WriteLogEntriesRequest.html" title="google_logging2_beta1::api::WriteLogEntriesRequest struct">WriteLogEntriesRequest</a></td><td class="docblock-short"><p>The parameters to WriteLogEntries.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.WriteLogEntriesResponse.html" title="google_logging2_beta1::api::WriteLogEntriesResponse struct">WriteLogEntriesResponse</a></td><td class="docblock-short"><p>Result returned from WriteLogEntries. empty</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_logging2_beta1::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_logging2_beta1"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |