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

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
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Topic
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

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

    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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllLabels(__vs: Iterable[(String, String)]): Topic
  5. def addLabels(__vs: (String, String)*): Topic
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clearIngestionDataSourceSettings: Topic
  8. def clearLabels: Topic
  9. def clearMessageRetentionDuration: Topic
  10. def clearMessageStoragePolicy: Topic
  11. def clearSchemaSettings: Topic
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  13. def companion: Topic.type
    Definition Classes
    Topic → GeneratedMessage
  14. def discardUnknownFields: Topic
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    Topic → GeneratedMessage
  19. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    Topic → GeneratedMessage
  20. def getIngestionDataSourceSettings: IngestionDataSourceSettings
  21. def getMessageRetentionDuration: Duration
  22. def getMessageStoragePolicy: MessageStoragePolicy
  23. def getSchemaSettings: SchemaSettings
  24. val ingestionDataSourceSettings: Option[IngestionDataSourceSettings]
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. val kmsKeyName: String
  27. val labels: Map[String, String]
  28. val messageRetentionDuration: Option[Duration]
  29. val messageStoragePolicy: Option[MessageStoragePolicy]
  30. val name: String
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. def productElementNames: Iterator[String]
    Definition Classes
    Product
  35. val satisfiesPzs: Boolean
  36. val schemaSettings: Option[SchemaSettings]
  37. def serializedSize: Int
    Definition Classes
    Topic → GeneratedMessage
  38. val state: State
  39. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  40. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  41. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  42. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  43. def toProtoString: String
    Definition Classes
    Topic → GeneratedMessage
  44. val unknownFields: UnknownFieldSet
  45. def update(ms: (Lens[Topic, Topic]) => Mutation[Topic]*): Topic
    Definition Classes
    Updatable
  46. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  47. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  48. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  49. def withIngestionDataSourceSettings(__v: IngestionDataSourceSettings): Topic
  50. def withKmsKeyName(__v: String): Topic
  51. def withLabels(__v: Map[String, String]): Topic
  52. def withMessageRetentionDuration(__v: Duration): Topic
  53. def withMessageStoragePolicy(__v: MessageStoragePolicy): Topic
  54. def withName(__v: String): Topic
  55. def withSatisfiesPzs(__v: Boolean): Topic
  56. def withSchemaSettings(__v: SchemaSettings): Topic
  57. def withState(__v: State): Topic
  58. def withUnknownFields(__v: UnknownFieldSet): Topic
  59. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  60. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    Topic → GeneratedMessage
  61. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Updatable[Topic]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped