googleapis.pubsub.v1 library

Classes

AcknowledgeRequest
Request for the Acknowledge method.
Binding
Associates members with a role.
CreateSnapshotRequest
Request for the CreateSnapshot method.
DeadLetterPolicy
Dead lettering is done on a best effort basis. The same message might be dead lettered multiple times. If validation on any of the fields fails at subscription creation/updation, the create/update subscription request will fail.
DetachSubscriptionResponse
Response for the DetachSubscription method. Reserved for future use.
Empty
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 {}.
ExpirationPolicy
A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).
Expr
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.
ListSnapshotsResponse
Response for the ListSnapshots method.
ListSubscriptionsResponse
Response for the ListSubscriptions method.
ListTopicSnapshotsResponse
Response for the ListTopicSnapshots method.
ListTopicsResponse
Response for the ListTopics method.
ListTopicSubscriptionsResponse
Response for the ListTopicSubscriptions method.
MessageStoragePolicy
A policy constraining the storage of messages published to the topic.
ModifyAckDeadlineRequest
Request for the ModifyAckDeadline method.
ModifyPushConfigRequest
Request for the ModifyPushConfig method.
OidcToken
Contains information needed for generating an OpenID Connect token.
Policy
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 to a single role. Members 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. 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.
ProjectsResourceApi
ProjectsSnapshotsResourceApi
ProjectsSubscriptionsResourceApi
ProjectsTopicsResourceApi
ProjectsTopicsSnapshotsResourceApi
ProjectsTopicsSubscriptionsResourceApi
PublishRequest
Request for the Publish method.
PublishResponse
Response for the Publish method.
PubsubApi
Provides reliable, many-to-many, asynchronous messaging between applications.
PubsubMessage
A message that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding client library documentation for more information. See quotas and limits (https://cloud.google.com/pubsub/quotas) for more information about message limits.
PullRequest
Request for the Pull method.
PullResponse
Response for the Pull method.
PushConfig
Configuration for a push delivery endpoint.
ReceivedMessage
A message and its corresponding acknowledgment ID.
RetryPolicy
A policy that specifies how Cloud Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.
SeekRequest
Request for the Seek method.
SeekResponse
Response for the Seek method (this response is empty).
SetIamPolicyRequest
Request message for SetIamPolicy method.
Snapshot
A snapshot resource. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.
Subscription
A subscription resource.
TestIamPermissionsRequest
Request message for TestIamPermissions method.
TestIamPermissionsResponse
Response message for TestIamPermissions method.
Topic
A topic resource.
UpdateSnapshotRequest
Request for the UpdateSnapshot method.
UpdateSubscriptionRequest
Request for the UpdateSubscription method.
UpdateTopicRequest
Request for the UpdateTopic method.

Constants

USER_AGENT → const String
'dart-api-client pubsub/v1'

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.