Module google_pubsub1_beta2::api

Structs

AcknowledgeRequest	Request for the Acknowledge method.
Binding	Associates members with a role.
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 {}.
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.
ListSubscriptionsResponse	Response for the ListSubscriptions method.
ListTopicSubscriptionsResponse	Response for the ListTopicSubscriptions method.
ListTopicsResponse	Response for the ListTopics method.
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.
ProjectMethods	A builder providing access to all methods supported on project resources. It is not used directly, but through the Pubsub hub.
ProjectSubscriptionAcknowledgeCall	Acknowledges the messages associated with the ack_ids in the AcknowledgeRequest. 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.
ProjectSubscriptionCreateCall	Creates a subscription to a given topic. If the subscription already exists, returns ALREADY_EXISTS. If the corresponding topic doesn’t exist, returns NOT_FOUND. 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.
ProjectSubscriptionDeleteCall	Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to Pull after deletion will return NOT_FOUND. 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.
ProjectSubscriptionGetCall	Gets the configuration details of a subscription.
ProjectSubscriptionGetIamPolicyCall	Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectSubscriptionListCall	Lists matching subscriptions.
ProjectSubscriptionModifyAckDeadlineCall	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 ackDeadlineSeconds used for subsequent messages.
ProjectSubscriptionModifyPushConfigCall	Modifies the PushConfig for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty PushConfig) 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 PushConfig.
ProjectSubscriptionPullCall	Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return UNAVAILABLE if there are too many concurrent pull requests pending for the given subscription.
ProjectSubscriptionSetIamPolicyCall	Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ProjectSubscriptionTestIamPermissionCall	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 NOT_FOUND 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.
ProjectTopicCreateCall	Creates the given topic with the given name.
ProjectTopicDeleteCall	Deletes the topic with the given name. Returns NOT_FOUND 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 topic field is set to _deleted-topic_.
ProjectTopicGetCall	Gets the configuration of a topic.
ProjectTopicGetIamPolicyCall	Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectTopicListCall	Lists matching topics.
ProjectTopicPublishCall	Adds one or more messages to the topic. Returns NOT_FOUND 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.
ProjectTopicSetIamPolicyCall	Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ProjectTopicSubscriptionListCall	Lists the name of the subscriptions for this topic.
ProjectTopicTestIamPermissionCall	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 NOT_FOUND 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.
PublishRequest	Request for the Publish method.
PublishResponse	Response for the Publish method.
Pubsub	Central instance to access all Pubsub related resource activities
PubsubMessage	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.
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.
SetIamPolicyRequest	Request message for SetIamPolicy method.
Subscription	A subscription resource.
TestIamPermissionsRequest	Request message for TestIamPermissions method.
TestIamPermissionsResponse	Response message for TestIamPermissions method.
Topic	A topic resource.

Enums

Scope

Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.