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.
- 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()
- Source
- Topic.scala
- Alphabetic
- By Inheritance
- Topic
- Updatable
- GeneratedMessage
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new 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)
- 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.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addAllLabels(__vs: Iterable[(String, String)]): Topic
- def addLabels(__vs: (String, String)*): Topic
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clearIngestionDataSourceSettings: Topic
- def clearLabels: Topic
- def clearMessageRetentionDuration: Topic
- def clearMessageStoragePolicy: Topic
- def clearSchemaSettings: Topic
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def companion: Topic.type
- Definition Classes
- Topic → GeneratedMessage
- def discardUnknownFields: Topic
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getField(__field: FieldDescriptor): PValue
- Definition Classes
- Topic → GeneratedMessage
- def getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- Topic → GeneratedMessage
- def getIngestionDataSourceSettings: IngestionDataSourceSettings
- def getMessageRetentionDuration: Duration
- def getMessageStoragePolicy: MessageStoragePolicy
- def getSchemaSettings: SchemaSettings
- val ingestionDataSourceSettings: Option[IngestionDataSourceSettings]
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val kmsKeyName: String
- val labels: Map[String, String]
- val messageRetentionDuration: Option[Duration]
- val messageStoragePolicy: Option[MessageStoragePolicy]
- val name: String
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val satisfiesPzs: Boolean
- val schemaSettings: Option[SchemaSettings]
- def serializedSize: Int
- Definition Classes
- Topic → GeneratedMessage
- val state: State
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def toByteArray: Array[Byte]
- Definition Classes
- GeneratedMessage
- final def toByteString: ByteString
- Definition Classes
- GeneratedMessage
- final def toPMessage: PMessage
- Definition Classes
- GeneratedMessage
- def toProtoString: String
- Definition Classes
- Topic → GeneratedMessage
- val unknownFields: UnknownFieldSet
- def update(ms: (Lens[Topic, Topic]) => Mutation[Topic]*): Topic
- Definition Classes
- Updatable
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withIngestionDataSourceSettings(__v: IngestionDataSourceSettings): Topic
- def withKmsKeyName(__v: String): Topic
- def withLabels(__v: Map[String, String]): Topic
- def withMessageRetentionDuration(__v: Duration): Topic
- def withMessageStoragePolicy(__v: MessageStoragePolicy): Topic
- def withName(__v: String): Topic
- def withSatisfiesPzs(__v: Boolean): Topic
- def withSchemaSettings(__v: SchemaSettings): Topic
- def withState(__v: State): Topic
- def withUnknownFields(__v: UnknownFieldSet): Topic
- final def writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
- def writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- Topic → GeneratedMessage
- final def writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage