Type Members

1.  final case class AcknowledgeRequest(subscription: String = "", ackIds: Seq[String] = _root_.scala.collection.Seq.empty) extends GeneratedMessage with Message[AcknowledgeRequest] with Updatable[AcknowledgeRequest] with Product with Serializable

   Request for the Acknowledge method.

   Request for the Acknowledge method.

   subscription

   The subscription whose message is being acknowledged. Format is projects/{project}/subscriptions/{sub}.

   ackIds

   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()

2.  final case class CreateSnapshotRequest(name: String = "", subscription: String = "") extends GeneratedMessage with Message[CreateSnapshotRequest] with Updatable[CreateSnapshotRequest] with Product with Serializable

   Request for the CreateSnapshot method.

   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. 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}.

   Annotations

   @SerialVersionUID()

3.  final class DefaultPublisherClient extends PublisherClient
4.  final class DefaultSubscriberClient extends SubscriberClient
5.  final case class DeleteSnapshotRequest(snapshot: String = "") extends GeneratedMessage with Message[DeleteSnapshotRequest] with Updatable[DeleteSnapshotRequest] with Product with Serializable

   Request for the DeleteSnapshot method.

   Request for the DeleteSnapshot method.

   snapshot

   The name of the snapshot to delete. Format is projects/{project}/snapshots/{snap}.

   Annotations

   @SerialVersionUID()

6.  final case class DeleteSubscriptionRequest(subscription: String = "") extends GeneratedMessage with Message[DeleteSubscriptionRequest] with Updatable[DeleteSubscriptionRequest] with Product with Serializable

   Request for the DeleteSubscription method.

   Request for the DeleteSubscription method.

   subscription

   The subscription to delete. Format is projects/{project}/subscriptions/{sub}.

   Annotations

   @SerialVersionUID()

7.  final case class DeleteTopicRequest(topic: String = "") extends GeneratedMessage with Message[DeleteTopicRequest] with Updatable[DeleteTopicRequest] with Product with Serializable

   Request for the DeleteTopic method.

   Request for the DeleteTopic method.

   topic

   Name of the topic to delete. Format is projects/{project}/topics/{topic}.

   Annotations

   @SerialVersionUID()

8.  final case class GetSubscriptionRequest(subscription: String = "") extends GeneratedMessage with Message[GetSubscriptionRequest] with Updatable[GetSubscriptionRequest] with Product with Serializable

   Request for the GetSubscription method.

   Request for the GetSubscription method.

   subscription

   The name of the subscription to get. Format is projects/{project}/subscriptions/{sub}.

   Annotations

   @SerialVersionUID()

9.  final case class GetTopicRequest(topic: String = "") extends GeneratedMessage with Message[GetTopicRequest] with Updatable[GetTopicRequest] with Product with Serializable

   Request for the GetTopic method.

   Request for the GetTopic method.

   topic

   The name of the topic to get. Format is projects/{project}/topics/{topic}.

   Annotations

   @SerialVersionUID()

10.  final case class ListSnapshotsRequest(project: String = "", pageSize: Int = 0, pageToken: String = "") extends GeneratedMessage with Message[ListSnapshotsRequest] with Updatable[ListSnapshotsRequest] with Product with Serializable

    Request for the ListSnapshots method.

    Request for the ListSnapshots method.

    project

    The name of the cloud project that snapshots belong to. Format is projects/{project}.

    pageSize

    Maximum number of snapshots to return.

    pageToken

    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.

    Annotations

    @SerialVersionUID()

11.  final case class ListSnapshotsResponse(snapshots: Seq[Snapshot] = _root_.scala.collection.Seq.empty, nextPageToken: String = "") extends GeneratedMessage with Message[ListSnapshotsResponse] 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()

12.  final case class ListSubscriptionsRequest(project: String = "", pageSize: Int = 0, pageToken: String = "") extends GeneratedMessage with Message[ListSubscriptionsRequest] with Updatable[ListSubscriptionsRequest] with Product with Serializable

    Request for the ListSubscriptions method.

    Request for the ListSubscriptions method.

    project

    The name of the cloud project that subscriptions belong to. Format is projects/{project}.

    pageSize

    Maximum number of subscriptions to return.

    pageToken

    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.

    Annotations

    @SerialVersionUID()

13.  final case class ListSubscriptionsResponse(subscriptions: Seq[Subscription] = _root_.scala.collection.Seq.empty, nextPageToken: String = "") extends GeneratedMessage with Message[ListSubscriptionsResponse] 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()

14.  final case class ListTopicSubscriptionsRequest(topic: String = "", pageSize: Int = 0, pageToken: String = "") extends GeneratedMessage with Message[ListTopicSubscriptionsRequest] with Updatable[ListTopicSubscriptionsRequest] with Product with Serializable

    Request for the ListTopicSubscriptions method.

    Request for the ListTopicSubscriptions method.

    topic

    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 prior ListTopicSubscriptions call, and that the system should return the next page of data.

    Annotations

    @SerialVersionUID()

15.  final case class ListTopicSubscriptionsResponse(subscriptions: Seq[String] = _root_.scala.collection.Seq.empty, nextPageToken: String = "") extends GeneratedMessage with Message[ListTopicSubscriptionsResponse] 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()

16.  final case class ListTopicsRequest(project: String = "", pageSize: Int = 0, pageToken: String = "") extends GeneratedMessage with Message[ListTopicsRequest] with Updatable[ListTopicsRequest] with Product with Serializable

    Request for the ListTopics method.

    Request for the ListTopics method.

    project

    The name of the cloud project that topics belong to. Format is projects/{project}.

    pageSize

    Maximum number of topics to return.

    pageToken

    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.

    Annotations

    @SerialVersionUID()

17.  final case class ListTopicsResponse(topics: Seq[Topic] = _root_.scala.collection.Seq.empty, nextPageToken: String = "") extends GeneratedMessage with Message[ListTopicsResponse] 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()

18.  final case class ModifyAckDeadlineRequest(subscription: String = "", ackIds: Seq[String] = _root_.scala.collection.Seq.empty, ackDeadlineSeconds: Int = 0) extends GeneratedMessage with Message[ModifyAckDeadlineRequest] with Updatable[ModifyAckDeadlineRequest] with Product with Serializable

    Request for the ModifyAckDeadline method.

    Request for the ModifyAckDeadline method.

    subscription

    The name of the subscription. Format is projects/{project}/subscriptions/{sub}.

    ackIds

    List of acknowledgment IDs.

    ackDeadlineSeconds

    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 may immediately make the message available for another pull request. The minimum deadline you can specify is 0 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).

    Annotations

    @SerialVersionUID()

19.  final case class ModifyPushConfigRequest(subscription: String = "", pushConfig: Option[PushConfig] = None) extends GeneratedMessage with Message[ModifyPushConfigRequest] with Updatable[ModifyPushConfigRequest] with Product with Serializable

    Request for the ModifyPushConfig method.

    Request for the ModifyPushConfig method.

    subscription

    The name of the subscription. Format is projects/{project}/subscriptions/{sub}.

    pushConfig

    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 is not called.

    Annotations

    @SerialVersionUID()

20.  final case class PublishRequest(topic: String = "", messages: Seq[PubsubMessage] = _root_.scala.collection.Seq.empty) extends GeneratedMessage with Message[PublishRequest] with Updatable[PublishRequest] with Product with Serializable

    Request for the Publish method.

    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.

    Annotations

    @SerialVersionUID()

21.  final case class PublishResponse(messageIds: Seq[String] = _root_.scala.collection.Seq.empty) extends GeneratedMessage with Message[PublishResponse] 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()

22.  trait Publisher extends AnyRef
23.  trait PublisherClient extends Publisher with PublisherClientPowerApi with AkkaGrpcClient
24.  trait PublisherClientPowerApi extends AnyRef
25.  final case class PubsubMessage(data: ByteString = ..., attributes: Map[String, String] = ..., messageId: String = "", publishTime: Option[Timestamp] = None) extends GeneratedMessage with Message[PubsubMessage] with Updatable[PubsubMessage] with Product with Serializable

    A message data and its attributes.

    A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.

    data

    The message payload.

    attributes

    Optional attributes for this message.

    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 a Pull call or a push delivery. It must not be populated by the publisher in a Publish 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 a Publish call.

    Annotations

    @SerialVersionUID()

26.  final case class PullRequest(subscription: String = "", returnImmediately: Boolean = false, maxMessages: Int = 0) extends GeneratedMessage with Message[PullRequest] with Updatable[PullRequest] with Product with Serializable

    Request for the Pull method.

    Request for the Pull method.

    subscription

    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. The client may cancel the request if it does not wish to wait any longer for the response.

    maxMessages

    The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified.

    Annotations

    @SerialVersionUID()

27.  final case class PullResponse(receivedMessages: Seq[ReceivedMessage] = _root_.scala.collection.Seq.empty) extends GeneratedMessage with Message[PullResponse] with Updatable[PullResponse] with Product with Serializable

    Response for the Pull method.

    Response for the Pull method.

    receivedMessages

    Received Pub/Sub messages. The Pub/Sub system will return zero messages if there are no more available in the backlog. The Pub/Sub system may return fewer than the maxMessages requested even if there are more messages available in the backlog.

    Annotations

    @SerialVersionUID()

28.  final case class PushConfig(pushEndpoint: String = "", attributes: Map[String, String] = ...) extends GeneratedMessage with Message[PushConfig] 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. 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.

    Annotations

    @SerialVersionUID()

29.  final case class ReceivedMessage(ackId: String = "", message: Option[PubsubMessage] = None) extends GeneratedMessage with Message[ReceivedMessage] 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.

    Annotations

    @SerialVersionUID()

30.  final case class SeekRequest(subscription: String = "", target: Target = ...) extends GeneratedMessage with Message[SeekRequest] with Updatable[SeekRequest] with Product with Serializable

    Request for the Seek method.

    Request for the Seek method.

    subscription

    The subscription to affect.

    Annotations

    @SerialVersionUID()

31.  final case class SeekResponse() extends GeneratedMessage with Message[SeekResponse] with Updatable[SeekResponse] with Product with Serializable

    Annotations

    @SerialVersionUID()

32.  final case class Snapshot(name: String = "", topic: String = "", expireTime: Option[Timestamp] = None, labels: Map[String, String] = ...) extends GeneratedMessage with Message[Snapshot] with Updatable[Snapshot] with Product with Serializable

    A snapshot resource.

    A snapshot resource.

    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.

    labels

    User labels.

    Annotations

    @SerialVersionUID()

33.  final case class StreamingPullRequest(subscription: String = "", ackIds: Seq[String] = _root_.scala.collection.Seq.empty, modifyDeadlineSeconds: Seq[Int] = _root_.scala.collection.Seq.empty, modifyDeadlineAckIds: Seq[String] = _root_.scala.collection.Seq.empty, streamAckDeadlineSeconds: Int = 0) extends GeneratedMessage with Message[StreamingPullRequest] 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

    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 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.

    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

    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).

    Annotations

    @SerialVersionUID()

34.  final case class StreamingPullResponse(receivedMessages: Seq[ReceivedMessage] = _root_.scala.collection.Seq.empty) extends GeneratedMessage with Message[StreamingPullResponse] 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()

35.  trait Subscriber extends AnyRef
36.  trait SubscriberClient extends Subscriber with SubscriberClientPowerApi with AkkaGrpcClient
37.  trait SubscriberClientPowerApi extends AnyRef
38.  final case class Subscription(name: String = "", topic: String = "", pushConfig: Option[PushConfig] = None, ackDeadlineSeconds: Int = 0, retainAckedMessages: Boolean = false, messageRetentionDuration: Option[Duration] = None, labels: Map[String, String] = ...) extends GeneratedMessage with Message[Subscription] with Updatable[Subscription] with Product with Serializable

    A subscription resource.

    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.

    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

    This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (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 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.

    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 a Seek can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.

    labels

    User labels.

    Annotations

    @SerialVersionUID()

39.  final case class Topic(name: String = "", labels: Map[String, String] = ...) extends GeneratedMessage with Message[Topic] with Updatable[Topic] with Product with Serializable

    A topic resource.

    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

    User labels.

    Annotations

    @SerialVersionUID()

40.  final case class UpdateSnapshotRequest(snapshot: Option[Snapshot] = None, updateMask: Option[FieldMask] = None) extends GeneratedMessage with Message[UpdateSnapshotRequest] with Updatable[UpdateSnapshotRequest] with Product with Serializable

    Request for the UpdateSnapshot method.

    Request for the UpdateSnapshot method.

    snapshot

    The updated snpashot object.

    updateMask

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

    Annotations

    @SerialVersionUID()

41.  final case class UpdateSubscriptionRequest(subscription: Option[Subscription] = None, updateMask: Option[FieldMask] = None) extends GeneratedMessage with Message[UpdateSubscriptionRequest] with Updatable[UpdateSubscriptionRequest] with Product with Serializable

    Request for the UpdateSubscription method.

    Request for the UpdateSubscription method.

    subscription

    The updated subscription object.

    updateMask

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

    Annotations

    @SerialVersionUID()

42.  final case class UpdateTopicRequest(topic: Option[Topic] = None, updateMask: Option[FieldMask] = None) extends GeneratedMessage with Message[UpdateTopicRequest] with Updatable[UpdateTopicRequest] with Product with Serializable

    Request for the UpdateTopic method.

    Request for the UpdateTopic method.

    topic

    The topic to update.

    updateMask

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

    Annotations

    @SerialVersionUID()