v1

package v1

Package Members

package pubsub
package schema

Type Members

final class AcknowledgeRequest extends GeneratedMessageV3 with AcknowledgeRequestOrBuilder
```
Request for the Acknowledge method.
```
```
Request for the Acknowledge method.
```
Protobuf type google.pubsub.v1.AcknowledgeRequest
trait AcknowledgeRequestOrBuilder extends MessageOrBuilder
final class CreateSchemaRequest extends GeneratedMessageV3 with CreateSchemaRequestOrBuilder
```
Request for the CreateSchema method.
```
```
Request for the CreateSchema method.
```
Protobuf type google.pubsub.v1.CreateSchemaRequest
trait CreateSchemaRequestOrBuilder extends MessageOrBuilder
final class CreateSnapshotRequest extends GeneratedMessageV3 with CreateSnapshotRequestOrBuilder
```
Request for the `CreateSnapshot` method.
```
```
Request for the `CreateSnapshot` method.
```
Protobuf type google.pubsub.v1.CreateSnapshotRequest
trait CreateSnapshotRequestOrBuilder extends MessageOrBuilder

final class DeadLetterPolicy extends GeneratedMessageV3 with DeadLetterPolicyOrBuilder

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.

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.

Protobuf type google.pubsub.v1.DeadLetterPolicy

trait DeadLetterPolicyOrBuilder extends MessageOrBuilder
final class DeleteSchemaRequest extends GeneratedMessageV3 with DeleteSchemaRequestOrBuilder
```
Request for the `DeleteSchema` method.
```
```
Request for the `DeleteSchema` method.
```
Protobuf type google.pubsub.v1.DeleteSchemaRequest
trait DeleteSchemaRequestOrBuilder extends MessageOrBuilder
final class DeleteSnapshotRequest extends GeneratedMessageV3 with DeleteSnapshotRequestOrBuilder
```
Request for the `DeleteSnapshot` method.
```
```
Request for the `DeleteSnapshot` method.
```
Protobuf type google.pubsub.v1.DeleteSnapshotRequest
trait DeleteSnapshotRequestOrBuilder extends MessageOrBuilder
final class DeleteSubscriptionRequest extends GeneratedMessageV3 with DeleteSubscriptionRequestOrBuilder
```
Request for the DeleteSubscription method.
```
```
Request for the DeleteSubscription method.
```
Protobuf type google.pubsub.v1.DeleteSubscriptionRequest
trait DeleteSubscriptionRequestOrBuilder extends MessageOrBuilder
final class DeleteTopicRequest extends GeneratedMessageV3 with DeleteTopicRequestOrBuilder
```
Request for the `DeleteTopic` method.
```
```
Request for the `DeleteTopic` method.
```
Protobuf type google.pubsub.v1.DeleteTopicRequest
trait DeleteTopicRequestOrBuilder extends MessageOrBuilder
final class DetachSubscriptionRequest extends GeneratedMessageV3 with DetachSubscriptionRequestOrBuilder
```
Request for the DetachSubscription method.
```
```
Request for the DetachSubscription method.
```
Protobuf type google.pubsub.v1.DetachSubscriptionRequest
trait DetachSubscriptionRequestOrBuilder extends MessageOrBuilder
final class DetachSubscriptionResponse extends GeneratedMessageV3 with DetachSubscriptionResponseOrBuilder
```
Response for the DetachSubscription method.
Reserved for future use.
```
```
Response for the DetachSubscription method.
Reserved for future use.
```
Protobuf type google.pubsub.v1.DetachSubscriptionResponse
trait DetachSubscriptionResponseOrBuilder extends MessageOrBuilder
sealed final class Encoding extends Enum[Encoding] with ProtocolMessageEnum
```
Possible encoding types for messages.
```
```
Possible encoding types for messages.
```
Protobuf enum google.pubsub.v1.Encoding

final class ExpirationPolicy extends GeneratedMessageV3 with ExpirationPolicyOrBuilder

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

Protobuf type google.pubsub.v1.ExpirationPolicy

trait ExpirationPolicyOrBuilder extends MessageOrBuilder
final class GetSchemaRequest extends GeneratedMessageV3 with GetSchemaRequestOrBuilder
```
Request for the GetSchema method.
```
```
Request for the GetSchema method.
```
Protobuf type google.pubsub.v1.GetSchemaRequest
trait GetSchemaRequestOrBuilder extends MessageOrBuilder
final class GetSnapshotRequest extends GeneratedMessageV3 with GetSnapshotRequestOrBuilder
```
Request for the GetSnapshot method.
```
```
Request for the GetSnapshot method.
```
Protobuf type google.pubsub.v1.GetSnapshotRequest
trait GetSnapshotRequestOrBuilder extends MessageOrBuilder
final class GetSubscriptionRequest extends GeneratedMessageV3 with GetSubscriptionRequestOrBuilder
```
Request for the GetSubscription method.
```
```
Request for the GetSubscription method.
```
Protobuf type google.pubsub.v1.GetSubscriptionRequest
trait GetSubscriptionRequestOrBuilder extends MessageOrBuilder
final class GetTopicRequest extends GeneratedMessageV3 with GetTopicRequestOrBuilder
```
Request for the GetTopic method.
```
```
Request for the GetTopic method.
```
Protobuf type google.pubsub.v1.GetTopicRequest
trait GetTopicRequestOrBuilder extends MessageOrBuilder
final class ListSchemasRequest extends GeneratedMessageV3 with ListSchemasRequestOrBuilder
```
Request for the `ListSchemas` method.
```
```
Request for the `ListSchemas` method.
```
Protobuf type google.pubsub.v1.ListSchemasRequest
trait ListSchemasRequestOrBuilder extends MessageOrBuilder
final class ListSchemasResponse extends GeneratedMessageV3 with ListSchemasResponseOrBuilder
```
Response for the `ListSchemas` method.
```
```
Response for the `ListSchemas` method.
```
Protobuf type google.pubsub.v1.ListSchemasResponse
trait ListSchemasResponseOrBuilder extends MessageOrBuilder
final class ListSnapshotsRequest extends GeneratedMessageV3 with ListSnapshotsRequestOrBuilder
```
Request for the `ListSnapshots` method.
```
```
Request for the `ListSnapshots` method.
```
Protobuf type google.pubsub.v1.ListSnapshotsRequest
trait ListSnapshotsRequestOrBuilder extends MessageOrBuilder
final class ListSnapshotsResponse extends GeneratedMessageV3 with ListSnapshotsResponseOrBuilder
```
Response for the `ListSnapshots` method.
```
```
Response for the `ListSnapshots` method.
```
Protobuf type google.pubsub.v1.ListSnapshotsResponse
trait ListSnapshotsResponseOrBuilder extends MessageOrBuilder
final class ListSubscriptionsRequest extends GeneratedMessageV3 with ListSubscriptionsRequestOrBuilder
```
Request for the `ListSubscriptions` method.
```
```
Request for the `ListSubscriptions` method.
```
Protobuf type google.pubsub.v1.ListSubscriptionsRequest
trait ListSubscriptionsRequestOrBuilder extends MessageOrBuilder
final class ListSubscriptionsResponse extends GeneratedMessageV3 with ListSubscriptionsResponseOrBuilder
```
Response for the `ListSubscriptions` method.
```
```
Response for the `ListSubscriptions` method.
```
Protobuf type google.pubsub.v1.ListSubscriptionsResponse
trait ListSubscriptionsResponseOrBuilder extends MessageOrBuilder
final class ListTopicSnapshotsRequest extends GeneratedMessageV3 with ListTopicSnapshotsRequestOrBuilder
```
Request for the `ListTopicSnapshots` method.
```
```
Request for the `ListTopicSnapshots` method.
```
Protobuf type google.pubsub.v1.ListTopicSnapshotsRequest
trait ListTopicSnapshotsRequestOrBuilder extends MessageOrBuilder
final class ListTopicSnapshotsResponse extends GeneratedMessageV3 with ListTopicSnapshotsResponseOrBuilder
```
Response for the `ListTopicSnapshots` method.
```
```
Response for the `ListTopicSnapshots` method.
```
Protobuf type google.pubsub.v1.ListTopicSnapshotsResponse
trait ListTopicSnapshotsResponseOrBuilder extends MessageOrBuilder
final class ListTopicSubscriptionsRequest extends GeneratedMessageV3 with ListTopicSubscriptionsRequestOrBuilder
```
Request for the `ListTopicSubscriptions` method.
```
```
Request for the `ListTopicSubscriptions` method.
```
Protobuf type google.pubsub.v1.ListTopicSubscriptionsRequest
trait ListTopicSubscriptionsRequestOrBuilder extends MessageOrBuilder
final class ListTopicSubscriptionsResponse extends GeneratedMessageV3 with ListTopicSubscriptionsResponseOrBuilder
```
Response for the `ListTopicSubscriptions` method.
```
```
Response for the `ListTopicSubscriptions` method.
```
Protobuf type google.pubsub.v1.ListTopicSubscriptionsResponse
trait ListTopicSubscriptionsResponseOrBuilder extends MessageOrBuilder
final class ListTopicsRequest extends GeneratedMessageV3 with ListTopicsRequestOrBuilder
```
Request for the `ListTopics` method.
```
```
Request for the `ListTopics` method.
```
Protobuf type google.pubsub.v1.ListTopicsRequest
trait ListTopicsRequestOrBuilder extends MessageOrBuilder
final class ListTopicsResponse extends GeneratedMessageV3 with ListTopicsResponseOrBuilder
```
Response for the `ListTopics` method.
```
```
Response for the `ListTopics` method.
```
Protobuf type google.pubsub.v1.ListTopicsResponse
trait ListTopicsResponseOrBuilder extends MessageOrBuilder

final class MessageStoragePolicy extends GeneratedMessageV3 with MessageStoragePolicyOrBuilder

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

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

Protobuf type google.pubsub.v1.MessageStoragePolicy

trait MessageStoragePolicyOrBuilder extends MessageOrBuilder
final class ModifyAckDeadlineRequest extends GeneratedMessageV3 with ModifyAckDeadlineRequestOrBuilder
```
Request for the ModifyAckDeadline method.
```
```
Request for the ModifyAckDeadline method.
```
Protobuf type google.pubsub.v1.ModifyAckDeadlineRequest
trait ModifyAckDeadlineRequestOrBuilder extends MessageOrBuilder
final class ModifyPushConfigRequest extends GeneratedMessageV3 with ModifyPushConfigRequestOrBuilder
```
Request for the ModifyPushConfig method.
```
```
Request for the ModifyPushConfig method.
```
Protobuf type google.pubsub.v1.ModifyPushConfigRequest
trait ModifyPushConfigRequestOrBuilder extends MessageOrBuilder
final class PublishRequest extends GeneratedMessageV3 with PublishRequestOrBuilder
```
Request for the Publish method.
```
```
Request for the Publish method.
```
Protobuf type google.pubsub.v1.PublishRequest
trait PublishRequestOrBuilder extends MessageOrBuilder
final class PublishResponse extends GeneratedMessageV3 with PublishResponseOrBuilder
```
Response for the `Publish` method.
```
```
Response for the `Publish` method.
```
Protobuf type google.pubsub.v1.PublishResponse
trait PublishResponseOrBuilder extends MessageOrBuilder
trait Publisher extends AnyRef
The service that an application uses to manipulate topics, and to send messages to a topic.
abstract class PublisherClient extends PublisherClientPowerApi with Publisher with PekkoGrpcClient
Annotations
@PekkoGrpcGenerated()
abstract class PublisherClientPowerApi extends AnyRef
Annotations
@PekkoGrpcGenerated()

final class PubsubMessage extends GeneratedMessageV3 with PubsubMessageOrBuilder

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.

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.

Protobuf type google.pubsub.v1.PubsubMessage

trait PubsubMessageOrBuilder extends MessageOrBuilder
final class PubsubProto extends AnyRef
final class PullRequest extends GeneratedMessageV3 with PullRequestOrBuilder
```
Request for the `Pull` method.
```
```
Request for the `Pull` method.
```
Protobuf type google.pubsub.v1.PullRequest
trait PullRequestOrBuilder extends MessageOrBuilder
final class PullResponse extends GeneratedMessageV3 with PullResponseOrBuilder
```
Response for the `Pull` method.
```
```
Response for the `Pull` method.
```
Protobuf type google.pubsub.v1.PullResponse
trait PullResponseOrBuilder extends MessageOrBuilder
final class PushConfig extends GeneratedMessageV3 with PushConfigOrBuilder
```
Configuration for a push delivery endpoint.
```
```
Configuration for a push delivery endpoint.
```
Protobuf type google.pubsub.v1.PushConfig
trait PushConfigOrBuilder extends MessageOrBuilder
final class ReceivedMessage extends GeneratedMessageV3 with ReceivedMessageOrBuilder
```
A message and its corresponding acknowledgment ID.
```
```
A message and its corresponding acknowledgment ID.
```
Protobuf type google.pubsub.v1.ReceivedMessage
trait ReceivedMessageOrBuilder extends MessageOrBuilder

final class RetryPolicy extends GeneratedMessageV3 with RetryPolicyOrBuilder

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.

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.

Protobuf type google.pubsub.v1.RetryPolicy

trait RetryPolicyOrBuilder extends MessageOrBuilder
final class Schema extends GeneratedMessageV3 with SchemaOrBuilder
```
A schema resource.
```
```
A schema resource.
```
Protobuf type google.pubsub.v1.Schema
trait SchemaOrBuilder extends MessageOrBuilder
final class SchemaProto extends AnyRef
trait SchemaService extends AnyRef
Service for doing schema-related operations.
abstract class SchemaServiceClient extends SchemaServiceClientPowerApi with SchemaService with PekkoGrpcClient
Annotations
@PekkoGrpcGenerated()
abstract class SchemaServiceClientPowerApi extends AnyRef
Annotations
@PekkoGrpcGenerated()

final class SchemaSettings extends GeneratedMessageV3 with SchemaSettingsOrBuilder

Settings for validating messages published against a schema.

Settings for validating messages published against a schema.

Protobuf type google.pubsub.v1.SchemaSettings

trait SchemaSettingsOrBuilder extends MessageOrBuilder

sealed final class SchemaView extends Enum[SchemaView] with ProtocolMessageEnum

View of Schema object fields to be returned by GetSchema and ListSchemas.

View of Schema object fields to be returned by GetSchema and ListSchemas.

Protobuf enum google.pubsub.v1.SchemaView

final class SeekRequest extends GeneratedMessageV3 with SeekRequestOrBuilder
```
Request for the `Seek` method.
```
```
Request for the `Seek` method.
```
Protobuf type google.pubsub.v1.SeekRequest
trait SeekRequestOrBuilder extends MessageOrBuilder
final class SeekResponse extends GeneratedMessageV3 with SeekResponseOrBuilder
```
Response for the `Seek` method (this response is empty).
```
```
Response for the `Seek` method (this response is empty).
```
Protobuf type google.pubsub.v1.SeekResponse
trait SeekResponseOrBuilder extends MessageOrBuilder

final class Snapshot extends GeneratedMessageV3 with SnapshotOrBuilder

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.

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.

Protobuf type google.pubsub.v1.Snapshot

trait SnapshotOrBuilder extends MessageOrBuilder

final class StreamingPullRequest extends GeneratedMessageV3 with StreamingPullRequestOrBuilder

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.

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.

Protobuf type google.pubsub.v1.StreamingPullRequest

trait StreamingPullRequestOrBuilder extends MessageOrBuilder

final class StreamingPullResponse extends GeneratedMessageV3 with StreamingPullResponseOrBuilder

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

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

Protobuf type google.pubsub.v1.StreamingPullResponse

trait StreamingPullResponseOrBuilder extends MessageOrBuilder
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 the StreamingPull method.
abstract class SubscriberClient extends SubscriberClientPowerApi with Subscriber with PekkoGrpcClient
Annotations
@PekkoGrpcGenerated()
abstract class SubscriberClientPowerApi extends AnyRef
Annotations
@PekkoGrpcGenerated()
final class Subscription extends GeneratedMessageV3 with SubscriptionOrBuilder
```
A subscription resource.
```
```
A subscription resource.
```
Protobuf type google.pubsub.v1.Subscription
trait SubscriptionOrBuilder extends MessageOrBuilder
final class Topic extends GeneratedMessageV3 with TopicOrBuilder
```
A topic resource.
```
```
A topic resource.
```
Protobuf type google.pubsub.v1.Topic
trait TopicOrBuilder extends MessageOrBuilder
final class UpdateSnapshotRequest extends GeneratedMessageV3 with UpdateSnapshotRequestOrBuilder
```
Request for the UpdateSnapshot method.
```
```
Request for the UpdateSnapshot method.
```
Protobuf type google.pubsub.v1.UpdateSnapshotRequest
trait UpdateSnapshotRequestOrBuilder extends MessageOrBuilder
final class UpdateSubscriptionRequest extends GeneratedMessageV3 with UpdateSubscriptionRequestOrBuilder
```
Request for the UpdateSubscription method.
```
```
Request for the UpdateSubscription method.
```
Protobuf type google.pubsub.v1.UpdateSubscriptionRequest
trait UpdateSubscriptionRequestOrBuilder extends MessageOrBuilder
final class UpdateTopicRequest extends GeneratedMessageV3 with UpdateTopicRequestOrBuilder
```
Request for the UpdateTopic method.
```
```
Request for the UpdateTopic method.
```
Protobuf type google.pubsub.v1.UpdateTopicRequest
trait UpdateTopicRequestOrBuilder extends MessageOrBuilder
final class ValidateMessageRequest extends GeneratedMessageV3 with ValidateMessageRequestOrBuilder
```
Request for the `ValidateMessage` method.
```
```
Request for the `ValidateMessage` method.
```
Protobuf type google.pubsub.v1.ValidateMessageRequest
trait ValidateMessageRequestOrBuilder extends MessageOrBuilder
final class ValidateMessageResponse extends GeneratedMessageV3 with ValidateMessageResponseOrBuilder
```
Response for the `ValidateMessage` method.
```
```
Response for the `ValidateMessage` method.
```
Protobuf type google.pubsub.v1.ValidateMessageResponse
trait ValidateMessageResponseOrBuilder extends MessageOrBuilder
final class ValidateSchemaRequest extends GeneratedMessageV3 with ValidateSchemaRequestOrBuilder
```
Request for the `ValidateSchema` method.
```
```
Request for the `ValidateSchema` method.
```
Protobuf type google.pubsub.v1.ValidateSchemaRequest
trait ValidateSchemaRequestOrBuilder extends MessageOrBuilder
final class ValidateSchemaResponse extends GeneratedMessageV3 with ValidateSchemaResponseOrBuilder
```
Response for the `ValidateSchema` method.
```
```
Response for the `ValidateSchema` method.
```
Protobuf type google.pubsub.v1.ValidateSchemaResponse
trait ValidateSchemaResponseOrBuilder extends MessageOrBuilder

Packages

v1

package v1

Package Members

Type Members

Ungrouped

Packages

v1

package v1

Package Members

Type Members

Ungrouped

v1