Packages

t

com.google.pubsub.v1

TopicOrBuilder

trait TopicOrBuilder extends MessageOrBuilder

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TopicOrBuilder
  2. MessageOrBuilder
  3. MessageLiteOrBuilder
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract 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];

  2. abstract def findInitializationErrors(): List[String]
    Definition Classes
    MessageOrBuilder
  3. abstract def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    MessageOrBuilder
  4. abstract def getDefaultInstanceForType(): Message
    Definition Classes
    MessageOrBuilder → MessageLiteOrBuilder
  5. abstract def getDescriptorForType(): Descriptor
    Definition Classes
    MessageOrBuilder
  6. abstract def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    MessageOrBuilder
  7. abstract 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.

  8. abstract 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];

  9. abstract def getInitializationErrorString(): String
    Definition Classes
    MessageOrBuilder
  10. abstract 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.

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

  12. abstract 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];

  13. abstract 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];

  14. abstract 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];

  15. abstract 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];

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

  17. abstract 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];

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

  19. abstract 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];

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

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

  22. abstract def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    MessageOrBuilder
  23. abstract def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    MessageOrBuilder
  24. abstract def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    MessageOrBuilder
  25. abstract 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.

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

  27. abstract 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];

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

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

  30. abstract def getUnknownFields(): UnknownFieldSet
    Definition Classes
    MessageOrBuilder
  31. abstract def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  32. abstract 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.

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

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

  35. abstract def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  36. abstract 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.

  37. abstract def isInitialized(): Boolean
    Definition Classes
    MessageLiteOrBuilder
  38. abstract def getLabels(): Map[String, String]

    Use #getLabelsMap() instead.

    Use #getLabelsMap() instead.

    Annotations
    @Deprecated
    Deprecated

Concrete 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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from MessageOrBuilder

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped