mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-01 14:54:02 +01:00
56 lines
23 KiB
HTML
56 lines
23 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_pubsub1_beta2`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_pubsub1_beta2::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_pubsub1_beta2/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_pubsub1_beta2</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_pubsub1_beta2</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_pubsub1_beta2/api.rs.html#1-6816" 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.AcknowledgeRequest.html" title="google_pubsub1_beta2::api::AcknowledgeRequest struct">AcknowledgeRequest</a></td><td class="docblock-short"><p>Request for the Acknowledge method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Binding.html" title="google_pubsub1_beta2::api::Binding struct">Binding</a></td><td class="docblock-short"><p>Associates <code>members</code> with a <code>role</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Empty.html" title="google_pubsub1_beta2::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 <code>Empty</code> is empty JSON object <code>{}</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Expr.html" title="google_pubsub1_beta2::api::Expr struct">Expr</a></td><td class="docblock-short"><p>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.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListSubscriptionsResponse.html" title="google_pubsub1_beta2::api::ListSubscriptionsResponse struct">ListSubscriptionsResponse</a></td><td class="docblock-short"><p>Response for the <code>ListSubscriptions</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListTopicSubscriptionsResponse.html" title="google_pubsub1_beta2::api::ListTopicSubscriptionsResponse struct">ListTopicSubscriptionsResponse</a></td><td class="docblock-short"><p>Response for the <code>ListTopicSubscriptions</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListTopicsResponse.html" title="google_pubsub1_beta2::api::ListTopicsResponse struct">ListTopicsResponse</a></td><td class="docblock-short"><p>Response for the <code>ListTopics</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ModifyAckDeadlineRequest.html" title="google_pubsub1_beta2::api::ModifyAckDeadlineRequest struct">ModifyAckDeadlineRequest</a></td><td class="docblock-short"><p>Request for the ModifyAckDeadline method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ModifyPushConfigRequest.html" title="google_pubsub1_beta2::api::ModifyPushConfigRequest struct">ModifyPushConfigRequest</a></td><td class="docblock-short"><p>Request for the ModifyPushConfig method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OidcToken.html" title="google_pubsub1_beta2::api::OidcToken struct">OidcToken</a></td><td class="docblock-short"><p>Contains information needed for generating an <a href="https://developers.google.com/identity/protocols/OpenIDConnect">OpenID Connect token</a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Policy.html" title="google_pubsub1_beta2::api::Policy struct">Policy</a></td><td class="docblock-short"><p>An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A <code>Policy</code> is a collection of <code>bindings</code>. A <code>binding</code> binds one or more <code>members</code> to a single <code>role</code>. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A <code>role</code> is a named list of permissions; each <code>role</code> can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a <code>binding</code> can also specify a <code>condition</code>, which is a logical expression that allows access to a resource only if the expression evaluates to <code>true</code>. 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 <a href="https://cloud.google.com/iam/help/conditions/resource-policies">IAM documentation</a>. <strong>JSON example:</strong> { "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 } <strong>YAML example:</strong> 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 <a href="https://cloud.google.com/iam/docs/">IAM documentation</a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectMethods.html" title="google_pubsub1_beta2::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>Pubsub</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectSubscriptionAcknowledgeCall.html" title="google_pubsub1_beta2::api::ProjectSubscriptionAcknowledgeCall struct">ProjectSubscriptionAcknowledgeCall</a></td><td class="docblock-short"><p>Acknowledges the messages associated with the <code>ack_ids</code> in the <code>AcknowledgeRequest</code>. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectSubscriptionCreateCall.html" title="google_pubsub1_beta2::api::ProjectSubscriptionCreateCall struct">ProjectSubscriptionCreateCall</a></td><td class="docblock-short"><p>Creates a subscription to a given topic. If the subscription already exists, returns <code>ALREADY_EXISTS</code>. If the corresponding topic doesn't exist, returns <code>NOT_FOUND</code>. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic. Note that for REST API requests, you must specify a name.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectSubscriptionDeleteCall.html" title="google_pubsub1_beta2::api::ProjectSubscriptionDeleteCall struct">ProjectSubscriptionDeleteCall</a></td><td class="docblock-short"><p>Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to <code>Pull</code> after deletion will return <code>NOT_FOUND</code>. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription, or its topic unless the same topic is specified.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectSubscriptionGetCall.html" title="google_pubsub1_beta2::api::ProjectSubscriptionGetCall struct">ProjectSubscriptionGetCall</a></td><td class="docblock-short"><p>Gets the configuration details of a subscription.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectSubscriptionGetIamPolicyCall.html" title="google_pubsub1_beta2::api::ProjectSubscriptionGetIamPolicyCall struct">ProjectSubscriptionGetIamPolicyCall</a></td><td class="docblock-short"><p>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectSubscriptionListCall.html" title="google_pubsub1_beta2::api::ProjectSubscriptionListCall struct">ProjectSubscriptionListCall</a></td><td class="docblock-short"><p>Lists matching subscriptions.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectSubscriptionModifyAckDeadlineCall.html" title="google_pubsub1_beta2::api::ProjectSubscriptionModifyAckDeadlineCall struct">ProjectSubscriptionModifyAckDeadlineCall</a></td><td class="docblock-short"><p>Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level <code>ackDeadlineSeconds</code> used for subsequent messages.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectSubscriptionModifyPushConfigCall.html" title="google_pubsub1_beta2::api::ProjectSubscriptionModifyPushConfigCall struct">ProjectSubscriptionModifyPushConfigCall</a></td><td class="docblock-short"><p>Modifies the <code>PushConfig</code> for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty <code>PushConfig</code>) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the <code>PushConfig</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectSubscriptionPullCall.html" title="google_pubsub1_beta2::api::ProjectSubscriptionPullCall struct">ProjectSubscriptionPullCall</a></td><td class="docblock-short"><p>Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return <code>UNAVAILABLE</code> if there are too many concurrent pull requests pending for the given subscription.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectSubscriptionSetIamPolicyCall.html" title="google_pubsub1_beta2::api::ProjectSubscriptionSetIamPolicyCall struct">ProjectSubscriptionSetIamPolicyCall</a></td><td class="docblock-short"><p>Sets the access control policy on the specified resource. Replaces any existing policy. Can return <code>NOT_FOUND</code>, <code>INVALID_ARGUMENT</code>, and <code>PERMISSION_DENIED</code> errors.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectSubscriptionTestIamPermissionCall.html" title="google_pubsub1_beta2::api::ProjectSubscriptionTestIamPermissionCall struct">ProjectSubscriptionTestIamPermissionCall</a></td><td class="docblock-short"><p>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a <code>NOT_FOUND</code> error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectTopicCreateCall.html" title="google_pubsub1_beta2::api::ProjectTopicCreateCall struct">ProjectTopicCreateCall</a></td><td class="docblock-short"><p>Creates the given topic with the given name.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectTopicDeleteCall.html" title="google_pubsub1_beta2::api::ProjectTopicDeleteCall struct">ProjectTopicDeleteCall</a></td><td class="docblock-short"><p>Deletes the topic with the given name. Returns <code>NOT_FOUND</code> if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their <code>topic</code> field is set to <code>_deleted-topic_</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectTopicGetCall.html" title="google_pubsub1_beta2::api::ProjectTopicGetCall struct">ProjectTopicGetCall</a></td><td class="docblock-short"><p>Gets the configuration of a topic.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectTopicGetIamPolicyCall.html" title="google_pubsub1_beta2::api::ProjectTopicGetIamPolicyCall struct">ProjectTopicGetIamPolicyCall</a></td><td class="docblock-short"><p>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectTopicListCall.html" title="google_pubsub1_beta2::api::ProjectTopicListCall struct">ProjectTopicListCall</a></td><td class="docblock-short"><p>Lists matching topics.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectTopicPublishCall.html" title="google_pubsub1_beta2::api::ProjectTopicPublishCall struct">ProjectTopicPublishCall</a></td><td class="docblock-short"><p>Adds one or more messages to the topic. Returns <code>NOT_FOUND</code> if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectTopicSetIamPolicyCall.html" title="google_pubsub1_beta2::api::ProjectTopicSetIamPolicyCall struct">ProjectTopicSetIamPolicyCall</a></td><td class="docblock-short"><p>Sets the access control policy on the specified resource. Replaces any existing policy. Can return <code>NOT_FOUND</code>, <code>INVALID_ARGUMENT</code>, and <code>PERMISSION_DENIED</code> errors.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectTopicSubscriptionListCall.html" title="google_pubsub1_beta2::api::ProjectTopicSubscriptionListCall struct">ProjectTopicSubscriptionListCall</a></td><td class="docblock-short"><p>Lists the name of the subscriptions for this topic.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectTopicTestIamPermissionCall.html" title="google_pubsub1_beta2::api::ProjectTopicTestIamPermissionCall struct">ProjectTopicTestIamPermissionCall</a></td><td class="docblock-short"><p>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a <code>NOT_FOUND</code> error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PublishRequest.html" title="google_pubsub1_beta2::api::PublishRequest struct">PublishRequest</a></td><td class="docblock-short"><p>Request for the Publish method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PublishResponse.html" title="google_pubsub1_beta2::api::PublishResponse struct">PublishResponse</a></td><td class="docblock-short"><p>Response for the <code>Publish</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Pubsub.html" title="google_pubsub1_beta2::api::Pubsub struct">Pubsub</a></td><td class="docblock-short"><p>Central instance to access all Pubsub related resource activities</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PubsubMessage.html" title="google_pubsub1_beta2::api::PubsubMessage struct">PubsubMessage</a></td><td class="docblock-short"><p>A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PullRequest.html" title="google_pubsub1_beta2::api::PullRequest struct">PullRequest</a></td><td class="docblock-short"><p>Request for the <code>Pull</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PullResponse.html" title="google_pubsub1_beta2::api::PullResponse struct">PullResponse</a></td><td class="docblock-short"><p>Response for the <code>Pull</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PushConfig.html" title="google_pubsub1_beta2::api::PushConfig struct">PushConfig</a></td><td class="docblock-short"><p>Configuration for a push delivery endpoint.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ReceivedMessage.html" title="google_pubsub1_beta2::api::ReceivedMessage struct">ReceivedMessage</a></td><td class="docblock-short"><p>A message and its corresponding acknowledgment ID.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SetIamPolicyRequest.html" title="google_pubsub1_beta2::api::SetIamPolicyRequest struct">SetIamPolicyRequest</a></td><td class="docblock-short"><p>Request message for <code>SetIamPolicy</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Subscription.html" title="google_pubsub1_beta2::api::Subscription struct">Subscription</a></td><td class="docblock-short"><p>A subscription resource.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TestIamPermissionsRequest.html" title="google_pubsub1_beta2::api::TestIamPermissionsRequest struct">TestIamPermissionsRequest</a></td><td class="docblock-short"><p>Request message for <code>TestIamPermissions</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TestIamPermissionsResponse.html" title="google_pubsub1_beta2::api::TestIamPermissionsResponse struct">TestIamPermissionsResponse</a></td><td class="docblock-short"><p>Response message for <code>TestIamPermissions</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Topic.html" title="google_pubsub1_beta2::api::Topic struct">Topic</a></td><td class="docblock-short"><p>A topic resource.</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_pubsub1_beta2::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_pubsub1_beta2"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |