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

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( ... ) @native() @HotSpotIntrinsicCandidate()
  6. def containsLabels(key: String): Boolean 

    See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.


    See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.

    map<string, string> labels = 2;

    Definition Classes
    Topic → TopicOrBuilder
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(obj: Any): Boolean
    Definition Classes
    Topic → AbstractMessage → Message → AnyRef → Any
  9. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  10. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def getDefaultInstanceForType(): Topic
    Definition Classes
    Topic → MessageOrBuilder → MessageLiteOrBuilder
  13. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  14. def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  15. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  16. def getKmsKeyName(): String 

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


    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;

    returns

    The kmsKeyName.

    Definition Classes
    Topic → TopicOrBuilder
  17. def getKmsKeyNameBytes(): ByteString 

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


    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;

    returns

    The bytes for kmsKeyName.

    Definition Classes
    Topic → TopicOrBuilder
  18. def getLabels(): Map[String, String]

    Use #getLabelsMap() instead.

    Use #getLabelsMap() instead.

    Definition Classes
    Topic → TopicOrBuilder
  19. def getLabelsCount(): Int 

    See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.


    See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.

    map<string, string> labels = 2;

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

    See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.


    See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.

    map<string, string> labels = 2;

    Definition Classes
    Topic → TopicOrBuilder
  21. def getLabelsOrDefault(key: String, defaultValue: String): String 

    See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.


    See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.

    map<string, string> labels = 2;

    Definition Classes
    Topic → TopicOrBuilder
  22. def getLabelsOrThrow(key: String): String 

    See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.


    See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
managing labels</a>.

    map<string, string> labels = 2;

    Definition Classes
    Topic → TopicOrBuilder
  23. def getMessageStoragePolicy(): 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.


    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;

    returns

    The messageStoragePolicy.

    Definition Classes
    Topic → TopicOrBuilder
  24. def getMessageStoragePolicyOrBuilder(): MessageStoragePolicyOrBuilder 

    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.


    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;

    Definition Classes
    Topic → TopicOrBuilder
  25. 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
  26. 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
  27. def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  28. def getParserForType(): Parser[Topic]
    Definition Classes
    Topic → GeneratedMessageV3 → Message → MessageLite
  29. def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  30. def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  31. def getSerializedSize(): Int
    Definition Classes
    Topic → GeneratedMessageV3 → AbstractMessage → MessageLite
  32. final def getUnknownFields(): UnknownFieldSet
    Definition Classes
    Topic → GeneratedMessageV3 → MessageOrBuilder
  33. def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  34. def hasMessageStoragePolicy(): Boolean 

    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.


    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;

    returns

    Whether the messageStoragePolicy field is set.

    Definition Classes
    Topic → TopicOrBuilder
  35. def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  36. def hashCode(): Int
    Definition Classes
    Topic → AbstractMessage → Message → AnyRef → Any
  37. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[v1]
    Definition Classes
    Topic → GeneratedMessageV3
  38. def internalGetMapField(number: Int): MapField
    Attributes
    protected[v1]
    Definition Classes
    Topic → GeneratedMessageV3
  39. final def isInitialized(): Boolean
    Definition Classes
    Topic → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
  40. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  41. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  42. def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( ... )
  43. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  44. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[v1]
    Definition Classes
    Topic → GeneratedMessageV3
  45. def newBuilderForType(): Builder
    Definition Classes
    Topic → Message → MessageLite
  46. def newBuilderForType(arg0: BuilderParent): Builder
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3 → AbstractMessage
  47. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[v1]
    Definition Classes
    Topic → GeneratedMessageV3
  48. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  49. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  50. def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( classOf[java.io.IOException] )
  51. def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( classOf[java.io.IOException] )
  52. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  53. def toBuilder(): Builder
    Definition Classes
    Topic → Message → MessageLite
  54. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  55. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  56. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  57. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  59. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. def writeDelimitedTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws( classOf[java.io.IOException] )
  61. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( ... )
  62. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    Topic → GeneratedMessageV3 → AbstractMessage → MessageLite
  63. def writeTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws( classOf[java.io.IOException] )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

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