Module types (1.0.2)

Version 1.0.2

• 2.21.1 (latest)
• 2.21.0
• 2.20.3
• 2.19.8
• 2.18.4
• 2.17.1
• 2.16.1
• 2.15.2
• 2.14.1
• 2.13.12
• 2.12.1
• 2.11.1
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.1
• 2.6.1
• 2.5.0
• 2.4.2
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.7.2
• 1.6.1
• 1.5.0
• 1.4.3
• 1.3.1
• 1.2.0
• 1.1.0
• 1.0.2
• 0.45.0
• 0.44.0
• 0.43.0

API documentation for pubsub_v1.types module.

Classes

AcknowledgeRequest

Request for the Acknowledge method.

The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the Pull response. Must not be empty.

AuditConfig

API documentation for pubsub_v1.types.AuditConfig class.

AuditConfigDelta

API documentation for pubsub_v1.types.AuditConfigDelta class.

AuditData

API documentation for pubsub_v1.types.AuditData class.

AuditLogConfig

API documentation for pubsub_v1.types.AuditLogConfig class.

BatchSettings

BatchSettings(max_bytes=10000000, max_latency=0.05, max_messages=1000)

The settings for batch publishing the messages.

Binding

API documentation for pubsub_v1.types.Binding class.

BindingDelta

API documentation for pubsub_v1.types.BindingDelta class.

CreateSnapshotRequest

Request for the CreateSnapshot method.

The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the CreateSnapshot request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is projects/{project}/subscriptions/{sub}.

CustomHttpPattern

API documentation for pubsub_v1.types.CustomHttpPattern class.

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.

The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used.

DeleteSnapshotRequest

Request for the DeleteSnapshot method.

DeleteSubscriptionRequest

Request for the DeleteSubscription method.

DeleteTopicRequest

Request for the DeleteTopic method.

DescriptorProto

API documentation for pubsub_v1.types.DescriptorProto class.

Duration

API documentation for pubsub_v1.types.Duration class.

Empty

API documentation for pubsub_v1.types.Empty class.

EnumDescriptorProto

API documentation for pubsub_v1.types.EnumDescriptorProto class.

EnumOptions

API documentation for pubsub_v1.types.EnumOptions class.

EnumValueDescriptorProto

API documentation for pubsub_v1.types.EnumValueDescriptorProto class.

EnumValueOptions

API documentation for pubsub_v1.types.EnumValueOptions class.

ExpirationPolicy

A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).

ExtensionRangeOptions

API documentation for pubsub_v1.types.ExtensionRangeOptions class.

FieldDescriptorProto

API documentation for pubsub_v1.types.FieldDescriptorProto class.

FieldMask

API documentation for pubsub_v1.types.FieldMask class.

FieldOptions

API documentation for pubsub_v1.types.FieldOptions class.

FileDescriptorProto

API documentation for pubsub_v1.types.FileDescriptorProto class.

FileDescriptorSet

API documentation for pubsub_v1.types.FileDescriptorSet class.

FileOptions

API documentation for pubsub_v1.types.FileOptions class.

FlowControl

FlowControl(max_bytes=104857600, max_messages=100, max_lease_duration=7200)

The settings for controlling the rate at which messages are pulled with an asynchronous subscription.

GeneratedCodeInfo

API documentation for pubsub_v1.types.GeneratedCodeInfo class.

GetIamPolicyRequest

API documentation for pubsub_v1.types.GetIamPolicyRequest class.

GetSnapshotRequest

Request for the GetSnapshot method.

GetSubscriptionRequest

Request for the GetSubscription method.

GetTopicRequest

Request for the GetTopic method.

Http

API documentation for pubsub_v1.types.Http class.

HttpRule

API documentation for pubsub_v1.types.HttpRule class.

ListSnapshotsRequest

Request for the ListSnapshots method.

Maximum number of snapshots to return.

ListSnapshotsResponse

Response for the ListSnapshots method.

If not empty, indicates that there may be more snapshot that match the request; this value should be passed in a new ListSnapshotsRequest.

ListSubscriptionsRequest

Request for the ListSubscriptions method.

Maximum number of subscriptions to return.

ListSubscriptionsResponse

Response for the ListSubscriptions method.

If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new ListSubscriptionsRequest to get more subscriptions.

ListTopicSnapshotsRequest

Request for the ListTopicSnapshots method.

Maximum number of snapshot names to return.

ListTopicSnapshotsResponse

Response for the ListTopicSnapshots method.

If not empty, indicates that there may be more snapshots that match the request; this value should be passed in a new ListTopicSnapshotsRequest to get more snapshots.

ListTopicSubscriptionsRequest

Request for the ListTopicSubscriptions method.

Maximum number of subscription names to return.

ListTopicSubscriptionsResponse

Response for the ListTopicSubscriptions method.

If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new ListTopicSubscriptionsRequest to get more subscriptions.

ListTopicsRequest

Request for the ListTopics method.

Maximum number of topics to return.

ListTopicsResponse

Response for the ListTopics method.

If not empty, indicates that there may be more topics that match the request; this value should be passed in a new ListTopicsRequest.

MessageOptions

API documentation for pubsub_v1.types.MessageOptions class.

MessageStoragePolicy

A message storage policy.

MethodDescriptorProto

API documentation for pubsub_v1.types.MethodDescriptorProto class.

MethodOptions

API documentation for pubsub_v1.types.MethodOptions class.

ModifyAckDeadlineRequest

Request for the ModifyAckDeadline method.

List of acknowledgment IDs.

ModifyPushConfigRequest

Request for the ModifyPushConfig method.

The push configuration for future deliveries. An empty pushConfig indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if Pull or StreamingPull is not called.

OneofDescriptorProto

API documentation for pubsub_v1.types.OneofDescriptorProto class.

OneofOptions

API documentation for pubsub_v1.types.OneofOptions class.

Policy

API documentation for pubsub_v1.types.Policy class.

PolicyDelta

API documentation for pubsub_v1.types.PolicyDelta class.

PublishRequest

Request for the Publish method.

The messages to publish.

PublishResponse

Response for the Publish method.

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 for more information about message limits.

Optional attributes for this message.

The time at which the message was published, populated by the server when it receives the Publish call. It must not be populated by the publisher in a Publish call.

PullRequest

Request for the Pull method.

If this field set to true, the system will respond immediately even if it there are no messages available to return in the Pull response. Otherwise, the system may wait (for a bounded amount of time) until at least one message is available, rather than returning no messages.

PullResponse

Response for the Pull method.

PushConfig

Configuration for a push delivery endpoint.

Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the CreateSubscription call, it will default to the version of the Pub/Sub API used to make such call. If not present in a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the x-goog-version attribute are: - v1beta1: uses the push format defined in the v1beta1 Pub/Sub API. - v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API. For example: .. raw:: html

attributes { "x-goog-version": "v1"
   } 

If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message.

ReceivedMessage

A message and its corresponding acknowledgment ID.

The message.

SeekRequest

Request for the Seek method.

The time to seek to. Messages retained in the subscription that were published before this time are marked as acknowledged, and messages retained in the subscription that were published after this time are marked as unacknowledged. Note that this operation affects only those messages retained in the subscription (configured by the combination of message_retention_duration and retain_acked_messages). For example, if time corresponds to a point before the message retention window (or to a point before the system's notion of the subscription creation time), only retained messages will be marked as unacknowledged, and already- expunged messages will not be restored.

SeekResponse

Response for the Seek method (this response is empty).

ServiceDescriptorProto

API documentation for pubsub_v1.types.ServiceDescriptorProto class.

ServiceOptions

API documentation for pubsub_v1.types.ServiceOptions class.

SetIamPolicyRequest

API documentation for pubsub_v1.types.SetIamPolicyRequest class.

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.

The name of the topic from which this snapshot is retaining messages.

See Creating and managing labels.

SourceCodeInfo

API documentation for pubsub_v1.types.SourceCodeInfo class.

StreamingPullRequest

Request for the StreamingPull streaming RPC method. This request is used to establish the initial stream as well as to stream acknowledgements and ack deadline modifications from the client to the server.

List of acknowledgement IDs for acknowledging previously received messages (received on this stream or a different stream). If an ack ID has expired, the corresponding message may be redelivered later. Acknowledging a message more than once will not result in an error. If the acknowledgement ID is malformed, the stream will be aborted with status INVALID_ARGUMENT.

List of acknowledgement IDs whose deadline will be modified based on the corresponding element in modify_deadline_seconds. This field can be used 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.

StreamingPullResponse

Response for the StreamingPull method. This response is used to stream messages from the server to the client.

Subscription

A subscription resource.

The name of the topic from which this subscription is receiving messages. Format is projects/{project}/topics/{topic}. The value of this field will be _deleted-topic_ if the topic has been deleted.

The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call ModifyAckDeadline with the corresponding ack_id if using non-streaming pull or send the ack_id in a StreamingModifyAckDeadlineRequest if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message.

How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If retain_acked_messages is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a Seek can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.

If true, messages published with the same ordering_key in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order. EXPERIMENTAL: This feature is part of a closed alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Cloud Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa- pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription. EXPERIMENTAL: This feature is part of a closed alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

TestIamPermissionsRequest

API documentation for pubsub_v1.types.TestIamPermissionsRequest class.

TestIamPermissionsResponse

API documentation for pubsub_v1.types.TestIamPermissionsResponse class.

Timestamp

API documentation for pubsub_v1.types.Timestamp class.

Topic

A topic resource.

See Creating and managing labels.

The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.

UninterpretedOption

API documentation for pubsub_v1.types.UninterpretedOption class.

UpdateSnapshotRequest

Request for the UpdateSnapshot method.

Indicates which fields in the provided snapshot to update. Must be specified and non-empty.

UpdateSubscriptionRequest

Request for the UpdateSubscription method.

Indicates which fields in the provided subscription to update. Must be specified and non-empty.

UpdateTopicRequest

Request for the UpdateTopic method.

Indicates which fields in the provided topic to update. Must be specified and non-empty. Note that if update_mask contains "message_storage_policy" then the new value will be determined based on the policy configured at the project or organization level. The message_storage_policy must not be set in the topic provided above.