Package com.google.pubsub.v1

Interface TopicOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Topic, Topic.Builder
public interface TopicOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsLabels(String key)
    See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
    String
    getKmsKeyName()
    The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic.
    com.google.protobuf.ByteString
    getKmsKeyNameBytes()
    The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic.
    Map<String,String>
    getLabels()
    Deprecated.
    int
    getLabelsCount()
    See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
    Map<String,String>
    getLabelsMap()
    See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
    String
    getLabelsOrDefault(String key, String defaultValue)
    See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
    String
    getLabelsOrThrow(String key)
    See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
    com.google.protobuf.Duration
    getMessageRetentionDuration()
    Indicates the minimum duration to retain a message after it is published to the topic.
    com.google.protobuf.DurationOrBuilder
    getMessageRetentionDurationOrBuilder()
    Indicates the minimum duration to retain a message after it is published to the topic.
    MessageStoragePolicy
    getMessageStoragePolicy()
    Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored.
    MessageStoragePolicyOrBuilder
    getMessageStoragePolicyOrBuilder()
    Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored.
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    boolean
    getSatisfiesPzs()
    Reserved for future use.
    SchemaSettings
    getSchemaSettings()
    Settings for validating messages published against a schema.
    SchemaSettingsOrBuilder
    getSchemaSettingsOrBuilder()
    Settings for validating messages published against a schema.
    boolean
    hasMessageRetentionDuration()
    Indicates the minimum duration to retain a message after it is published to the topic.
    boolean
    hasMessageStoragePolicy()
    Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored.
    boolean
    hasSchemaSettings()
    Settings for validating messages published against a schema.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getName

      String getName()
       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.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       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.

    • getLabelsCount

      int getLabelsCount()
       See [Creating and managing labels]
 (https://cloud.google.com/pubsub/docs/labels).
      map<string, string> labels = 2;

    • containsLabels

      boolean containsLabels(String key)
       See [Creating and managing labels]
 (https://cloud.google.com/pubsub/docs/labels).
      map<string, string> labels = 2;

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       See [Creating and managing labels]
 (https://cloud.google.com/pubsub/docs/labels).
      map<string, string> labels = 2;

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       See [Creating and managing labels]
 (https://cloud.google.com/pubsub/docs/labels).
      map<string, string> labels = 2;

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       See [Creating and managing labels]
 (https://cloud.google.com/pubsub/docs/labels).
      map<string, string> labels = 2;

    • hasMessageStoragePolicy

      boolean hasMessageStoragePolicy()
       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.

    • getMessageStoragePolicy

      MessageStoragePolicy getMessageStoragePolicy()
       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.

    • getMessageStoragePolicyOrBuilder

      MessageStoragePolicyOrBuilder getMessageStoragePolicyOrBuilder()
       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;

    • getKmsKeyName

      String getKmsKeyName()
       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.

    • getKmsKeyNameBytes

      com.google.protobuf.ByteString getKmsKeyNameBytes()
       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.

    • hasSchemaSettings

      boolean hasSchemaSettings()
       Settings for validating messages published against a schema.
      .google.pubsub.v1.SchemaSettings schema_settings = 6;
      Returns:
      Whether the schemaSettings field is set.

    • getSchemaSettings

      SchemaSettings getSchemaSettings()
       Settings for validating messages published against a schema.
      .google.pubsub.v1.SchemaSettings schema_settings = 6;
      Returns:
      The schemaSettings.

    • getSchemaSettingsOrBuilder

      SchemaSettingsOrBuilder getSchemaSettingsOrBuilder()
       Settings for validating messages published against a schema.
      .google.pubsub.v1.SchemaSettings schema_settings = 6;

    • getSatisfiesPzs

      boolean getSatisfiesPzs()
       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;
      Returns:
      The satisfiesPzs.

    • hasMessageRetentionDuration

      boolean hasMessageRetentionDuration()
       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;
      Returns:
      Whether the messageRetentionDuration field is set.

    • getMessageRetentionDuration

      com.google.protobuf.Duration getMessageRetentionDuration()
       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;
      Returns:
      The messageRetentionDuration.

    • getMessageRetentionDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getMessageRetentionDurationOrBuilder()
       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;