package pubsub
- Alphabetic
- Public
- Protected
Type Members
- final case class AcknowledgeRequest(subscription: String = "", ackIds: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) 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 BigQueryConfig(table: String = "", useTopicSchema: Boolean = false, writeMetadata: Boolean = false, dropUnknownFields: Boolean = false, state: State = com.google.pubsub.v1.pubsub.BigQueryConfig.State.STATE_UNSPECIFIED, useTableSchema: Boolean = false, serviceAccountEmail: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[BigQueryConfig] with Product with Serializable
Configuration for a BigQuery subscription.
Configuration for a BigQuery subscription.
- table
Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
- useTopicSchema
Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
use_topic_schema
anduse_table_schema
cannot be enabled at the same time.- writeMetadata
Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.
- dropUnknownFields
Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.
- state
Output only. An output-only field that indicates whether or not the subscription can receive messages.
- useTableSchema
Optional. When true, use the BigQuery table's schema as the columns to write to in BigQuery.
use_table_schema
anduse_topic_schema
cannot be enabled at the same time.- serviceAccountEmail
Optional. The service account to use to write to BigQuery. The subscription creator or updater that specifies this field must have
iam.serviceAccounts.actAs
permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
- Annotations
- @SerialVersionUID()
- final case class CloudStorageConfig(bucket: String = "", filenamePrefix: String = "", filenameSuffix: String = "", filenameDatetimeFormat: String = "", outputFormat: OutputFormat = com.google.pubsub.v1.pubsub.CloudStorageConfig.OutputFormat.Empty, maxDuration: Option[Duration] = _root_.scala.None, maxBytes: Long = 0L, maxMessages: Long = 0L, state: State = com.google.pubsub.v1.pubsub.CloudStorageConfig.State.STATE_UNSPECIFIED, serviceAccountEmail: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[CloudStorageConfig] with Product with Serializable
Configuration for a Cloud Storage subscription.
Configuration for a Cloud Storage subscription.
- bucket
Required. User-provided name for the Cloud Storage bucket. The bucket must be created by the user. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).
- filenamePrefix
Optional. User-provided prefix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming).
- filenameSuffix
Optional. User-provided suffix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). Must not end in "/".
- filenameDatetimeFormat
Optional. User-provided format string specifying how to represent datetimes in Cloud Storage filenames. See the [datetime format guidance](https://cloud.google.com/pubsub/docs/create-cloudstorage-subscription#file_names).
- maxDuration
Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline.
- maxBytes
Optional. The maximum bytes that can be written to a Cloud Storage file before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may be exceeded in cases where messages are larger than the limit.
- maxMessages
Optional. The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.
- state
Output only. An output-only field that indicates whether or not the subscription can receive messages.
- serviceAccountEmail
Optional. The service account to use to write to Cloud Storage. The subscription creator or updater that specifies this field must have
iam.serviceAccounts.actAs
permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
- Annotations
- @SerialVersionUID()
- final case class CreateSnapshotRequest(name: String = "", subscription: String = "", labels: Map[String, String] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) 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 [resource name rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). 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
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
- Annotations
- @SerialVersionUID()
- final case class DeadLetterPolicy(deadLetterTopic: String = "", maxDeliveryAttempts: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) 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
Optional. The name of the topic to which dead letter messages should be published. Format is
projects/{project}/topics/{topic}
.The 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
Optional. 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 case class DeleteSnapshotRequest(snapshot: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) 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 = _root_.scalapb.UnknownFieldSet.empty) 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 = _root_.scalapb.UnknownFieldSet.empty) 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 DetachSubscriptionRequest(subscription: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[DetachSubscriptionRequest] with Product with Serializable
Request for the DetachSubscription method.
Request for the DetachSubscription method.
- subscription
Required. The subscription to detach. Format is
projects/{project}/subscriptions/{subscription}
.
- Annotations
- @SerialVersionUID()
- final case class DetachSubscriptionResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[DetachSubscriptionResponse] with Product with Serializable
Response for the DetachSubscription method.
Response for the DetachSubscription method. Reserved for future use.
- Annotations
- @SerialVersionUID()
- final case class ExpirationPolicy(ttl: Option[Duration] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) 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
Optional. 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 = _root_.scalapb.UnknownFieldSet.empty) 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 = _root_.scalapb.UnknownFieldSet.empty) 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 = _root_.scalapb.UnknownFieldSet.empty) 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 IngestionDataSourceSettings(source: Source = com.google.pubsub.v1.pubsub.IngestionDataSourceSettings.Source.Empty, platformLogsSettings: Option[PlatformLogsSettings] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[IngestionDataSourceSettings] with Product with Serializable
Settings for an ingestion data source on a topic.
Settings for an ingestion data source on a topic.
- platformLogsSettings
Optional. Platform Logs settings. If unset, no Platform Logs will be generated.
- Annotations
- @SerialVersionUID()
- final case class IngestionFailureEvent(topic: String = "", errorMessage: String = "", failure: Failure = com.google.pubsub.v1.pubsub.IngestionFailureEvent.Failure.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[IngestionFailureEvent] with Product with Serializable
Payload of the Platform Log entry sent when a failure is encountered while ingesting.
Payload of the Platform Log entry sent when a failure is encountered while ingesting.
- topic
Required. Name of the import topic. Format is: projects/{project_name}/topics/{topic_name}.
- errorMessage
Required. Error details explaining why ingestion to Pub/Sub has failed.
- Annotations
- @SerialVersionUID()
- final case class ListSnapshotsRequest(project: String = "", pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) 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
Optional. Maximum number of snapshots to return.
- pageToken
Optional. 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 = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListSnapshotsResponse] with Product with Serializable
Response for the
ListSnapshots
method.Response for the
ListSnapshots
method.- snapshots
Optional. The resulting snapshots.
- nextPageToken
Optional. 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 = _root_.scalapb.UnknownFieldSet.empty) 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
Optional. Maximum number of subscriptions to return.
- pageToken
Optional. 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 = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListSubscriptionsResponse] with Product with Serializable
Response for the
ListSubscriptions
method.Response for the
ListSubscriptions
method.- subscriptions
Optional. The subscriptions that match the request.
- nextPageToken
Optional. 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 = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListTopicSnapshotsRequest] with Product with Serializable
Request for the
ListTopicSnapshots
method.Request for the
ListTopicSnapshots
method.- topic
Required. The name of the topic that snapshots are attached to. Format is
projects/{project}/topics/{topic}
.- pageSize
Optional. Maximum number of snapshot names to return.
- pageToken
Optional. 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 = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListTopicSnapshotsResponse] with Product with Serializable
Response for the
ListTopicSnapshots
method.Response for the
ListTopicSnapshots
method.- snapshots
Optional. The names of the snapshots that match the request.
- nextPageToken
Optional. 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 = _root_.scalapb.UnknownFieldSet.empty) 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
Optional. Maximum number of subscription names to return.
- pageToken
Optional. 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 = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListTopicSubscriptionsResponse] with Product with Serializable
Response for the
ListTopicSubscriptions
method.Response for the
ListTopicSubscriptions
method.- subscriptions
Optional. The names of subscriptions attached to the topic specified in the request.
- nextPageToken
Optional. 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 = _root_.scalapb.UnknownFieldSet.empty) 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
Optional. Maximum number of topics to return.
- pageToken
Optional. 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 = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ListTopicsResponse] with Product with Serializable
Response for the
ListTopics
method.Response for the
ListTopics
method.- topics
Optional. The resulting topics.
- nextPageToken
Optional. 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, enforceInTransit: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MessageStoragePolicy] with Product with Serializable
A policy constraining the storage of messages published to the topic.
A policy constraining the storage of messages published to the topic.
- allowedPersistenceRegions
Optional. A list of IDs of Google Cloud regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed Google Cloud regions (or running outside of Google Cloud altogether) are routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.
- enforceInTransit
Optional. If true,
allowed_persistence_regions
is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not inallowed_persistence_regions
.
- Annotations
- @SerialVersionUID()
- final case class ModifyAckDeadlineRequest(subscription: String = "", ackIds: Seq[String] = _root_.scala.Seq.empty, ackDeadlineSeconds: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) 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 in a single request is 600 seconds (10 minutes).
- Annotations
- @SerialVersionUID()
- final case class ModifyPushConfigRequest(subscription: String = "", pushConfig: Option[PushConfig] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) 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 PlatformLogsSettings(severity: Severity = com.google.pubsub.v1.pubsub.PlatformLogsSettings.Severity.SEVERITY_UNSPECIFIED, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PlatformLogsSettings] with Product with Serializable
Settings for Platform Logs produced by Pub/Sub.
Settings for Platform Logs produced by Pub/Sub.
- severity
Optional. The minimum severity level of Platform Logs that will be written.
- Annotations
- @SerialVersionUID()
- final case class PublishRequest(topic: String = "", messages: Seq[PubsubMessage] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) 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 = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PublishResponse] with Product with Serializable
Response for the
Publish
method.Response for the
Publish
method.- messageIds
Optional. 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.
The service that an application uses to manipulate topics, and to send messages to a topic.
- Annotations
- @PekkoGrpcGenerated()
- trait PublisherClient extends Publisher with PublisherClientPowerApi with PekkoGrpcClient
- Annotations
- @PekkoGrpcGenerated()
- trait PublisherClientPowerApi extends AnyRef
- Annotations
- @PekkoGrpcGenerated()
- final case class PubsubMessage(data: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, attributes: Map[String, String] = _root_.scala.collection.immutable.Map.empty, messageId: String = "", publishTime: Option[Timestamp] = _root_.scala.None, orderingKey: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) 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 [client library documentation](https://cloud.google.com/pubsub/docs/reference/libraries) for more information. See [quotas and limits] (https://cloud.google.com/pubsub/quotas) for more information about message limits.
- data
Optional. The message data field. If this field is empty, the message must contain at least one attribute.
- attributes
Optional. Attributes for this message. If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription.
- 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
Optional. 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. For more information, see [ordering messages](https://cloud.google.com/pubsub/docs/ordering).
- Annotations
- @SerialVersionUID()
- final case class PullRequest(subscription: String = "", returnImmediately: Boolean = false, maxMessages: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) 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
Optional. 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. Warning: setting this field totrue
is discouraged because it adversely impacts the performance ofPull
operations. We recommend that users do not set this field.- 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 = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PullResponse] with Product with Serializable
Response for the
Pull
method.Response for the
Pull
method.- receivedMessages
Optional. Received Pub/Sub messages. The list will be empty if there are no more messages available in the backlog, or if no messages could be returned before the request timeout. 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] = _root_.scala.collection.immutable.Map.empty, authenticationMethod: AuthenticationMethod = com.google.pubsub.v1.pubsub.PushConfig.AuthenticationMethod.Empty, wrapper: Wrapper = com.google.pubsub.v1.pubsub.PushConfig.Wrapper.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PushConfig] with Product with Serializable
Configuration for a push delivery endpoint.
Configuration for a push delivery endpoint.
- pushEndpoint
Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use
https://example.com/push
.- attributes
Optional. 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:attributes { "x-goog-version": "v1" }
- Annotations
- @SerialVersionUID()
- final case class ReceivedMessage(ackId: String = "", message: Option[PubsubMessage] = _root_.scala.None, deliveryAttempt: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ReceivedMessage] with Product with Serializable
A message and its corresponding acknowledgment ID.
A message and its corresponding acknowledgment ID.
- ackId
Optional. This ID can be used to acknowledge the received message.
- message
Optional. The message.
- deliveryAttempt
Optional. The approximate number of times that Pub/Sub has attempted to deliver the associated message to a subscriber. More precisely, this is 1 + (number of NACKs) + (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. Upon the first delivery of a given message,
delivery_attempt
will have a value of 1. The value is calculated at best effort and is approximate. If a DeadLetterPolicy is not set on the subscription, this will be 0.
- Annotations
- @SerialVersionUID()
- final case class RetryPolicy(minimumBackoff: Option[Duration] = _root_.scala.None, maximumBackoff: Option[Duration] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[RetryPolicy] with Product with Serializable
A policy that specifies how Pub/Sub retries message delivery.
A policy that specifies how Pub/Sub retries message delivery.
Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff.
RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.
- minimumBackoff
Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
- maximumBackoff
Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
- Annotations
- @SerialVersionUID()
- final case class SchemaSettings(schema: String = "", encoding: schema.Encoding = com.google.pubsub.v1.schema.Encoding.ENCODING_UNSPECIFIED, firstRevisionId: String = "", lastRevisionId: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SchemaSettings] with Product with Serializable
Settings for validating messages published against a schema.
Settings for validating messages published against a schema.
- schema
Required. The name of the schema that messages published should be validated against. Format is
projects/{project}/schemas/{schema}
. The value of this field will be_deleted-schema_
if the schema has been deleted.- encoding
Optional. The encoding of messages validated against
schema
.- firstRevisionId
Optional. The minimum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against last_revision or any revision created before.
- lastRevisionId
Optional. The maximum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against first_revision or any revision created after.
- Annotations
- @SerialVersionUID()
- final case class SeekRequest(subscription: String = "", target: Target = com.google.pubsub.v1.pubsub.SeekRequest.Target.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) 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 = _root_.scalapb.UnknownFieldSet.empty) 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] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Snapshot] with Product with Serializable
A snapshot resource.
A snapshot resource. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.
- name
Optional. The name of the snapshot.
- topic
Optional. The name of the topic from which this snapshot is retaining messages.
- expireTime
Optional. 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
Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
- 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 = "", maxOutstandingMessages: Long = 0L, maxOutstandingBytes: Long = 0L, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) 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
Optional. 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
Optional. 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
Optional. 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
Optional. 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.
- maxOutstandingMessages
Optional. Flow control settings for the maximum number of outstanding messages. When there are
max_outstanding_messages
currently sent to the streaming pull client that have not yet been acked or nacked, the server stops sending more messages. The sending of messages resumes once the number of outstanding messages is less than this value. If the value is <= 0, there is no limit to the number of outstanding messages. This property can only be set on the initial StreamingPullRequest. If it is set on a subsequent request, the stream will be aborted with statusINVALID_ARGUMENT
.- maxOutstandingBytes
Optional. Flow control settings for the maximum number of outstanding bytes. When there are
max_outstanding_bytes
or more worth of messages currently sent to the streaming pull client that have not yet been acked or nacked, the server will stop sending more messages. The sending of messages resumes once the number of outstanding bytes is less than this value. If the value is <= 0, there is no limit to the number of outstanding bytes. This property can only be set on the initial StreamingPullRequest. If it is set on a subsequent request, the stream will be aborted with statusINVALID_ARGUMENT
.
- Annotations
- @SerialVersionUID()
- final case class StreamingPullResponse(receivedMessages: Seq[ReceivedMessage] = _root_.scala.Seq.empty, acknowledgeConfirmation: Option[AcknowledgeConfirmation] = _root_.scala.None, modifyAckDeadlineConfirmation: Option[ModifyAckDeadlineConfirmation] = _root_.scala.None, subscriptionProperties: Option[SubscriptionProperties] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) 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
Optional. Received Pub/Sub messages. This will not be empty.
- acknowledgeConfirmation
Optional. This field will only be set if
enable_exactly_once_delivery
is set totrue
.- modifyAckDeadlineConfirmation
Optional. This field will only be set if
enable_exactly_once_delivery
is set totrue
.- subscriptionProperties
Optional. Properties associated with this subscription.
- 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.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.- Annotations
- @PekkoGrpcGenerated()
- trait SubscriberClient extends Subscriber with SubscriberClientPowerApi with PekkoGrpcClient
- Annotations
- @PekkoGrpcGenerated()
- trait SubscriberClientPowerApi extends AnyRef
- Annotations
- @PekkoGrpcGenerated()
- final case class Subscription(name: String = "", topic: String = "", pushConfig: Option[PushConfig] = _root_.scala.None, bigqueryConfig: Option[BigQueryConfig] = _root_.scala.None, cloudStorageConfig: Option[CloudStorageConfig] = _root_.scala.None, ackDeadlineSeconds: Int = 0, retainAckedMessages: Boolean = false, messageRetentionDuration: Option[Duration] = _root_.scala.None, labels: Map[String, String] = _root_.scala.collection.immutable.Map.empty, enableMessageOrdering: Boolean = false, expirationPolicy: Option[ExpirationPolicy] = _root_.scala.None, filter: String = "", deadLetterPolicy: Option[DeadLetterPolicy] = _root_.scala.None, retryPolicy: Option[RetryPolicy] = _root_.scala.None, detached: Boolean = false, enableExactlyOnceDelivery: Boolean = false, topicMessageRetentionDuration: Option[Duration] = _root_.scala.None, state: State = com.google.pubsub.v1.pubsub.Subscription.State.STATE_UNSPECIFIED, analyticsHubSubscriptionInfo: Option[AnalyticsHubSubscriptionInfo] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Subscription] with Product with Serializable
A subscription resource.
A subscription resource. If none of
push_config
,bigquery_config
, orcloud_storage_config
is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set.- 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
Optional. If push delivery is used with this subscription, this field is used to configure it.
- bigqueryConfig
Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.
- cloudStorageConfig
Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
- ackDeadlineSeconds
Optional. 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 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
Optional. 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] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages.- messageRetentionDuration
Optional. 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 31 days or less than 10 minutes.- labels
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
- enableMessageOrdering
Optional. 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.- expirationPolicy
Optional. 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. Ifexpiration_policy
is set, butexpiration_policy.ttl
is not set, the subscription never expires.- filter
Optional. An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, then only
PubsubMessage
s whoseattributes
field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.- deadLetterPolicy
Optional. 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 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.
- retryPolicy
Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
- detached
Optional. Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog.
Pull
andStreamingPull
requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.- enableExactlyOnceDelivery
Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of
message_id
on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message whenenable_exactly_once_delivery
is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinctmessage_id
values.- topicMessageRetentionDuration
Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last
topic_message_retention_duration
are always available to subscribers. See themessage_retention_duration
field inTopic
. This field is set only in responses from the server; it is ignored if it is set in any requests.- state
Output only. An output-only field indicating whether or not the subscription can receive messages.
- analyticsHubSubscriptionInfo
Output only. Information about the associated Analytics Hub subscription. Only set if the subscritpion is created by Analytics Hub.
- Annotations
- @SerialVersionUID()
- final case class Topic(name: String = "", labels: Map[String, String] = _root_.scala.collection.immutable.Map.empty, messageStoragePolicy: Option[MessageStoragePolicy] = _root_.scala.None, kmsKeyName: String = "", schemaSettings: Option[SchemaSettings] = _root_.scala.None, satisfiesPzs: Boolean = false, messageRetentionDuration: Option[Duration] = _root_.scala.None, state: State = com.google.pubsub.v1.pubsub.Topic.State.STATE_UNSPECIFIED, ingestionDataSourceSettings: Option[IngestionDataSourceSettings] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) 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
Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
- messageStoragePolicy
Optional. 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
Optional. 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/*
.- schemaSettings
Optional. Settings for validating messages published against a schema.
- satisfiesPzs
Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
- messageRetentionDuration
Optional. Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last
message_retention_duration
are always available to subscribers. For instance, it allows any attached subscription to [seek to a timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) that is up tomessage_retention_duration
in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes.- state
Output only. An output-only field indicating the state of the topic.
- ingestionDataSourceSettings
Optional. Settings for ingestion from a data source into this topic.
- Annotations
- @SerialVersionUID()
- final case class UpdateSnapshotRequest(snapshot: Option[Snapshot] = _root_.scala.None, updateMask: Option[FieldMask] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) 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 = _root_.scalapb.UnknownFieldSet.empty) 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 = _root_.scalapb.UnknownFieldSet.empty) 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" but themessage_storage_policy
is not set in thetopic
provided above, then the updated value is determined by the policy configured at the project or organization level.
- Annotations
- @SerialVersionUID()
Value Members
- object AcknowledgeRequest extends GeneratedMessageCompanion[AcknowledgeRequest]
- object BigQueryConfig extends GeneratedMessageCompanion[BigQueryConfig]
- object CloudStorageConfig extends GeneratedMessageCompanion[CloudStorageConfig]
- object CreateSnapshotRequest extends GeneratedMessageCompanion[CreateSnapshotRequest]
- object DeadLetterPolicy extends GeneratedMessageCompanion[DeadLetterPolicy]
- object DeleteSnapshotRequest extends GeneratedMessageCompanion[DeleteSnapshotRequest]
- object DeleteSubscriptionRequest extends GeneratedMessageCompanion[DeleteSubscriptionRequest]
- object DeleteTopicRequest extends GeneratedMessageCompanion[DeleteTopicRequest]
- object DetachSubscriptionRequest extends GeneratedMessageCompanion[DetachSubscriptionRequest]
- object DetachSubscriptionResponse extends GeneratedMessageCompanion[DetachSubscriptionResponse]
- object ExpirationPolicy extends GeneratedMessageCompanion[ExpirationPolicy]
- object GetSnapshotRequest extends GeneratedMessageCompanion[GetSnapshotRequest]
- object GetSubscriptionRequest extends GeneratedMessageCompanion[GetSubscriptionRequest]
- object GetTopicRequest extends GeneratedMessageCompanion[GetTopicRequest]
- object IngestionDataSourceSettings extends GeneratedMessageCompanion[IngestionDataSourceSettings]
- object IngestionFailureEvent extends GeneratedMessageCompanion[IngestionFailureEvent]
- object ListSnapshotsRequest extends GeneratedMessageCompanion[ListSnapshotsRequest]
- object ListSnapshotsResponse extends GeneratedMessageCompanion[ListSnapshotsResponse]
- object ListSubscriptionsRequest extends GeneratedMessageCompanion[ListSubscriptionsRequest]
- object ListSubscriptionsResponse extends GeneratedMessageCompanion[ListSubscriptionsResponse]
- object ListTopicSnapshotsRequest extends GeneratedMessageCompanion[ListTopicSnapshotsRequest]
- object ListTopicSnapshotsResponse extends GeneratedMessageCompanion[ListTopicSnapshotsResponse]
- object ListTopicSubscriptionsRequest extends GeneratedMessageCompanion[ListTopicSubscriptionsRequest]
- object ListTopicSubscriptionsResponse extends GeneratedMessageCompanion[ListTopicSubscriptionsResponse]
- object ListTopicsRequest extends GeneratedMessageCompanion[ListTopicsRequest]
- object ListTopicsResponse extends GeneratedMessageCompanion[ListTopicsResponse]
- object MessageStoragePolicy extends GeneratedMessageCompanion[MessageStoragePolicy]
- object ModifyAckDeadlineRequest extends GeneratedMessageCompanion[ModifyAckDeadlineRequest]
- object ModifyPushConfigRequest extends GeneratedMessageCompanion[ModifyPushConfigRequest]
- object PlatformLogsSettings extends GeneratedMessageCompanion[PlatformLogsSettings]
- object PublishRequest extends GeneratedMessageCompanion[PublishRequest]
- object PublishResponse extends GeneratedMessageCompanion[PublishResponse]
- object Publisher extends ServiceDescription
- Annotations
- @PekkoGrpcGenerated()
- object PublisherClient
- Annotations
- @PekkoGrpcGenerated()
- object PubsubMessage extends GeneratedMessageCompanion[PubsubMessage]
- object PubsubProto extends GeneratedFileObject
- object PullRequest extends GeneratedMessageCompanion[PullRequest]
- object PullResponse extends GeneratedMessageCompanion[PullResponse]
- object PushConfig extends GeneratedMessageCompanion[PushConfig]
- object ReceivedMessage extends GeneratedMessageCompanion[ReceivedMessage]
- object RetryPolicy extends GeneratedMessageCompanion[RetryPolicy]
- object SchemaSettings extends GeneratedMessageCompanion[SchemaSettings]
- object SeekRequest extends GeneratedMessageCompanion[SeekRequest]
- object SeekResponse extends GeneratedMessageCompanion[SeekResponse]
- object Snapshot extends GeneratedMessageCompanion[Snapshot]
- object StreamingPullRequest extends GeneratedMessageCompanion[StreamingPullRequest]
- object StreamingPullResponse extends GeneratedMessageCompanion[StreamingPullResponse]
- object Subscriber extends ServiceDescription
- Annotations
- @PekkoGrpcGenerated()
- object SubscriberClient
- Annotations
- @PekkoGrpcGenerated()
- object Subscription extends GeneratedMessageCompanion[Subscription]
- object Topic extends GeneratedMessageCompanion[Topic]
- object UpdateSnapshotRequest extends GeneratedMessageCompanion[UpdateSnapshotRequest]
- object UpdateSubscriptionRequest extends GeneratedMessageCompanion[UpdateSubscriptionRequest]
- object UpdateTopicRequest extends GeneratedMessageCompanion[UpdateTopicRequest]