Pub/Sub Client Types
class google.cloud.pubsub_v1.types.AcknowledgeRequest()
Request for the Acknowledge method.
subscription()
The subscription whose message is being acknowledged. Format
is projects/{project}/subscriptions/{sub}.
ack_ids()
The acknowledgment ID for the messages being acknowledged that
was returned by the Pub/Sub system in the Pull response.
Must not be empty.
ack_ids()
Field google.pubsub.v1.AcknowledgeRequest.ack_ids
subscription()
Field google.pubsub.v1.AcknowledgeRequest.subscription
class google.cloud.pubsub_v1.types.AuditConfig()
audit_log_configs()
Field google.iam.v1.AuditConfig.audit_log_configs
service()
Field google.iam.v1.AuditConfig.service
class google.cloud.pubsub_v1.types.AuditConfigDelta()
action()
Field google.iam.v1.AuditConfigDelta.action
exempted_member()
Field google.iam.v1.AuditConfigDelta.exempted_member
log_type()
Field google.iam.v1.AuditConfigDelta.log_type
service()
Field google.iam.v1.AuditConfigDelta.service
class google.cloud.pubsub_v1.types.AuditData()
policy_delta()
Field google.iam.v1.logging.AuditData.policy_delta
class google.cloud.pubsub_v1.types.AuditLogConfig()
exempted_members()
Field google.iam.v1.AuditLogConfig.exempted_members
log_type()
Field google.iam.v1.AuditLogConfig.log_type
class google.cloud.pubsub_v1.types.BatchSettings(max_bytes=10000000, max_latency=0.05, max_messages=1000)
The settings for batch publishing the messages.
Create new instance of BatchSettings(max_bytes, max_latency, max_messages)
max_bytes()
The maximum total size of the messages to collect before automatically publishing the batch.
max_latency()
The maximum number of seconds to wait for additional messages before automatically publishing the batch.
max_messages()
The maximum number of messages to collect before automatically publishing the batch.
class google.cloud.pubsub_v1.types.Binding()
condition()
Field google.iam.v1.Binding.condition
members()
Field google.iam.v1.Binding.members
role()
Field google.iam.v1.Binding.role
class google.cloud.pubsub_v1.types.BindingDelta()
action()
Field google.iam.v1.BindingDelta.action
condition()
Field google.iam.v1.BindingDelta.condition
member()
Field google.iam.v1.BindingDelta.member
role()
Field google.iam.v1.BindingDelta.role
class google.cloud.pubsub_v1.types.CreateSnapshotRequest()
Request for the CreateSnapshot method.
name()
Optional user-provided name for this snapshot. If the name is
not provided in the request, the server will assign a random
name for this snapshot on the same project as the
subscription. Note that for REST API requests, you must
specify a name. See the resource name rules. Format is
projects/{project}/snapshots/{snap}.
subscription()
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}.
labels()
See Creating and managing labels.
class LabelsEntry()
key()
Field google.pubsub.v1.CreateSnapshotRequest.LabelsEntry.key
value()
Field google.pubsub.v1.CreateSnapshotRequest.LabelsEntry.value
labels()
Field google.pubsub.v1.CreateSnapshotRequest.labels
name()
Field google.pubsub.v1.CreateSnapshotRequest.name
subscription()
Field google.pubsub.v1.CreateSnapshotRequest.subscription
class google.cloud.pubsub_v1.types.CustomHttpPattern()
kind()
Field google.api.CustomHttpPattern.kind
path()
Field google.api.CustomHttpPattern.path
class google.cloud.pubsub_v1.types.DeleteSnapshotRequest()
Request for the DeleteSnapshot method.
snapshot()
The name of the snapshot to delete. Format is
projects/{project}/snapshots/{snap}.
snapshot()
Field google.pubsub.v1.DeleteSnapshotRequest.snapshot
class google.cloud.pubsub_v1.types.DeleteSubscriptionRequest()
Request for the DeleteSubscription method.
subscription()
The subscription to delete. Format is
projects/{project}/subscriptions/{sub}.
subscription()
Field google.pubsub.v1.DeleteSubscriptionRequest.subscription
class google.cloud.pubsub_v1.types.DeleteTopicRequest()
Request for the DeleteTopic method.
topic()
Name of the topic to delete. Format is
projects/{project}/topics/{topic}.
topic()
Field google.pubsub.v1.DeleteTopicRequest.topic
class google.cloud.pubsub_v1.types.DescriptorProto()
class ExtensionRange()
end()
Field google.protobuf.DescriptorProto.ExtensionRange.end
options()
Field google.protobuf.DescriptorProto.ExtensionRange.options
start()
Field google.protobuf.DescriptorProto.ExtensionRange.start
class ReservedRange()
end()
Field google.protobuf.DescriptorProto.ReservedRange.end
start()
Field google.protobuf.DescriptorProto.ReservedRange.start
enum_type()
Field google.protobuf.DescriptorProto.enum_type
extension()
Field google.protobuf.DescriptorProto.extension
extension_range()
Field google.protobuf.DescriptorProto.extension_range
field()
Field google.protobuf.DescriptorProto.field
name()
Field google.protobuf.DescriptorProto.name
nested_type()
Field google.protobuf.DescriptorProto.nested_type
oneof_decl()
Field google.protobuf.DescriptorProto.oneof_decl
options()
Field google.protobuf.DescriptorProto.options
reserved_name()
Field google.protobuf.DescriptorProto.reserved_name
reserved_range()
Field google.protobuf.DescriptorProto.reserved_range
class google.cloud.pubsub_v1.types.Duration()
nanos()
Field google.protobuf.Duration.nanos
seconds()
Field google.protobuf.Duration.seconds
class google.cloud.pubsub_v1.types.Empty()
class google.cloud.pubsub_v1.types.EnumDescriptorProto()
class EnumReservedRange()
end()
Field google.protobuf.EnumDescriptorProto.EnumReservedRange.end
start()
Field google.protobuf.EnumDescriptorProto.EnumReservedRange.start
name()
Field google.protobuf.EnumDescriptorProto.name
options()
Field google.protobuf.EnumDescriptorProto.options
reserved_name()
Field google.protobuf.EnumDescriptorProto.reserved_name
reserved_range()
Field google.protobuf.EnumDescriptorProto.reserved_range
value()
Field google.protobuf.EnumDescriptorProto.value
class google.cloud.pubsub_v1.types.EnumOptions()
allow_alias()
Field google.protobuf.EnumOptions.allow_alias
deprecated()
Field google.protobuf.EnumOptions.deprecated
uninterpreted_option()
Field google.protobuf.EnumOptions.uninterpreted_option
class google.cloud.pubsub_v1.types.EnumValueDescriptorProto()
name()
Field google.protobuf.EnumValueDescriptorProto.name
number()
Field google.protobuf.EnumValueDescriptorProto.number
options()
Field google.protobuf.EnumValueDescriptorProto.options
class google.cloud.pubsub_v1.types.EnumValueOptions()
deprecated()
Field google.protobuf.EnumValueOptions.deprecated
uninterpreted_option()
Field google.protobuf.EnumValueOptions.uninterpreted_option
class google.cloud.pubsub_v1.types.ExpirationPolicy()
A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).
ttl()
Specifies the “time-to-live” duration for an associated
resource. The resource expires if it is not active for a
period of ttl. The definition of “activity” depends on the
type of the associated resource. The minimum and maximum
allowed values for ttl depend on the type of the
associated resource, as well. If ttl is not set, the
associated resource never expires.
ttl()
Field google.pubsub.v1.ExpirationPolicy.ttl
class google.cloud.pubsub_v1.types.ExtensionRangeOptions()
uninterpreted_option()
Field google.protobuf.ExtensionRangeOptions.uninterpreted_option
class google.cloud.pubsub_v1.types.FieldDescriptorProto()
default_value()
Field google.protobuf.FieldDescriptorProto.default_value
extendee()
Field google.protobuf.FieldDescriptorProto.extendee
json_name()
Field google.protobuf.FieldDescriptorProto.json_name
label()
Field google.protobuf.FieldDescriptorProto.label
name()
Field google.protobuf.FieldDescriptorProto.name
number()
Field google.protobuf.FieldDescriptorProto.number
oneof_index()
Field google.protobuf.FieldDescriptorProto.oneof_index
options()
Field google.protobuf.FieldDescriptorProto.options
proto3_optional()
Field google.protobuf.FieldDescriptorProto.proto3_optional
type()
Field google.protobuf.FieldDescriptorProto.type
type_name()
Field google.protobuf.FieldDescriptorProto.type_name
class google.cloud.pubsub_v1.types.FieldMask()
paths()
Field google.protobuf.FieldMask.paths
class google.cloud.pubsub_v1.types.FieldOptions()
ctype()
Field google.protobuf.FieldOptions.ctype
deprecated()
Field google.protobuf.FieldOptions.deprecated
jstype()
Field google.protobuf.FieldOptions.jstype
lazy()
Field google.protobuf.FieldOptions.lazy
packed()
Field google.protobuf.FieldOptions.packed
uninterpreted_option()
Field google.protobuf.FieldOptions.uninterpreted_option
unverified_lazy()
Field google.protobuf.FieldOptions.unverified_lazy
weak()
Field google.protobuf.FieldOptions.weak
class google.cloud.pubsub_v1.types.FileDescriptorProto()
dependency()
Field google.protobuf.FileDescriptorProto.dependency
enum_type()
Field google.protobuf.FileDescriptorProto.enum_type
extension()
Field google.protobuf.FileDescriptorProto.extension
message_type()
Field google.protobuf.FileDescriptorProto.message_type
name()
Field google.protobuf.FileDescriptorProto.name
options()
Field google.protobuf.FileDescriptorProto.options
package()
Field google.protobuf.FileDescriptorProto.package
public_dependency()
Field google.protobuf.FileDescriptorProto.public_dependency
service()
Field google.protobuf.FileDescriptorProto.service
source_code_info()
Field google.protobuf.FileDescriptorProto.source_code_info
syntax()
Field google.protobuf.FileDescriptorProto.syntax
weak_dependency()
Field google.protobuf.FileDescriptorProto.weak_dependency
class google.cloud.pubsub_v1.types.FileDescriptorSet()
file()
Field google.protobuf.FileDescriptorSet.file
class google.cloud.pubsub_v1.types.FileOptions()
cc_enable_arenas()
Field google.protobuf.FileOptions.cc_enable_arenas
cc_generic_services()
Field google.protobuf.FileOptions.cc_generic_services
csharp_namespace()
Field google.protobuf.FileOptions.csharp_namespace
deprecated()
Field google.protobuf.FileOptions.deprecated
go_package()
Field google.protobuf.FileOptions.go_package
java_generate_equals_and_hash()
Field google.protobuf.FileOptions.java_generate_equals_and_hash
java_generic_services()
Field google.protobuf.FileOptions.java_generic_services
java_multiple_files()
Field google.protobuf.FileOptions.java_multiple_files
java_outer_classname()
Field google.protobuf.FileOptions.java_outer_classname
java_package()
Field google.protobuf.FileOptions.java_package
java_string_check_utf8()
Field google.protobuf.FileOptions.java_string_check_utf8
objc_class_prefix()
Field google.protobuf.FileOptions.objc_class_prefix
optimize_for()
Field google.protobuf.FileOptions.optimize_for
php_class_prefix()
Field google.protobuf.FileOptions.php_class_prefix
php_generic_services()
Field google.protobuf.FileOptions.php_generic_services
php_metadata_namespace()
Field google.protobuf.FileOptions.php_metadata_namespace
php_namespace()
Field google.protobuf.FileOptions.php_namespace
py_generic_services()
Field google.protobuf.FileOptions.py_generic_services
ruby_package()
Field google.protobuf.FileOptions.ruby_package
swift_prefix()
Field google.protobuf.FileOptions.swift_prefix
uninterpreted_option()
Field google.protobuf.FileOptions.uninterpreted_option
class google.cloud.pubsub_v1.types.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.
Create new instance of FlowControl(max_bytes, max_messages, max_lease_duration)
max_bytes()
The maximum total size of received - but not yet processed - messages before pausing the message stream.
max_lease_duration()
The maximum amount of time in seconds to hold a lease on a message before dropping it from the lease management.
max_messages()
The maximum number of received - but not yet processed - messages before pausing the message stream.
class google.cloud.pubsub_v1.types.GeneratedCodeInfo()
class Annotation()
begin()
Field google.protobuf.GeneratedCodeInfo.Annotation.begin
end()
Field google.protobuf.GeneratedCodeInfo.Annotation.end
path()
Field google.protobuf.GeneratedCodeInfo.Annotation.path
source_file()
Field google.protobuf.GeneratedCodeInfo.Annotation.source_file
annotation()
Field google.protobuf.GeneratedCodeInfo.annotation
class google.cloud.pubsub_v1.types.GetIamPolicyRequest()
options()
Field google.iam.v1.GetIamPolicyRequest.options
resource()
Field google.iam.v1.GetIamPolicyRequest.resource
class google.cloud.pubsub_v1.types.GetSnapshotRequest()
Request for the GetSnapshot method.
snapshot()
The name of the snapshot to get. Format is
projects/{project}/snapshots/{snap}.
snapshot()
Field google.pubsub.v1.GetSnapshotRequest.snapshot
class google.cloud.pubsub_v1.types.GetSubscriptionRequest()
Request for the GetSubscription method.
subscription()
The name of the subscription to get. Format is
projects/{project}/subscriptions/{sub}.
subscription()
Field google.pubsub.v1.GetSubscriptionRequest.subscription
class google.cloud.pubsub_v1.types.GetTopicRequest()
Request for the GetTopic method.
topic()
The name of the topic to get. Format is
projects/{project}/topics/{topic}.
topic()
Field google.pubsub.v1.GetTopicRequest.topic
class google.cloud.pubsub_v1.types.Http()
fully_decode_reserved_expansion()
Field google.api.Http.fully_decode_reserved_expansion
rules()
Field google.api.Http.rules
class google.cloud.pubsub_v1.types.HttpRule()
additional_bindings()
Field google.api.HttpRule.additional_bindings
body()
Field google.api.HttpRule.body
custom()
Field google.api.HttpRule.custom
delete()
Field google.api.HttpRule.delete
get()
Field google.api.HttpRule.get
patch()
Field google.api.HttpRule.patch
post()
Field google.api.HttpRule.post
put()
Field google.api.HttpRule.put
response_body()
Field google.api.HttpRule.response_body
selector()
Field google.api.HttpRule.selector
class google.cloud.pubsub_v1.types.ListSnapshotsRequest()
Request for the ListSnapshots method.
project()
The name of the project in which to list snapshots. Format is
projects/{project-id}.
page_size()
Maximum number of snapshots to return.
page_token()
The value returned by the last ListSnapshotsResponse;
indicates that this is a continuation of a prior
ListSnapshots call, and that the system should return the
next page of data.
page_size()
Field google.pubsub.v1.ListSnapshotsRequest.page_size
page_token()
Field google.pubsub.v1.ListSnapshotsRequest.page_token
project()
Field google.pubsub.v1.ListSnapshotsRequest.project
class google.cloud.pubsub_v1.types.ListSnapshotsResponse()
Response for the ListSnapshots method.
snapshots()
The resulting snapshots.
next_page_token()
If not empty, indicates that there may be more snapshot that
match the request; this value should be passed in a new
ListSnapshotsRequest.
next_page_token()
Field google.pubsub.v1.ListSnapshotsResponse.next_page_token
snapshots()
Field google.pubsub.v1.ListSnapshotsResponse.snapshots
class google.cloud.pubsub_v1.types.ListSubscriptionsRequest()
Request for the ListSubscriptions method.
project()
The name of the project in which to list subscriptions. Format
is projects/{project-id}.
page_size()
Maximum number of subscriptions to return.
page_token()
The value returned by the last ListSubscriptionsResponse;
indicates that this is a continuation of a prior
ListSubscriptions call, and that the system should return
the next page of data.
page_size()
Field google.pubsub.v1.ListSubscriptionsRequest.page_size
page_token()
Field google.pubsub.v1.ListSubscriptionsRequest.page_token
project()
Field google.pubsub.v1.ListSubscriptionsRequest.project
class google.cloud.pubsub_v1.types.ListSubscriptionsResponse()
Response for the ListSubscriptions method.
subscriptions()
The subscriptions that match the request.
next_page_token()
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.
next_page_token()
Field google.pubsub.v1.ListSubscriptionsResponse.next_page_token
subscriptions()
Field google.pubsub.v1.ListSubscriptionsResponse.subscriptions
class google.cloud.pubsub_v1.types.ListTopicSnapshotsRequest()
Request for the ListTopicSnapshots method.
topic()
The name of the topic that snapshots are attached to. Format
is projects/{project}/topics/{topic}.
page_size()
Maximum number of snapshot names to return.
page_token()
The value returned by the last ListTopicSnapshotsResponse;
indicates that this is a continuation of a prior
ListTopicSnapshots call, and that the system should return
the next page of data.
page_size()
Field google.pubsub.v1.ListTopicSnapshotsRequest.page_size
page_token()
Field google.pubsub.v1.ListTopicSnapshotsRequest.page_token
topic()
Field google.pubsub.v1.ListTopicSnapshotsRequest.topic
class google.cloud.pubsub_v1.types.ListTopicSnapshotsResponse()
Response for the ListTopicSnapshots method.
snapshots()
The names of the snapshots that match the request.
next_page_token()
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.
next_page_token()
Field google.pubsub.v1.ListTopicSnapshotsResponse.next_page_token
snapshots()
Field google.pubsub.v1.ListTopicSnapshotsResponse.snapshots
class google.cloud.pubsub_v1.types.ListTopicSubscriptionsRequest()
Request for the ListTopicSubscriptions method.
topic()
The name of the topic that subscriptions are attached to.
Format is projects/{project}/topics/{topic}.
page_size()
Maximum number of subscription names to return.
page_token()
The value returned by the last
ListTopicSubscriptionsResponse; indicates that this is a
continuation of a prior ListTopicSubscriptions call, and
that the system should return the next page of data.
page_size()
Field google.pubsub.v1.ListTopicSubscriptionsRequest.page_size
page_token()
Field google.pubsub.v1.ListTopicSubscriptionsRequest.page_token
topic()
Field google.pubsub.v1.ListTopicSubscriptionsRequest.topic
class google.cloud.pubsub_v1.types.ListTopicSubscriptionsResponse()
Response for the ListTopicSubscriptions method.
subscriptions()
The names of the subscriptions that match the request.
next_page_token()
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.
next_page_token()
Field google.pubsub.v1.ListTopicSubscriptionsResponse.next_page_token
subscriptions()
Field google.pubsub.v1.ListTopicSubscriptionsResponse.subscriptions
class google.cloud.pubsub_v1.types.ListTopicsRequest()
Request for the ListTopics method.
project()
The name of the project in which to list topics. Format is
projects/{project-id}.
page_size()
Maximum number of topics to return.
page_token()
The value returned by the last ListTopicsResponse;
indicates that this is a continuation of a prior
ListTopics call, and that the system should return the
next page of data.
page_size()
Field google.pubsub.v1.ListTopicsRequest.page_size
page_token()
Field google.pubsub.v1.ListTopicsRequest.page_token
project()
Field google.pubsub.v1.ListTopicsRequest.project
class google.cloud.pubsub_v1.types.ListTopicsResponse()
Response for the ListTopics method.
topics()
The resulting topics.
next_page_token()
If not empty, indicates that there may be more topics that
match the request; this value should be passed in a new
ListTopicsRequest.
next_page_token()
Field google.pubsub.v1.ListTopicsResponse.next_page_token
topics()
Field google.pubsub.v1.ListTopicsResponse.topics
class google.cloud.pubsub_v1.types.MessageOptions()
deprecated()
Field google.protobuf.MessageOptions.deprecated
map_entry()
Field google.protobuf.MessageOptions.map_entry
message_set_wire_format()
Field google.protobuf.MessageOptions.message_set_wire_format
no_standard_descriptor_accessor()
Field google.protobuf.MessageOptions.no_standard_descriptor_accessor
uninterpreted_option()
Field google.protobuf.MessageOptions.uninterpreted_option
class google.cloud.pubsub_v1.types.MessageStoragePolicy()
A message storage policy.
allowed_persistence_regions()
The list of GCP region IDs where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list indicates a misconfiguration at the project or organization level, which will result in all Publish operations failing.
allowed_persistence_regions()
Field google.pubsub.v1.MessageStoragePolicy.allowed_persistence_regions
class google.cloud.pubsub_v1.types.MethodDescriptorProto()
client_streaming()
Field google.protobuf.MethodDescriptorProto.client_streaming
input_type()
Field google.protobuf.MethodDescriptorProto.input_type
name()
Field google.protobuf.MethodDescriptorProto.name
options()
Field google.protobuf.MethodDescriptorProto.options
output_type()
Field google.protobuf.MethodDescriptorProto.output_type
server_streaming()
Field google.protobuf.MethodDescriptorProto.server_streaming
class google.cloud.pubsub_v1.types.MethodOptions()
deprecated()
Field google.protobuf.MethodOptions.deprecated
idempotency_level()
Field google.protobuf.MethodOptions.idempotency_level
uninterpreted_option()
Field google.protobuf.MethodOptions.uninterpreted_option
class google.cloud.pubsub_v1.types.ModifyAckDeadlineRequest()
Request for the ModifyAckDeadline method.
subscription()
The name of the subscription. Format is
projects/{project}/subscriptions/{sub}.
ack_ids()
List of acknowledgment IDs.
ack_deadline_seconds()
The new ack deadline with respect to the time this request was
sent to the Pub/Sub system. For example, if the value is 10,
the new ack deadline will expire 10 seconds after the
ModifyAckDeadline call was made. Specifying zero might
immediately make the message available for delivery to another
subscriber client. This typically results in an increase in
the rate of message redeliveries (that is, duplicates). The
minimum deadline you can specify is 0 seconds. The maximum
deadline you can specify is 600 seconds (10 minutes).
ack_deadline_seconds()
Field google.pubsub.v1.ModifyAckDeadlineRequest.ack_deadline_seconds
ack_ids()
Field google.pubsub.v1.ModifyAckDeadlineRequest.ack_ids
subscription()
Field google.pubsub.v1.ModifyAckDeadlineRequest.subscription
class google.cloud.pubsub_v1.types.ModifyPushConfigRequest()
Request for the ModifyPushConfig method.
subscription()
The name of the subscription. Format is
projects/{project}/subscriptions/{sub}.
push_config()
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.
push_config()
Field google.pubsub.v1.ModifyPushConfigRequest.push_config
subscription()
Field google.pubsub.v1.ModifyPushConfigRequest.subscription
class google.cloud.pubsub_v1.types.OneofDescriptorProto()
name()
Field google.protobuf.OneofDescriptorProto.name
options()
Field google.protobuf.OneofDescriptorProto.options
class google.cloud.pubsub_v1.types.OneofOptions()
uninterpreted_option()
Field google.protobuf.OneofOptions.uninterpreted_option
class google.cloud.pubsub_v1.types.Policy()
audit_configs()
Field google.iam.v1.Policy.audit_configs
bindings()
Field google.iam.v1.Policy.bindings
etag()
Field google.iam.v1.Policy.etag
version()
Field google.iam.v1.Policy.version
class google.cloud.pubsub_v1.types.PolicyDelta()
audit_config_deltas()
Field google.iam.v1.PolicyDelta.audit_config_deltas
binding_deltas()
Field google.iam.v1.PolicyDelta.binding_deltas
class google.cloud.pubsub_v1.types.PublishRequest()
Request for the Publish method.
topic()
The messages in the request will be published on this topic.
Format is projects/{project}/topics/{topic}.
messages()
The messages to publish.
messages()
Field google.pubsub.v1.PublishRequest.messages
topic()
Field google.pubsub.v1.PublishRequest.topic
class google.cloud.pubsub_v1.types.PublishResponse()
Response for the Publish method.
message_ids()
The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.
message_ids()
Field google.pubsub.v1.PublishResponse.message_ids
class google.cloud.pubsub_v1.types.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.
data()
The message data field. If this field is empty, the message must contain at least one attribute.
attributes()
Optional attributes for this message.
message_id()
ID of this message, assigned by the server when the message is
published. Guaranteed to be unique within the topic. This
value may be read by a subscriber that receives a
PubsubMessage via a Pull call or a push delivery. It
must not be populated by the publisher in a Publish call.
publish_time()
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.
ordering_key()
Identifies related messages for which publish order should be
respected. If a Subscription has
enable_message_ordering set to true, messages
published with the same ordering_key value will be
delivered to subscribers in the order in which they are
received by the Pub/Sub system. 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.
class AttributesEntry()
key()
Field google.pubsub.v1.PubsubMessage.AttributesEntry.key
value()
Field google.pubsub.v1.PubsubMessage.AttributesEntry.value
attributes()
Field google.pubsub.v1.PubsubMessage.attributes
data()
Field google.pubsub.v1.PubsubMessage.data
message_id()
Field google.pubsub.v1.PubsubMessage.message_id
ordering_key()
Field google.pubsub.v1.PubsubMessage.ordering_key
publish_time()
Field google.pubsub.v1.PubsubMessage.publish_time
class google.cloud.pubsub_v1.types.PullRequest()
Request for the Pull method.
subscription()
The subscription from which messages should be pulled. Format
is projects/{project}/subscriptions/{sub}.
return_immediately()
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.
max_messages()
The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified.
max_messages()
Field google.pubsub.v1.PullRequest.max_messages
return_immediately()
Field google.pubsub.v1.PullRequest.return_immediately
subscription()
Field google.pubsub.v1.PullRequest.subscription
class google.cloud.pubsub_v1.types.PullResponse()
Response for the Pull method.
received_messages()
Received Pub/Sub messages. The list will be empty if there are
no more messages available in the backlog. For JSON, the
response can be entirely empty. The Pub/Sub system may return
fewer than the maxMessages requested even if there are
more messages available in the backlog.
received_messages()
Field google.pubsub.v1.PullResponse.received_messages
class google.cloud.pubsub_v1.types.PushConfig()
Configuration for a push delivery endpoint.
push_endpoint()
A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use “https://example.com/push”.
attributes()
Endpoint configuration attributes. Every endpoint has a set
of API supported attributes that can be used to control
different aspects of the message delivery. The 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). The endpoint version is based on the
version of the Pub/Sub API. If not present during the
CreateSubscription call, it will default to the version of
the API used to make such call. If not present during 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 possible values for this 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.
authentication_method()
An authentication method used by push endpoints to verify the source of push requests. This can be used with push endpoints that are private by default to allow requests only from the Cloud Pub/Sub system, for example. This field is optional and should be set only by users interested in authenticated push.
oidc_token()
If specified, Pub/Sub will generate and attach an OIDC JWT
token as an Authorization header in the HTTP request for
every pushed message.
class AttributesEntry()
key()
Field google.pubsub.v1.PushConfig.AttributesEntry.key
value()
Field google.pubsub.v1.PushConfig.AttributesEntry.value
class OidcToken()
Contains information needed for generating an OpenID Connect token.
service_account_email()
Service account email to be used for generating the OIDC token. The caller (for CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must have the iam.serviceAccounts.actAs permission for the service account.
audience()
Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.
audience()
Field google.pubsub.v1.PushConfig.OidcToken.audience
service_account_email()
Field google.pubsub.v1.PushConfig.OidcToken.service_account_email
attributes()
Field google.pubsub.v1.PushConfig.attributes
oidc_token()
Field google.pubsub.v1.PushConfig.oidc_token
push_endpoint()
Field google.pubsub.v1.PushConfig.push_endpoint
class google.cloud.pubsub_v1.types.ReceivedMessage()
A message and its corresponding acknowledgment ID.
ack_id()
This ID can be used to acknowledge the received message.
message()
The message.
ack_id()
Field google.pubsub.v1.ReceivedMessage.ack_id
message()
Field google.pubsub.v1.ReceivedMessage.message
class google.cloud.pubsub_v1.types.SeekRequest()
Request for the Seek method.
subscription()
The subscription to affect.
time()
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.
snapshot()
The snapshot to seek to. The snapshot’s topic must be the same
as that of the provided subscription. Format is
projects/{project}/snapshots/{snap}.
snapshot()
Field google.pubsub.v1.SeekRequest.snapshot
subscription()
Field google.pubsub.v1.SeekRequest.subscription
time()
Field google.pubsub.v1.SeekRequest.time
class google.cloud.pubsub_v1.types.SeekResponse()
Response for the Seek method (this response is empty).
class google.cloud.pubsub_v1.types.ServiceDescriptorProto()
method()
Field google.protobuf.ServiceDescriptorProto.method
name()
Field google.protobuf.ServiceDescriptorProto.name
options()
Field google.protobuf.ServiceDescriptorProto.options
class google.cloud.pubsub_v1.types.ServiceOptions()
deprecated()
Field google.protobuf.ServiceOptions.deprecated
uninterpreted_option()
Field google.protobuf.ServiceOptions.uninterpreted_option
class google.cloud.pubsub_v1.types.SetIamPolicyRequest()
policy()
Field google.iam.v1.SetIamPolicyRequest.policy
resource()
Field google.iam.v1.SetIamPolicyRequest.resource
update_mask()
Field google.iam.v1.SetIamPolicyRequest.update_mask
class google.cloud.pubsub_v1.types.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.
name()
The name of the snapshot.
topic()
The name of the topic from which this snapshot is retaining messages.
expire_time()
The snapshot is guaranteed to exist up until this time. A
newly-created snapshot expires no later than 7 days from the
time of its creation. Its exact lifetime is determined at
creation by the existing backlog in the source subscription.
Specifically, the lifetime of the snapshot is 7 days - (age
of oldest unacked message in the subscription). For example,
consider a subscription whose oldest unacked message is 3 days
old. If a snapshot is created from this subscription, the
snapshot – which will always capture this 3-day-old backlog
as long as the snapshot exists – will expire in 4 days. The
service will refuse to create a snapshot that would expire in
less than 1 hour after creation.
labels()
See Creating and managing labels.
class LabelsEntry()
key()
Field google.pubsub.v1.Snapshot.LabelsEntry.key
value()
Field google.pubsub.v1.Snapshot.LabelsEntry.value
expire_time()
Field google.pubsub.v1.Snapshot.expire_time
labels()
Field google.pubsub.v1.Snapshot.labels
name()
Field google.pubsub.v1.Snapshot.name
topic()
Field google.pubsub.v1.Snapshot.topic
class google.cloud.pubsub_v1.types.SourceCodeInfo()
class Location()
leading_comments()
Field google.protobuf.SourceCodeInfo.Location.leading_comments
leading_detached_comments()
Field google.protobuf.SourceCodeInfo.Location.leading_detached_comments
path()
Field google.protobuf.SourceCodeInfo.Location.path
span()
Field google.protobuf.SourceCodeInfo.Location.span
trailing_comments()
Field google.protobuf.SourceCodeInfo.Location.trailing_comments
location()
Field google.protobuf.SourceCodeInfo.location
class google.cloud.pubsub_v1.types.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.
subscription()
The subscription for which to initialize the new stream. This
must be provided in the first request on the stream, and must
not be set in subsequent requests from client to server.
Format is projects/{project}/subscriptions/{sub}.
ack_ids()
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.
modify_deadline_seconds()
The list of new ack deadlines for the IDs listed in
modify_deadline_ack_ids. The size of this list must be the
same as the size of modify_deadline_ack_ids. If it differs
the stream will be aborted with INVALID_ARGUMENT. Each
element in this list is applied to the element in the same
position in modify_deadline_ack_ids. The new ack deadline
is with respect to the time this request was sent to the
Pub/Sub system. Must be >= 0. For example, if the value is 10,
the new ack deadline will expire 10 seconds after this request
is received. If the value is 0, the message is immediately
made available for another streaming or non-streaming pull
request. If the value is < 0 (an error), the stream will be
aborted with status INVALID_ARGUMENT.
modify_deadline_ack_ids()
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.
stream_ack_deadline_seconds()
The ack deadline to use for the stream. This must be provided in the first request on the stream, but it can also be updated on subsequent requests from client to server. The minimum deadline you can specify is 10 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).
ack_ids()
Field google.pubsub.v1.StreamingPullRequest.ack_ids
modify_deadline_ack_ids()
Field google.pubsub.v1.StreamingPullRequest.modify_deadline_ack_ids
modify_deadline_seconds()
Field google.pubsub.v1.StreamingPullRequest.modify_deadline_seconds
stream_ack_deadline_seconds()
Field google.pubsub.v1.StreamingPullRequest.stream_ack_deadline_seconds
subscription()
Field google.pubsub.v1.StreamingPullRequest.subscription
class google.cloud.pubsub_v1.types.StreamingPullResponse()
Response for the StreamingPull method. This response is used to
stream messages from the server to the client.
received_messages()
Received Pub/Sub messages. This will not be empty.
received_messages()
Field google.pubsub.v1.StreamingPullResponse.received_messages
class google.cloud.pubsub_v1.types.Subscription()
A subscription resource.
name()
The name of the subscription. It must have the format
"projects/{project}/subscriptions/{subscription}".
{subscription} must start with a letter, and contain only
letters ([A-Za-z]), numbers ([0-9]), dashes (-),
underscores (_), periods (.), tildes (~), plus
(+) or percent signs (%). It must be between 3 and 255
characters in length, and it must not start with "goog".
topic()
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.
push_config()
If push delivery is used with this subscription, this field is
used to configure it. An empty pushConfig signifies that
the subscriber will pull and ack messages using API methods.
ack_deadline_seconds()
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.
retain_acked_messages()
Indicates whether to retain acknowledged messages. If true,
then messages are not expunged from the subscription’s
backlog, even if they are acknowledged, until they fall out of
the message_retention_duration window. This must be true
if you would like to Seek to a timestamp.
message_retention_duration()
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.
labels()
See Creating and managing labels.
enable_message_ordering()
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.
expiration_policy()
A policy that specifies the conditions for this subscription’s
expiration. A subscription is considered active as long as any
connected subscriber is successfully consuming messages from
the subscription or is issuing operations on the subscription.
If expiration_policy is not set, a default policy with
ttl of 31 days will be used. The minimum allowed value for
expiration_policy.ttl is 1 day.
class LabelsEntry()
key()
Field google.pubsub.v1.Subscription.LabelsEntry.key
value()
Field google.pubsub.v1.Subscription.LabelsEntry.value
ack_deadline_seconds()
Field google.pubsub.v1.Subscription.ack_deadline_seconds
enable_message_ordering()
Field google.pubsub.v1.Subscription.enable_message_ordering
expiration_policy()
Field google.pubsub.v1.Subscription.expiration_policy
labels()
Field google.pubsub.v1.Subscription.labels
message_retention_duration()
Field google.pubsub.v1.Subscription.message_retention_duration
name()
Field google.pubsub.v1.Subscription.name
push_config()
Field google.pubsub.v1.Subscription.push_config
retain_acked_messages()
Field google.pubsub.v1.Subscription.retain_acked_messages
topic()
Field google.pubsub.v1.Subscription.topic
class google.cloud.pubsub_v1.types.TestIamPermissionsRequest()
permissions()
Field google.iam.v1.TestIamPermissionsRequest.permissions
resource()
Field google.iam.v1.TestIamPermissionsRequest.resource
class google.cloud.pubsub_v1.types.TestIamPermissionsResponse()
permissions()
Field google.iam.v1.TestIamPermissionsResponse.permissions
class google.cloud.pubsub_v1.types.Timestamp()
nanos()
Field google.protobuf.Timestamp.nanos
seconds()
Field google.protobuf.Timestamp.seconds
class google.cloud.pubsub_v1.types.Topic()
A topic resource.
name()
The name of the topic. It must have the format
"projects/{project}/topics/{topic}". {topic} must
start with a letter, and contain only letters ([A-Za-z]),
numbers ([0-9]), dashes (-), underscores (_),
periods (.), tildes (~), plus (+) or percent signs
(%). It must be between 3 and 255 characters in length,
and it must not start with "goog".
labels()
See Creating and managing labels.
message_storage_policy()
Policy constraining how messages published to the topic may be stored. It is determined when the topic is created based on the policy configured at the project level. It must not be set by the caller in the request to CreateTopic or to UpdateTopic. This field will be populated in the responses for GetTopic, CreateTopic, and UpdateTopic: if not present in the response, then no constraints are in effect.
kms_key_name()
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/\*.
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.
class LabelsEntry()
key()
Field google.pubsub.v1.Topic.LabelsEntry.key
value()
Field google.pubsub.v1.Topic.LabelsEntry.value
kms_key_name()
Field google.pubsub.v1.Topic.kms_key_name
labels()
Field google.pubsub.v1.Topic.labels
message_storage_policy()
Field google.pubsub.v1.Topic.message_storage_policy
name()
Field google.pubsub.v1.Topic.name
class google.cloud.pubsub_v1.types.UninterpretedOption()
class NamePart()
is_extension()
Field google.protobuf.UninterpretedOption.NamePart.is_extension
name_part()
Field google.protobuf.UninterpretedOption.NamePart.name_part
aggregate_value()
Field google.protobuf.UninterpretedOption.aggregate_value
double_value()
Field google.protobuf.UninterpretedOption.double_value
identifier_value()
Field google.protobuf.UninterpretedOption.identifier_value
name()
Field google.protobuf.UninterpretedOption.name
negative_int_value()
Field google.protobuf.UninterpretedOption.negative_int_value
positive_int_value()
Field google.protobuf.UninterpretedOption.positive_int_value
string_value()
Field google.protobuf.UninterpretedOption.string_value
class google.cloud.pubsub_v1.types.UpdateSnapshotRequest()
Request for the UpdateSnapshot method.
snapshot()
The updated snapshot object.
update_mask()
Indicates which fields in the provided snapshot to update. Must be specified and non-empty.
snapshot()
Field google.pubsub.v1.UpdateSnapshotRequest.snapshot
update_mask()
Field google.pubsub.v1.UpdateSnapshotRequest.update_mask
class google.cloud.pubsub_v1.types.UpdateSubscriptionRequest()
Request for the UpdateSubscription method.
subscription()
The updated subscription object.
update_mask()
Indicates which fields in the provided subscription to update. Must be specified and non-empty.
subscription()
Field google.pubsub.v1.UpdateSubscriptionRequest.subscription
update_mask()
Field google.pubsub.v1.UpdateSubscriptionRequest.update_mask
class google.cloud.pubsub_v1.types.UpdateTopicRequest()
Request for the UpdateTopic method.
topic()
The updated topic object.
update_mask()
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.
topic()
Field google.pubsub.v1.UpdateTopicRequest.topic
update_mask()
Field google.pubsub.v1.UpdateTopicRequest.update_mask