Topic

com.google.pubsub.v1.pubsub.Topic
See theTopic companion object
final case class Topic(name: String, labels: Map[String, String], messageStoragePolicy: Option[MessageStoragePolicy], kmsKeyName: String, schemaSettings: Option[SchemaSettings], satisfiesPzs: Boolean, messageRetentionDuration: Option[Duration], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Topic]

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
Graph
Supertypes
trait Updatable[Topic]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

Attributes

Source
Topic.scala
def addLabels(`__vs`: (String, String)*): Topic

Attributes

Source
Topic.scala

Attributes

Source
Topic.scala

Attributes

Source
Topic.scala
def companion: Topic.type

Attributes

Source
Topic.scala

Attributes

Source
Topic.scala
def getField(`__field`: FieldDescriptor): PValue

Attributes

Source
Topic.scala
def getFieldByNumber(`__fieldNumber`: Int): Any

Attributes

Source
Topic.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source
Topic.scala

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns

human-readable representation of this message.

Source
Topic.scala
def withKmsKeyName(`__v`: String): Topic

Attributes

Source
Topic.scala
def withLabels(`__v`: Map[String, String]): Topic

Attributes

Source
Topic.scala

Attributes

Source
Topic.scala
def withName(`__v`: String): Topic

Attributes

Source
Topic.scala

Attributes

Source
Topic.scala

Attributes

Source
Topic.scala
def withUnknownFields(`__v`: UnknownFieldSet): Topic

Attributes

Source
Topic.scala
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Source
Topic.scala

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
def update(ms: Lens[Topic, Topic] => () => Topic*): A

Attributes

Inherited from:
Updatable
Source
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala