Packages

final class Topic extends GeneratedMessageV3 with TopicOrBuilder

A topic resource.

Protobuf type google.pubsub.v1.Topic

Source
Topic.java
Linear Supertypes
TopicOrBuilder, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Topic
  2. TopicOrBuilder
  3. GeneratedMessageV3
  4. Serializable
  5. AbstractMessage
  6. Message
  7. MessageOrBuilder
  8. AbstractMessageLite
  9. MessageLite
  10. MessageLiteOrBuilder
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def containsLabels(key: String): Boolean

    Optional. See [Creating and managing labels]
(https://cloud.google.com/pubsub/docs/labels).


    Optional. See [Creating and managing labels]
(https://cloud.google.com/pubsub/docs/labels).

    map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(obj: AnyRef): Boolean
    Definition Classes
    Topic → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  11. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def getDefaultInstanceForType(): Topic
    Definition Classes
    Topic → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  14. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  15. def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  16. def getIngestionDataSourceSettings(): IngestionDataSourceSettings

    Optional. Settings for ingestion from a data source into this topic.


    Optional. Settings for ingestion from a data source into this topic.

    .google.pubsub.v1.IngestionDataSourceSettings ingestion_data_source_settings = 10 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The ingestionDataSourceSettings.

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  17. def getIngestionDataSourceSettingsOrBuilder(): IngestionDataSourceSettingsOrBuilder

    Optional. Settings for ingestion from a data source into this topic.


    Optional. Settings for ingestion from a data source into this topic.

    .google.pubsub.v1.IngestionDataSourceSettings ingestion_data_source_settings = 10 [(.google.api.field_behavior) = OPTIONAL];

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  18. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  19. def getKmsKeyName(): String

    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/*`.


    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/*`.

    string kms_key_name = 5 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The kmsKeyName.

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  20. def getKmsKeyNameBytes(): ByteString

    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/*`.


    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/*`.

    string kms_key_name = 5 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The bytes for kmsKeyName.

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  21. def getLabelsCount(): Int

    Optional. See [Creating and managing labels]
(https://cloud.google.com/pubsub/docs/labels).


    Optional. See [Creating and managing labels]
(https://cloud.google.com/pubsub/docs/labels).

    map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];

    Definition Classes
    Topic → TopicOrBuilder
  22. def getLabelsMap(): Map[String, String]

    Optional. See [Creating and managing labels]
(https://cloud.google.com/pubsub/docs/labels).


    Optional. See [Creating and managing labels]
(https://cloud.google.com/pubsub/docs/labels).

    map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  23. def getLabelsOrDefault(key: String, defaultValue: String): String

    Optional. See [Creating and managing labels]
(https://cloud.google.com/pubsub/docs/labels).


    Optional. See [Creating and managing labels]
(https://cloud.google.com/pubsub/docs/labels).

    map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  24. def getLabelsOrThrow(key: String): String

    Optional. See [Creating and managing labels]
(https://cloud.google.com/pubsub/docs/labels).


    Optional. See [Creating and managing labels]
(https://cloud.google.com/pubsub/docs/labels).

    map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  25. def getMessageRetentionDuration(): Duration

    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.


    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.

    .google.protobuf.Duration message_retention_duration = 8 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The messageRetentionDuration.

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  26. def getMessageRetentionDurationOrBuilder(): DurationOrBuilder

    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.


    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.

    .google.protobuf.Duration message_retention_duration = 8 [(.google.api.field_behavior) = OPTIONAL];

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  27. def getMessageStoragePolicy(): 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.


    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.

    .google.pubsub.v1.MessageStoragePolicy message_storage_policy = 3 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The messageStoragePolicy.

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  28. def getMessageStoragePolicyOrBuilder(): MessageStoragePolicyOrBuilder

    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.


    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.

    .google.pubsub.v1.MessageStoragePolicy message_storage_policy = 3 [(.google.api.field_behavior) = OPTIONAL];

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  29. def getName(): String

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


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

    string name = 1 [(.google.api.field_behavior) = REQUIRED];

    returns

    The name.

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  30. def getNameBytes(): ByteString

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


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

    string name = 1 [(.google.api.field_behavior) = REQUIRED];

    returns

    The bytes for name.

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  31. def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  32. def getParserForType(): Parser[Topic]
    Definition Classes
    Topic → GeneratedMessageV3 → Message → MessageLite
    Annotations
    @Override()
  33. def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  34. def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  35. def getSatisfiesPzs(): Boolean

    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.


    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.

    bool satisfies_pzs = 7 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The satisfiesPzs.

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  36. def getSchemaSettings(): SchemaSettings

    Optional. Settings for validating messages published against a schema.


    Optional. Settings for validating messages published against a schema.

    .google.pubsub.v1.SchemaSettings schema_settings = 6 [(.google.api.field_behavior) = OPTIONAL];

    returns

    The schemaSettings.

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  37. def getSchemaSettingsOrBuilder(): SchemaSettingsOrBuilder

    Optional. Settings for validating messages published against a schema.


    Optional. Settings for validating messages published against a schema.

    .google.pubsub.v1.SchemaSettings schema_settings = 6 [(.google.api.field_behavior) = OPTIONAL];

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  38. def getSerializedSize(): Int
    Definition Classes
    Topic → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  39. def getState(): State

    Output only. An output-only field indicating the state of the topic.


    Output only. An output-only field indicating the state of the topic.

    .google.pubsub.v1.Topic.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

    returns

    The state.

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  40. def getStateValue(): Int

    Output only. An output-only field indicating the state of the topic.


    Output only. An output-only field indicating the state of the topic.

    .google.pubsub.v1.Topic.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

    returns

    The enum numeric value on the wire for state.

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  41. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  42. def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  43. def hasIngestionDataSourceSettings(): Boolean

    Optional. Settings for ingestion from a data source into this topic.


    Optional. Settings for ingestion from a data source into this topic.

    .google.pubsub.v1.IngestionDataSourceSettings ingestion_data_source_settings = 10 [(.google.api.field_behavior) = OPTIONAL];

    returns

    Whether the ingestionDataSourceSettings field is set.

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  44. def hasMessageRetentionDuration(): Boolean

    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.


    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.

    .google.protobuf.Duration message_retention_duration = 8 [(.google.api.field_behavior) = OPTIONAL];

    returns

    Whether the messageRetentionDuration field is set.

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  45. def hasMessageStoragePolicy(): Boolean

    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.


    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.

    .google.pubsub.v1.MessageStoragePolicy message_storage_policy = 3 [(.google.api.field_behavior) = OPTIONAL];

    returns

    Whether the messageStoragePolicy field is set.

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  46. def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  47. def hasSchemaSettings(): Boolean

    Optional. Settings for validating messages published against a schema.


    Optional. Settings for validating messages published against a schema.

    .google.pubsub.v1.SchemaSettings schema_settings = 6 [(.google.api.field_behavior) = OPTIONAL];

    returns

    Whether the schemaSettings field is set.

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override()
  48. def hashCode(): Int
    Definition Classes
    Topic → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  49. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[v1]
    Definition Classes
    Topic → GeneratedMessageV3
    Annotations
    @Override()
  50. def internalGetMapField(arg0: Int): MapField[_ <: AnyRef, _ <: AnyRef]
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  51. def internalGetMapFieldReflection(number: Int): MapFieldReflectionAccessor
    Attributes
    protected[v1]
    Annotations
    @SuppressWarnings() @Override()
  52. final def isInitialized(): Boolean
    Definition Classes
    Topic → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  53. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  54. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  55. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  56. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[v1]
    Definition Classes
    Topic → GeneratedMessageV3
    Annotations
    @Override()
  57. def newBuilderForType(): Builder
    Definition Classes
    Topic → Message → MessageLite
    Annotations
    @Override()
  58. def newBuilderForType(arg0: BuilderParent): Builder
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3 → AbstractMessage
  59. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[v1]
    Definition Classes
    Topic → GeneratedMessageV3
    Annotations
    @Override() @SuppressWarnings()
  60. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  61. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  62. def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  63. def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  64. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  65. def toBuilder(): Builder
    Definition Classes
    Topic → Message → MessageLite
    Annotations
    @Override()
  66. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  67. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  68. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  69. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  70. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  71. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  72. def writeDelimitedTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  73. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.ObjectStreamException])
  74. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    Topic → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  75. def writeTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])

Deprecated Value Members

  1. def getLabels(): Map[String, String]

    Use #getLabelsMap() instead.

    Use #getLabelsMap() instead.

    Definition Classes
    Topic → TopicOrBuilder
    Annotations
    @Override() @Deprecated
    Deprecated
  2. def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[com.google.protobuf.InvalidProtocolBufferException]) @Deprecated
    Deprecated

Inherited from TopicOrBuilder

Inherited from GeneratedMessageV3

Inherited from Serializable

Inherited from AbstractMessage

Inherited from Message

Inherited from MessageOrBuilder

Inherited from AbstractMessageLite[MessageType, BuilderType]

Inherited from MessageLite

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped