com.google.pubsub.v1.pubsub

Request for the Acknowledge method.

Value parameters

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.
subscription: Required. The subscription whose message is being acknowledged. Format is projects/{project}/subscriptions/{sub}.

Attributes

Companion: object
Source: AcknowledgeRequest.scala
Supertypes: trait Updatable[AcknowledgeRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: AcknowledgeRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[AcknowledgeRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: AcknowledgeRequest.type

Configuration for a BigQuery subscription.

Value parameters

dropUnknownFields: 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.
table: The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
useTopicSchema: When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
writeMetadata: 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.

Attributes

Companion: object
Source: BigQueryConfig.scala
Supertypes: trait Updatable[BigQueryConfig]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: BigQueryConfig.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[BigQueryConfig]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: BigQueryConfig.type

Configuration for a Cloud Storage subscription.

Value parameters

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: User-provided prefix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming).
filenameSuffix: User-provided suffix for Cloud Storage filename. See the [object naming requirements](https://cloud.google.com/storage/docs/objects#naming). Must not end in "/".
maxBytes: 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.
maxDuration: 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.
state: Output only. An output-only field that indicates whether or not the subscription can receive messages.

Attributes

Companion: object
Source: CloudStorageConfig.scala
Supertypes: trait Updatable[CloudStorageConfig]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: CloudStorageConfig.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[CloudStorageConfig]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: CloudStorageConfig.type

Request for the CreateSnapshot method.

Value parameters

labels: See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
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 is projects/{project}/subscriptions/{sub}.

Attributes

Companion: object
Source: CreateSnapshotRequest.scala
Supertypes: trait Updatable[CreateSnapshotRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: CreateSnapshotRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[CreateSnapshotRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: CreateSnapshotRequest.type

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.

Value parameters

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.

Attributes

Companion: object
Source: DeadLetterPolicy.scala
Supertypes: trait Updatable[DeadLetterPolicy]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: DeadLetterPolicy.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[DeadLetterPolicy]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: DeadLetterPolicy.type

Request for the DeleteSnapshot method.

Value parameters

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

Attributes

Companion: object
Source: DeleteSnapshotRequest.scala
Supertypes: trait Updatable[DeleteSnapshotRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: DeleteSnapshotRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[DeleteSnapshotRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: DeleteSnapshotRequest.type

Request for the DeleteSubscription method.

Value parameters

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

Attributes

Companion: object
Source: DeleteSubscriptionRequest.scala
Supertypes: trait Updatable[DeleteSubscriptionRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: DeleteSubscriptionRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[DeleteSubscriptionRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: DeleteSubscriptionRequest.type

Request for the DeleteTopic method.

Value parameters

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

Attributes

Companion: object
Source: DeleteTopicRequest.scala
Supertypes: trait Updatable[DeleteTopicRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: DeleteTopicRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[DeleteTopicRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: DeleteTopicRequest.type

Request for the DetachSubscription method.

Value parameters

subscription: Required. The subscription to detach. Format is projects/{project}/subscriptions/{subscription}.

Attributes

Companion: object
Source: DetachSubscriptionRequest.scala
Supertypes: trait Updatable[DetachSubscriptionRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: DetachSubscriptionRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[DetachSubscriptionRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: DetachSubscriptionRequest.type

Response for the DetachSubscription method.

Response for the DetachSubscription method. Reserved for future use.

Attributes

Companion: object
Source: DetachSubscriptionResponse.scala
Supertypes: trait Updatable[DetachSubscriptionResponse]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: DetachSubscriptionResponse.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[DetachSubscriptionResponse]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: DetachSubscriptionResponse.type

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

Value parameters

ttl: Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for ttl depend on the type of the associated resource, as well. If ttl is not set, the associated resource never expires.

Attributes

Companion: object
Source: ExpirationPolicy.scala
Supertypes: trait Updatable[ExpirationPolicy]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ExpirationPolicy.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ExpirationPolicy]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ExpirationPolicy.type

Request for the GetSnapshot method.

Value parameters

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

Attributes

Companion: object
Source: GetSnapshotRequest.scala
Supertypes: trait Updatable[GetSnapshotRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: GetSnapshotRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[GetSnapshotRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: GetSnapshotRequest.type

Request for the GetSubscription method.

Value parameters

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

Attributes

Companion: object
Source: GetSubscriptionRequest.scala
Supertypes: trait Updatable[GetSubscriptionRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: GetSubscriptionRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[GetSubscriptionRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: GetSubscriptionRequest.type

Request for the GetTopic method.

Value parameters

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

Attributes

Companion: object
Source: GetTopicRequest.scala
Supertypes: trait Updatable[GetTopicRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: GetTopicRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[GetTopicRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: GetTopicRequest.type

Request for the ListSnapshots method.

Value parameters

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.
project: Required. The name of the project in which to list snapshots. Format is projects/{project-id}.

Attributes

Companion: object
Source: ListSnapshotsRequest.scala
Supertypes: trait Updatable[ListSnapshotsRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ListSnapshotsRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ListSnapshotsRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ListSnapshotsRequest.type

Response for the ListSnapshots method.

Value parameters

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

Attributes

Companion: object
Source: ListSnapshotsResponse.scala
Supertypes: trait Updatable[ListSnapshotsResponse]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ListSnapshotsResponse.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ListSnapshotsResponse]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ListSnapshotsResponse.type

Request for the ListSubscriptions method.

Value parameters

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.
project: Required. The name of the project in which to list subscriptions. Format is projects/{project-id}.

Attributes

Companion: object
Source: ListSubscriptionsRequest.scala
Supertypes: trait Updatable[ListSubscriptionsRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ListSubscriptionsRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ListSubscriptionsRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ListSubscriptionsRequest.type

Response for the ListSubscriptions method.

Value parameters

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.
subscriptions: The subscriptions that match the request.

Attributes

Companion: object
Source: ListSubscriptionsResponse.scala
Supertypes: trait Updatable[ListSubscriptionsResponse]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ListSubscriptionsResponse.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ListSubscriptionsResponse]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ListSubscriptionsResponse.type

Request for the ListTopicSnapshots method.

Value parameters

pageSize: Maximum number of snapshot names to return.
pageToken: The value returned by the last ListTopicSnapshotsResponse; indicates that this is a continuation of a prior ListTopicSnapshots call, and that the system should return the next page of data.
topic: Required. The name of the topic that snapshots are attached to. Format is projects/{project}/topics/{topic}.

Attributes

Companion: object
Source: ListTopicSnapshotsRequest.scala
Supertypes: trait Updatable[ListTopicSnapshotsRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ListTopicSnapshotsRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ListTopicSnapshotsRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ListTopicSnapshotsRequest.type

Response for the ListTopicSnapshots method.

Value parameters

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.
snapshots: The names of the snapshots that match the request.

Attributes

Companion: object
Source: ListTopicSnapshotsResponse.scala
Supertypes: trait Updatable[ListTopicSnapshotsResponse]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ListTopicSnapshotsResponse.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ListTopicSnapshotsResponse]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ListTopicSnapshotsResponse.type

Request for the ListTopicSubscriptions method.

Value parameters

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.
topic: Required. The name of the topic that subscriptions are attached to. Format is projects/{project}/topics/{topic}.

Attributes

Companion: object
Source: ListTopicSubscriptionsRequest.scala
Supertypes: trait Updatable[ListTopicSubscriptionsRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ListTopicSubscriptionsRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ListTopicSubscriptionsRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ListTopicSubscriptionsRequest.type

Response for the ListTopicSubscriptions method.

Value parameters

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.
subscriptions: The names of subscriptions attached to the topic specified in the request.

Attributes

Companion: object
Source: ListTopicSubscriptionsResponse.scala
Supertypes: trait Updatable[ListTopicSubscriptionsResponse]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ListTopicSubscriptionsResponse.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ListTopicSubscriptionsResponse]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ListTopicSubscriptionsResponse.type

Request for the ListTopics method.

Value parameters

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.
project: Required. The name of the project in which to list topics. Format is projects/{project-id}.

Attributes

Companion: object
Source: ListTopicsRequest.scala
Supertypes: trait Updatable[ListTopicsRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ListTopicsRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ListTopicsRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ListTopicsRequest.type

Response for the ListTopics method.

Value parameters

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

Attributes

Companion: object
Source: ListTopicsResponse.scala
Supertypes: trait Updatable[ListTopicsResponse]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ListTopicsResponse.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ListTopicsResponse]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ListTopicsResponse.type

A policy constraining the storage of messages published to the topic.

Value parameters

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

Attributes

Companion: object
Source: MessageStoragePolicy.scala
Supertypes: trait Updatable[MessageStoragePolicy]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: MessageStoragePolicy.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[MessageStoragePolicy]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: MessageStoragePolicy.type

Request for the ModifyAckDeadline method.

Value parameters

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).
ackIds: Required. List of acknowledgment IDs.
subscription: Required. The name of the subscription. Format is projects/{project}/subscriptions/{sub}.

Attributes

Companion: object
Source: ModifyAckDeadlineRequest.scala
Supertypes: trait Updatable[ModifyAckDeadlineRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ModifyAckDeadlineRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ModifyAckDeadlineRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ModifyAckDeadlineRequest.type

Request for the ModifyPushConfig method.

Value parameters

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 if Pull or StreamingPull is not called.
subscription: Required. The name of the subscription. Format is projects/{project}/subscriptions/{sub}.

Attributes

Companion: object
Source: ModifyPushConfigRequest.scala
Supertypes: trait Updatable[ModifyPushConfigRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ModifyPushConfigRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ModifyPushConfigRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ModifyPushConfigRequest.type

Request for the Publish method.

Value parameters

messages: Required. The messages to publish.
topic: Required. The messages in the request will be published on this topic. Format is projects/{project}/topics/{topic}.

Attributes

Companion: object
Source: PublishRequest.scala
Supertypes: trait Updatable[PublishRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: PublishRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[PublishRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: PublishRequest.type

Response for the Publish method.

Value parameters

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.

Attributes

Companion: object
Source: PublishResponse.scala
Supertypes: trait Updatable[PublishResponse]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: PublishResponse.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[PublishResponse]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: PublishResponse.type

The service that an application uses to manipulate topics, and to send messages to a topic.

Attributes

Companion: object
Source: Publisher.scala
Supertypes: class Object

trait Matchable

class Any

Attributes

Companion: trait
Source: Publisher.scala
Supertypes: class Object

trait Matchable

class Any
Self type: Publisher.type

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.

Value parameters

attributes: 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.
data: The message data field. If this field is empty, the message must contain at least one attribute.
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.
orderingKey: If non-empty, identifies related messages for which publish order should be respected. If a Subscription has enable_message_ordering set to true, messages published with the same non-empty ordering_key value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. All PubsubMessages published in a given PublishRequest must specify the same ordering_key value. For more information, see [ordering messages](https://cloud.google.com/pubsub/docs/ordering).
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.

Attributes

Companion: object
Source: PubsubMessage.scala
Supertypes: trait Updatable[PubsubMessage]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: PubsubMessage.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[PubsubMessage]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: PubsubMessage.type

Attributes

Source: PubsubProto.scala
Supertypes: class GeneratedFileObject

class Object

trait Matchable

class Any
Self type: PubsubProto.type

Request for the Pull method.

Value parameters

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.
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 to true is discouraged because it adversely impacts the performance of Pull operations. We recommend that users do not set this field.
subscription: Required. The subscription from which messages should be pulled. Format is projects/{project}/subscriptions/{sub}.

Attributes

Companion: object
Source: PullRequest.scala
Supertypes: trait Updatable[PullRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: PullRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[PullRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: PullRequest.type

Response for the Pull method.

Value parameters

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

Attributes

Companion: object
Source: PullResponse.scala
Supertypes: trait Updatable[PullResponse]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: PullResponse.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[PullResponse]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: PullResponse.type

Configuration for a push delivery endpoint.

Value parameters

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 the CreateSubscription call, it will default to the version of the Pub/Sub API used to make such call. If not present in a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the x-goog-version attribute are: * v1beta1: uses the push format defined in the v1beta1 Pub/Sub API. * v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" }
pushEndpoint: A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.

Attributes

Companion: object
Source: PushConfig.scala
Supertypes: trait Updatable[PushConfig]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: PushConfig.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[PushConfig]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: PushConfig.type

A message and its corresponding acknowledgment ID.

Value parameters

ackId: This ID can be used to acknowledge the received message.
deliveryAttempt: The approximate number of times that Cloud 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.
message: The message.

Attributes

Companion: object
Source: ReceivedMessage.scala
Supertypes: trait Updatable[ReceivedMessage]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ReceivedMessage.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ReceivedMessage]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ReceivedMessage.type

A policy that specifies how Cloud 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.

Value parameters

maximumBackoff: The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
minimumBackoff: The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.

Attributes

Companion: object
Source: RetryPolicy.scala
Supertypes: trait Updatable[RetryPolicy]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: RetryPolicy.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[RetryPolicy]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: RetryPolicy.type

Settings for validating messages published against a schema.

Value parameters

encoding: The encoding of messages validated against schema.
firstRevisionId: 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: 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.
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.

Attributes

Companion: object
Source: SchemaSettings.scala
Supertypes: trait Updatable[SchemaSettings]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: SchemaSettings.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[SchemaSettings]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: SchemaSettings.type

Request for the Seek method.

Value parameters

subscription: Required. The subscription to affect.

Attributes

Companion: object
Source: SeekRequest.scala
Supertypes: trait Updatable[SeekRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: SeekRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[SeekRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: SeekRequest.type

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

Attributes

Companion: object
Source: SeekResponse.scala
Supertypes: trait Updatable[SeekResponse]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: SeekResponse.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[SeekResponse]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: SeekResponse.type

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.

Value parameters

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 [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
name: The name of the snapshot.
topic: The name of the topic from which this snapshot is retaining messages.

Attributes

Companion: object
Source: Snapshot.scala
Supertypes: trait Updatable[Snapshot]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: Snapshot.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[Snapshot]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: Snapshot.type

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.

Value parameters

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.
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.
maxOutstandingBytes: 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 status INVALID_ARGUMENT.
maxOutstandingMessages: Flow control settings for the maximum number of outstanding messages. When there are max_outstanding_messages or more 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 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.
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.
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).
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}.

Attributes

Companion: object
Source: StreamingPullRequest.scala
Supertypes: trait Updatable[StreamingPullRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: StreamingPullRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[StreamingPullRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: StreamingPullRequest.type

Response for the StreamingPull method.

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

Value parameters

acknowledgeConfirmation: This field will only be set if enable_exactly_once_delivery is set to true.
modifyAckDeadlineConfirmation: This field will only be set if enable_exactly_once_delivery is set to true.
receivedMessages: Received Pub/Sub messages. This will not be empty.
subscriptionProperties: Properties associated with this subscription.

Attributes

Companion: object
Source: StreamingPullResponse.scala
Supertypes: trait Updatable[StreamingPullResponse]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: StreamingPullResponse.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[StreamingPullResponse]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: StreamingPullResponse.type

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 the StreamingPull method.

Attributes

Companion: object
Source: Subscriber.scala
Supertypes: class Object

trait Matchable

class Any

Attributes

Companion: trait
Source: Subscriber.scala
Supertypes: class Object

trait Matchable

class Any
Self type: Subscriber.type

final case class Subscription(name: String, topic: String, pushConfig: Option[PushConfig], bigqueryConfig: Option[BigQueryConfig], cloudStorageConfig: Option[CloudStorageConfig], ackDeadlineSeconds: Int, retainAckedMessages: Boolean, messageRetentionDuration: Option[Duration], labels: Map[String, String], enableMessageOrdering: Boolean, expirationPolicy: Option[ExpirationPolicy], filter: String, deadLetterPolicy: Option[DeadLetterPolicy], retryPolicy: Option[RetryPolicy], detached: Boolean, enableExactlyOnceDelivery: Boolean, topicMessageRetentionDuration: Option[Duration], state: State, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Subscription]

A subscription resource.

A subscription resource. If none of push_config, bigquery_config, or cloud_storage_config is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set.

Value parameters

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 _outstanding_. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call ModifyAckDeadline with the corresponding ack_id if using non-streaming pull or send the ack_id in a StreamingModifyAckDeadlineRequest if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message.
bigqueryConfig: If delivery to BigQuery is used with this subscription, this field is used to configure it.
cloudStorageConfig: If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
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.
detached: 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 and StreamingPull requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.
enableExactlyOnceDelivery: 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 when enable_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 distinct message_id values.
enableMessageOrdering: If true, messages published with the same ordering_key in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order.
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* with ttl of 31 days will be used. The minimum allowed value for expiration_policy.ttl is 1 day. If expiration_policy is set, but expiration_policy.ttl is not set, the subscription never expires.
filter: An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, then only PubsubMessages whose attributes field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.
labels: See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
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.
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".
pushConfig: If push delivery is used with this subscription, this field is used to configure it.
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 [Seek to a timestamp] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages.
retryPolicy: 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.
state: Output only. An output-only field indicating whether or not the subscription can receive messages.
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.
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 the message_retention_duration field in Topic. This field is set only in responses from the server; it is ignored if it is set in any requests.

Attributes

Companion: object
Source: Subscription.scala
Supertypes: trait Updatable[Subscription]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: Subscription.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[Subscription]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: Subscription.type

A topic resource.

Value parameters

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/*.
labels: See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
messageRetentionDuration: 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 to message_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.
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.
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".
satisfiesPzs: Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
schemaSettings: Settings for validating messages published against a schema.

Attributes

Companion: object
Source: Topic.scala
Supertypes: trait Updatable[Topic]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: Topic.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[Topic]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: Topic.type

Request for the UpdateSnapshot method.

Value parameters

snapshot: Required. The updated snapshot object.
updateMask: Required. Indicates which fields in the provided snapshot to update. Must be specified and non-empty.

Attributes

Companion: object
Source: UpdateSnapshotRequest.scala
Supertypes: trait Updatable[UpdateSnapshotRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: UpdateSnapshotRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[UpdateSnapshotRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: UpdateSnapshotRequest.type

Request for the UpdateSubscription method.

Value parameters

subscription: Required. The updated subscription object.
updateMask: Required. Indicates which fields in the provided subscription to update. Must be specified and non-empty.

Attributes

Companion: object
Source: UpdateSubscriptionRequest.scala
Supertypes: trait Updatable[UpdateSubscriptionRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: UpdateSubscriptionRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[UpdateSubscriptionRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: UpdateSubscriptionRequest.type

Request for the UpdateTopic method.

Value parameters

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 the message_storage_policy is not set in the topic provided above, then the updated value is determined by the policy configured at the project or organization level.

Attributes

Companion: object
Source: UpdateTopicRequest.scala
Supertypes: trait Updatable[UpdateTopicRequest]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: UpdateTopicRequest.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[UpdateTopicRequest]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: UpdateTopicRequest.type

com.google.pubsub.v1.pubsub

Members list

Type members

Classlikes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes