Module google_pubsub1::api [−][src]
Structs
AcknowledgeRequest | Request for the Acknowledge method. |
Binding | Associates |
CreateSnapshotRequest | Request for the |
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 |
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. |
ListSchemasResponse | Response for the |
ListSnapshotsResponse | Response for the |
ListSubscriptionsResponse | Response for the |
ListTopicSnapshotsResponse | Response for the |
ListTopicSubscriptionsResponse | Response for the |
ListTopicsResponse | Response for the |
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 |
ProjectMethods | A builder providing access to all methods supported on project resources.
It is not used directly, but through the |
ProjectSchemaCreateCall | Creates a schema. |
ProjectSchemaDeleteCall | Deletes a schema. |
ProjectSchemaGetCall | Gets a schema. |
ProjectSchemaGetIamPolicyCall | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. |
ProjectSchemaListCall | Lists schemas in a project. |
ProjectSchemaSetIamPolicyCall | Sets the access control policy on the specified resource. Replaces any existing policy. Can return |
ProjectSchemaTestIamPermissionCall | 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 |
ProjectSchemaValidateCall | Validates a schema. |
ProjectSchemaValidateMessageCall | Validates a message against a schema. |
ProjectSnapshotCreateCall | Creates a snapshot from the requested subscription. 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. If the snapshot already exists, returns |
ProjectSnapshotDeleteCall | Removes an existing snapshot. Snapshots are used in [Seek] (https://cloud.google.com/pubsub/docs/replay-overview) 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. When the snapshot is deleted, all messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified. |
ProjectSnapshotGetCall | Gets the configuration details of a snapshot. 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. |
ProjectSnapshotGetIamPolicyCall | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. |
ProjectSnapshotListCall | Lists the existing snapshots. 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. |
ProjectSnapshotPatchCall | Updates an existing snapshot. 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. |
ProjectSnapshotSetIamPolicyCall | Sets the access control policy on the specified resource. Replaces any existing policy. Can return |
ProjectSnapshotTestIamPermissionCall | 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 |
ProjectSubscriptionAcknowledgeCall | Acknowledges the messages associated with the |
ProjectSubscriptionCreateCall | Creates a subscription to a given topic. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names). If the subscription already exists, returns |
ProjectSubscriptionDeleteCall | Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to |
ProjectSubscriptionDetachCall | Detaches a subscription from this topic. All messages retained in the subscription are dropped. Subsequent |
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 |
ProjectSubscriptionModifyPushConfigCall | Modifies the |
ProjectSubscriptionPatchCall | Updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable. |
ProjectSubscriptionPullCall | Pulls messages from the server. The server may return |
ProjectSubscriptionSeekCall | Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. Snapshots are used in [Seek] (https://cloud.google.com/pubsub/docs/replay-overview) 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. Note that both the subscription and the snapshot must be on the same topic. |
ProjectSubscriptionSetIamPolicyCall | Sets the access control policy on the specified resource. Replaces any existing policy. Can return |
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 |
ProjectTopicCreateCall | Creates the given topic with the given name. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names). |
ProjectTopicDeleteCall | Deletes the topic with the given name. Returns |
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. |
ProjectTopicPatchCall | Updates an existing topic. Note that certain properties of a topic are not modifiable. |
ProjectTopicPublishCall | Adds one or more messages to the topic. Returns |
ProjectTopicSetIamPolicyCall | Sets the access control policy on the specified resource. Replaces any existing policy. Can return |
ProjectTopicSnapshotListCall | Lists the names of the snapshots on this topic. 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. |
ProjectTopicSubscriptionListCall | Lists the names of the attached subscriptions on 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 |
PublishRequest | Request for the Publish method. |
PublishResponse | Response for the |
Pubsub | Central instance to access all Pubsub related resource activities |
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 |
PullResponse | Response for the |
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. |
Schema | A schema resource. |
SchemaSettings | Settings for validating messages published against a schema. |
SeekRequest | Request for the |
SeekResponse | Response for the |
SetIamPolicyRequest | Request message for |
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 |
TestIamPermissionsResponse | Response message for |
Topic | A topic resource. |
UpdateSnapshotRequest | Request for the UpdateSnapshot method. |
UpdateSubscriptionRequest | Request for the UpdateSubscription method. |
UpdateTopicRequest | Request for the UpdateTopic method. |
ValidateMessageRequest | Request for the |
ValidateMessageResponse | Response for the |
ValidateSchemaRequest | Request for the |
ValidateSchemaResponse | Response for the |
Enums
Scope | Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token. |