package pubsub
- Alphabetic
- Public
- All
Type Members
-
final
case class
AcknowledgeRequest(subscription: String = "", ackIds: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[AcknowledgeRequest] with Product with Serializable
Request for the Acknowledge method.
Request for the Acknowledge method.
- subscription
Required. The subscription whose message is being acknowledged. Format is
projects/{project}/subscriptions/{sub}
.- ackIds
Required. The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the
Pull
response. Must not be empty.
- Annotations
- @SerialVersionUID()
-
final
case class
CreateSnapshotRequest(name: String = "", subscription: String = "", labels: Map[String, String] = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[CreateSnapshotRequest] with Product with Serializable
Request for the
CreateSnapshot
method.Request for the
CreateSnapshot
method.- name
Required. 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 <a href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource name rules</a>. Format is
projects/{project}/snapshots/{snap}
.- subscription
Required. 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 isprojects/{project}/subscriptions/{sub}
.- labels
See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
- Annotations
- @SerialVersionUID()
-
final
case class
DeadLetterPolicy(deadLetterTopic: String = "", maxDeliveryAttempts: Int = 0, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[DeadLetterPolicy] with Product with Serializable
Dead lettering is done on a best effort basis.
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.
- deadLetterTopic
The name of the topic to which dead letter messages should be published. Format is
projects/{project}/topics/{topic}
.The Cloud Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost.- maxDeliveryAttempts
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.
- Annotations
- @SerialVersionUID()
- final class DefaultPublisherClient extends PublisherClient
- final class DefaultSubscriberClient extends SubscriberClient
-
final
case class
DeleteSnapshotRequest(snapshot: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[DeleteSnapshotRequest] with Product with Serializable
Request for the
DeleteSnapshot
method.Request for the
DeleteSnapshot
method.- snapshot
Required. The name of the snapshot to delete. Format is
projects/{project}/snapshots/{snap}
.
- Annotations
- @SerialVersionUID()
-
final
case class
DeleteSubscriptionRequest(subscription: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[DeleteSubscriptionRequest] with Product with Serializable
Request for the DeleteSubscription method.
Request for the DeleteSubscription method.
- subscription
Required. The subscription to delete. Format is
projects/{project}/subscriptions/{sub}
.
- Annotations
- @SerialVersionUID()
-
final
case class
DeleteTopicRequest(topic: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[DeleteTopicRequest] with Product with Serializable
Request for the
DeleteTopic
method.Request for the
DeleteTopic
method.- topic
Required. Name of the topic to delete. Format is
projects/{project}/topics/{topic}
.
- Annotations
- @SerialVersionUID()
-
final
case class
ExpirationPolicy(ttl: Option[Duration] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ExpirationPolicy] with Product with Serializable
A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).
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 forttl
depend on the type of the associated resource, as well. Ifttl
is not set, the associated resource never expires.
- Annotations
- @SerialVersionUID()
-
final
case class
GetSnapshotRequest(snapshot: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[GetSnapshotRequest] with Product with Serializable
Request for the GetSnapshot method.
Request for the GetSnapshot method.
- snapshot
Required. The name of the snapshot to get. Format is
projects/{project}/snapshots/{snap}
.
- Annotations
- @SerialVersionUID()
-
final
case class
GetSubscriptionRequest(subscription: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[GetSubscriptionRequest] with Product with Serializable
Request for the GetSubscription method.
Request for the GetSubscription method.
- subscription
Required. The name of the subscription to get. Format is
projects/{project}/subscriptions/{sub}
.
- Annotations
- @SerialVersionUID()
-
final
case class
GetTopicRequest(topic: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[GetTopicRequest] with Product with Serializable
Request for the GetTopic method.
Request for the GetTopic method.
- topic
Required. The name of the topic to get. Format is
projects/{project}/topics/{topic}
.
- Annotations
- @SerialVersionUID()
-
final
case class
ListSnapshotsRequest(project: String = "", pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListSnapshotsRequest] with Product with Serializable
Request for the
ListSnapshots
method.Request for the
ListSnapshots
method.- project
Required. The name of the project in which to list snapshots. Format is
projects/{project-id}
.- pageSize
Maximum number of snapshots to return.
- pageToken
The value returned by the last
ListSnapshotsResponse
; indicates that this is a continuation of a priorListSnapshots
call, and that the system should return the next page of data.
- Annotations
- @SerialVersionUID()
-
final
case class
ListSnapshotsResponse(snapshots: Seq[Snapshot] = _root_.scala.Seq.empty, nextPageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListSnapshotsResponse] with Product with Serializable
Response for the
ListSnapshots
method.Response for the
ListSnapshots
method.- snapshots
The resulting snapshots.
- nextPageToken
If not empty, indicates that there may be more snapshot that match the request; this value should be passed in a new
ListSnapshotsRequest
.
- Annotations
- @SerialVersionUID()
-
final
case class
ListSubscriptionsRequest(project: String = "", pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListSubscriptionsRequest] with Product with Serializable
Request for the
ListSubscriptions
method.Request for the
ListSubscriptions
method.- project
Required. The name of the project in which to list subscriptions. Format is
projects/{project-id}
.- pageSize
Maximum number of subscriptions to return.
- pageToken
The value returned by the last
ListSubscriptionsResponse
; indicates that this is a continuation of a priorListSubscriptions
call, and that the system should return the next page of data.
- Annotations
- @SerialVersionUID()
-
final
case class
ListSubscriptionsResponse(subscriptions: Seq[Subscription] = _root_.scala.Seq.empty, nextPageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListSubscriptionsResponse] with Product with Serializable
Response for the
ListSubscriptions
method.Response for the
ListSubscriptions
method.- subscriptions
The subscriptions that match the request.
- nextPageToken
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.
- Annotations
- @SerialVersionUID()
-
final
case class
ListTopicSnapshotsRequest(topic: String = "", pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListTopicSnapshotsRequest] with Product with Serializable
Request for the
ListTopicSnapshots
method.Request for the
ListTopicSnapshots
method.- topic
The name of the topic that snapshots are attached to. Format is
projects/{project}/topics/{topic}
.- pageSize
Maximum number of snapshot names to return.
- pageToken
The value returned by the last
ListTopicSnapshotsResponse
; indicates that this is a continuation of a priorListTopicSnapshots
call, and that the system should return the next page of data.
- Annotations
- @SerialVersionUID()
-
final
case class
ListTopicSnapshotsResponse(snapshots: Seq[String] = _root_.scala.Seq.empty, nextPageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListTopicSnapshotsResponse] with Product with Serializable
Response for the
ListTopicSnapshots
method.Response for the
ListTopicSnapshots
method.- snapshots
The names of the snapshots that match the request.
- nextPageToken
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.
- Annotations
- @SerialVersionUID()
-
final
case class
ListTopicSubscriptionsRequest(topic: String = "", pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListTopicSubscriptionsRequest] with Product with Serializable
Request for the
ListTopicSubscriptions
method.Request for the
ListTopicSubscriptions
method.- topic
Required. The name of the topic that subscriptions are attached to. Format is
projects/{project}/topics/{topic}
.- pageSize
Maximum number of subscription names to return.
- pageToken
The value returned by the last
ListTopicSubscriptionsResponse
; indicates that this is a continuation of a priorListTopicSubscriptions
call, and that the system should return the next page of data.
- Annotations
- @SerialVersionUID()
-
final
case class
ListTopicSubscriptionsResponse(subscriptions: Seq[String] = _root_.scala.Seq.empty, nextPageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListTopicSubscriptionsResponse] with Product with Serializable
Response for the
ListTopicSubscriptions
method.Response for the
ListTopicSubscriptions
method.- subscriptions
The names of the subscriptions that match the request.
- nextPageToken
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.
- Annotations
- @SerialVersionUID()
-
final
case class
ListTopicsRequest(project: String = "", pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListTopicsRequest] with Product with Serializable
Request for the
ListTopics
method.Request for the
ListTopics
method.- project
Required. The name of the project in which to list topics. Format is
projects/{project-id}
.- pageSize
Maximum number of topics to return.
- pageToken
The value returned by the last
ListTopicsResponse
; indicates that this is a continuation of a priorListTopics
call, and that the system should return the next page of data.
- Annotations
- @SerialVersionUID()
-
final
case class
ListTopicsResponse(topics: Seq[Topic] = _root_.scala.Seq.empty, nextPageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListTopicsResponse] with Product with Serializable
Response for the
ListTopics
method.Response for the
ListTopics
method.- topics
The resulting topics.
- nextPageToken
If not empty, indicates that there may be more topics that match the request; this value should be passed in a new
ListTopicsRequest
.
- Annotations
- @SerialVersionUID()
-
final
case class
MessageStoragePolicy(allowedPersistenceRegions: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[MessageStoragePolicy] with Product with Serializable
- allowedPersistenceRegions
A list of IDs of GCP regions 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 means that no regions are allowed, and is not a valid configuration.
- Annotations
- @SerialVersionUID()
-
final
case class
ModifyAckDeadlineRequest(subscription: String = "", ackIds: Seq[String] = _root_.scala.Seq.empty, ackDeadlineSeconds: Int = 0, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ModifyAckDeadlineRequest] with Product with Serializable
Request for the ModifyAckDeadline method.
Request for the ModifyAckDeadline method.
- subscription
Required. The name of the subscription. Format is
projects/{project}/subscriptions/{sub}
.- ackIds
Required. List of acknowledgment IDs.
- ackDeadlineSeconds
Required. 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).
- Annotations
- @SerialVersionUID()
-
final
case class
ModifyPushConfigRequest(subscription: String = "", pushConfig: Option[PushConfig] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ModifyPushConfigRequest] with Product with Serializable
Request for the ModifyPushConfig method.
Request for the ModifyPushConfig method.
- subscription
Required. The name of the subscription. Format is
projects/{project}/subscriptions/{sub}
.- pushConfig
Required. 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 ifPull
orStreamingPull
is not called.
- Annotations
- @SerialVersionUID()
-
final
case class
PublishRequest(topic: String = "", messages: Seq[PubsubMessage] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[PublishRequest] with Product with Serializable
Request for the Publish method.
Request for the Publish method.
- topic
Required. The messages in the request will be published on this topic. Format is
projects/{project}/topics/{topic}
.- messages
Required. The messages to publish.
- Annotations
- @SerialVersionUID()
-
final
case class
PublishResponse(messageIds: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[PublishResponse] with Product with Serializable
Response for the
Publish
method.Response for the
Publish
method.- messageIds
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.
- Annotations
- @SerialVersionUID()
-
trait
Publisher extends AnyRef
The service that an application uses to manipulate topics, and to send messages to a topic.
- trait PublisherClient extends Publisher with PublisherClientPowerApi with AkkaGrpcClient
- trait PublisherClientPowerApi extends AnyRef
-
final
case class
PubsubMessage(data: ByteString = ..., attributes: Map[String, String] = ..., messageId: String = "", publishTime: Option[Timestamp] = _root_.scala.None, orderingKey: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[PubsubMessage] with Product with Serializable
A message that is published by publishers and consumed by subscribers.
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 <a href="https://cloud.google.com/pubsub/docs/reference/libraries">client library documentation</a> for more information. See <a href="https://cloud.google.com/pubsub/quotas">Quotas and limits</a> 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
Attributes for this message. If this field is empty, the message must contain non-empty data.
- messageId
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 aPull
call or a push delivery. It must not be populated by the publisher in aPublish
call.- publishTime
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 aPublish
call.- orderingKey
If non-empty, identifies related messages for which publish order should be respected. If a
Subscription
hasenable_message_ordering
set totrue
, messages published with the same non-emptyordering_key
value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. AllPubsubMessage
s published in a givenPublishRequest
must specify the sameordering_key
value. <b>EXPERIMENTAL:</b> 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.
- Annotations
- @SerialVersionUID()
-
final
case class
PullRequest(subscription: String = "", returnImmediately: Boolean = false, maxMessages: Int = 0, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[PullRequest] with Product with Serializable
Request for the
Pull
method.Request for the
Pull
method.- subscription
Required. The subscription from which messages should be pulled. Format is
projects/{project}/subscriptions/{sub}
.- returnImmediately
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.- maxMessages
Required. The maximum number of messages to return for this request. Must be a positive integer. The Pub/Sub system may return fewer than the number specified.
- Annotations
- @SerialVersionUID()
-
final
case class
PullResponse(receivedMessages: Seq[ReceivedMessage] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[PullResponse] with Product with Serializable
Response for the
Pull
method.Response for the
Pull
method.- receivedMessages
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.
- Annotations
- @SerialVersionUID()
-
final
case class
PushConfig(pushEndpoint: String = "", attributes: Map[String, String] = ..., authenticationMethod: AuthenticationMethod = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[PushConfig] with Product with Serializable
Configuration for a push delivery endpoint.
Configuration for a push delivery endpoint.
- pushEndpoint
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 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 theCreateSubscription
call, it will default to the version of the Pub/Sub API used to make such call. If not present in aModifyPushConfig
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 thex-goog-version
attribute are: *v1beta1
: uses the push format defined in the v1beta1 Pub/Sub API. *v1
orv1beta2
: uses the push format defined in the v1 Pub/Sub API. For example: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
- Annotations
- @SerialVersionUID()
-
final
case class
ReceivedMessage(ackId: String = "", message: Option[PubsubMessage] = _root_.scala.None, deliveryAttempt: Int = 0, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ReceivedMessage] with Product with Serializable
A message and its corresponding acknowledgment ID.
A message and its corresponding acknowledgment ID.
- ackId
This ID can be used to acknowledge the received message.
- message
The message.
- deliveryAttempt
Delivery attempt counter is 1 + (the sum of number of NACKs and number of ack_deadline exceeds) for this message. A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is whenever a message is not acknowledged within ack_deadline. Note that ack_deadline is initially Subscription.ackDeadlineSeconds, but may get extended automatically by the client library. The first delivery of a given message will have this value as 1. The value is calculated at best effort and is approximate. If a DeadLetterPolicy is not set on the subscription, this will be 0. <b>EXPERIMENTAL:</b> 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.
- Annotations
- @SerialVersionUID()
-
final
case class
SeekRequest(subscription: String = "", target: Target = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[SeekRequest] with Product with Serializable
Request for the
Seek
method.Request for the
Seek
method.- subscription
Required. The subscription to affect.
- Annotations
- @SerialVersionUID()
-
final
case class
SeekResponse(unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[SeekResponse] with Product with Serializable
Response for the
Seek
method (this response is empty).Response for the
Seek
method (this response is empty).- Annotations
- @SerialVersionUID()
-
final
case class
Snapshot(name: String = "", topic: String = "", expireTime: Option[Timestamp] = _root_.scala.None, labels: Map[String, String] = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Snapshot] with Product with Serializable
A snapshot resource.
A snapshot resource. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> 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.
- expireTime
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 <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
- Annotations
- @SerialVersionUID()
-
final
case class
StreamingPullRequest(subscription: String = "", ackIds: Seq[String] = _root_.scala.Seq.empty, modifyDeadlineSeconds: Seq[Int] = _root_.scala.Seq.empty, modifyDeadlineAckIds: Seq[String] = _root_.scala.Seq.empty, streamAckDeadlineSeconds: Int = 0, clientId: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[StreamingPullRequest] with Product with Serializable
Request for the
StreamingPull
streaming RPC method.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
Required. 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}
.- ackIds
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
.- modifyDeadlineSeconds
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 ofmodify_deadline_ack_ids
. If it differs the stream will be aborted withINVALID_ARGUMENT
. Each element in this list is applied to the element in the same position inmodify_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 statusINVALID_ARGUMENT
.- modifyDeadlineAckIds
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.- streamAckDeadlineSeconds
Required. 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).
- clientId
A unique identifier that is used to distinguish client instances from each other. Only needs to be provided on the initial request. When a stream disconnects and reconnects for the same stream, the client_id should be set to the same value so that state associated with the old stream can be transferred to the new stream. The same client_id should not be used for different client instances.
- Annotations
- @SerialVersionUID()
-
final
case class
StreamingPullResponse(receivedMessages: Seq[ReceivedMessage] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[StreamingPullResponse] with Product with Serializable
Response for the
StreamingPull
method.Response for the
StreamingPull
method. This response is used to stream messages from the server to the client.- receivedMessages
Received Pub/Sub messages. This will not be empty.
- Annotations
- @SerialVersionUID()
-
trait
Subscriber extends AnyRef
The service that an application uses to manipulate subscriptions and to consume messages from a subscription via the
Pull
method or by establishing a bi-directional stream using theStreamingPull
method. - trait SubscriberClient extends Subscriber with SubscriberClientPowerApi with AkkaGrpcClient
- trait SubscriberClientPowerApi extends AnyRef
-
final
case class
Subscription(name: String = "", topic: String = "", pushConfig: Option[PushConfig] = _root_.scala.None, ackDeadlineSeconds: Int = 0, retainAckedMessages: Boolean = false, messageRetentionDuration: Option[Duration] = _root_.scala.None, labels: Map[String, String] = ..., enableMessageOrdering: Boolean = false, expirationPolicy: Option[ExpirationPolicy] = _root_.scala.None, deadLetterPolicy: Option[DeadLetterPolicy] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Subscription] with Product with Serializable
A subscription resource.
A subscription resource.
- name
Required. 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
Required. 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.- pushConfig
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.- ackDeadlineSeconds
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 <i>outstanding</i>. 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 correspondingack_id
if using non-streaming pull or send theack_id
in aStreamingModifyAckDeadlineRequest
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.- retainAckedMessages
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 <a href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time"> Seek to a timestamp</a>.- messageRetentionDuration
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 aSeek
can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.- labels
See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
- enableMessageOrdering
If true, messages published with the same
ordering_key
inPubsubMessage
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. <b>EXPERIMENTAL:</b> 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.- expirationPolicy
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* withttl
of 31 days will be used. The minimum allowed value forexpiration_policy.ttl
is 1 day.- deadLetterPolicy
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. <b>EXPERIMENTAL:</b> 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.
- Annotations
- @SerialVersionUID()
-
final
case class
Topic(name: String = "", labels: Map[String, String] = ..., messageStoragePolicy: Option[MessageStoragePolicy] = _root_.scala.None, kmsKeyName: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Topic] with Product with Serializable
A topic resource.
A topic resource.
- name
Required. 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 <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
- messageStoragePolicy
Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
- kmsKeyName
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/*
.
- Annotations
- @SerialVersionUID()
-
final
case class
UpdateSnapshotRequest(snapshot: Option[Snapshot] = _root_.scala.None, updateMask: Option[FieldMask] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[UpdateSnapshotRequest] with Product with Serializable
Request for the UpdateSnapshot method.
Request for the UpdateSnapshot method.
- snapshot
Required. The updated snapshot object.
- updateMask
Required. Indicates which fields in the provided snapshot to update. Must be specified and non-empty.
- Annotations
- @SerialVersionUID()
-
final
case class
UpdateSubscriptionRequest(subscription: Option[Subscription] = _root_.scala.None, updateMask: Option[FieldMask] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[UpdateSubscriptionRequest] with Product with Serializable
Request for the UpdateSubscription method.
Request for the UpdateSubscription method.
- subscription
Required. The updated subscription object.
- updateMask
Required. Indicates which fields in the provided subscription to update. Must be specified and non-empty.
- Annotations
- @SerialVersionUID()
-
final
case class
UpdateTopicRequest(topic: Option[Topic] = _root_.scala.None, updateMask: Option[FieldMask] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[UpdateTopicRequest] with Product with Serializable
Request for the UpdateTopic method.
Request for the UpdateTopic method.
- topic
Required. The updated topic object.
- updateMask
Required. 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. Themessage_storage_policy
must not be set in thetopic
provided above.
- Annotations
- @SerialVersionUID()
Value Members
- object AcknowledgeRequest extends GeneratedMessageCompanion[AcknowledgeRequest] with Serializable
- object CreateSnapshotRequest extends GeneratedMessageCompanion[CreateSnapshotRequest] with Serializable
- object DeadLetterPolicy extends GeneratedMessageCompanion[DeadLetterPolicy] with Serializable
- object DeleteSnapshotRequest extends GeneratedMessageCompanion[DeleteSnapshotRequest] with Serializable
- object DeleteSubscriptionRequest extends GeneratedMessageCompanion[DeleteSubscriptionRequest] with Serializable
- object DeleteTopicRequest extends GeneratedMessageCompanion[DeleteTopicRequest] with Serializable
- object ExpirationPolicy extends GeneratedMessageCompanion[ExpirationPolicy] with Serializable
- object GetSnapshotRequest extends GeneratedMessageCompanion[GetSnapshotRequest] with Serializable
- object GetSubscriptionRequest extends GeneratedMessageCompanion[GetSubscriptionRequest] with Serializable
- object GetTopicRequest extends GeneratedMessageCompanion[GetTopicRequest] with Serializable
- object ListSnapshotsRequest extends GeneratedMessageCompanion[ListSnapshotsRequest] with Serializable
- object ListSnapshotsResponse extends GeneratedMessageCompanion[ListSnapshotsResponse] with Serializable
- object ListSubscriptionsRequest extends GeneratedMessageCompanion[ListSubscriptionsRequest] with Serializable
- object ListSubscriptionsResponse extends GeneratedMessageCompanion[ListSubscriptionsResponse] with Serializable
- object ListTopicSnapshotsRequest extends GeneratedMessageCompanion[ListTopicSnapshotsRequest] with Serializable
- object ListTopicSnapshotsResponse extends GeneratedMessageCompanion[ListTopicSnapshotsResponse] with Serializable
- object ListTopicSubscriptionsRequest extends GeneratedMessageCompanion[ListTopicSubscriptionsRequest] with Serializable
- object ListTopicSubscriptionsResponse extends GeneratedMessageCompanion[ListTopicSubscriptionsResponse] with Serializable
- object ListTopicsRequest extends GeneratedMessageCompanion[ListTopicsRequest] with Serializable
- object ListTopicsResponse extends GeneratedMessageCompanion[ListTopicsResponse] with Serializable
- object MessageStoragePolicy extends GeneratedMessageCompanion[MessageStoragePolicy] with Serializable
- object ModifyAckDeadlineRequest extends GeneratedMessageCompanion[ModifyAckDeadlineRequest] with Serializable
- object ModifyPushConfigRequest extends GeneratedMessageCompanion[ModifyPushConfigRequest] with Serializable
- object PublishRequest extends GeneratedMessageCompanion[PublishRequest] with Serializable
- object PublishResponse extends GeneratedMessageCompanion[PublishResponse] with Serializable
- object Publisher extends ServiceDescription
- object PublisherClient
- object PubsubMessage extends GeneratedMessageCompanion[PubsubMessage] with Serializable
- object PubsubProto extends GeneratedFileObject
- object PullRequest extends GeneratedMessageCompanion[PullRequest] with Serializable
- object PullResponse extends GeneratedMessageCompanion[PullResponse] with Serializable
- object PushConfig extends GeneratedMessageCompanion[PushConfig] with Serializable
- object ReceivedMessage extends GeneratedMessageCompanion[ReceivedMessage] with Serializable
- object SeekRequest extends GeneratedMessageCompanion[SeekRequest] with Serializable
- object SeekResponse extends GeneratedMessageCompanion[SeekResponse] with Serializable
- object Snapshot extends GeneratedMessageCompanion[Snapshot] with Serializable
- object StreamingPullRequest extends GeneratedMessageCompanion[StreamingPullRequest] with Serializable
- object StreamingPullResponse extends GeneratedMessageCompanion[StreamingPullResponse] with Serializable
- object Subscriber extends ServiceDescription
- object SubscriberClient
- object Subscription extends GeneratedMessageCompanion[Subscription] with Serializable
- object Topic extends GeneratedMessageCompanion[Topic] with Serializable
- object UpdateSnapshotRequest extends GeneratedMessageCompanion[UpdateSnapshotRequest] with Serializable
- object UpdateSubscriptionRequest extends GeneratedMessageCompanion[UpdateSubscriptionRequest] with Serializable
- object UpdateTopicRequest extends GeneratedMessageCompanion[UpdateTopicRequest] with Serializable