Package com.google.pubsub.v1

Class Topic.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TopicOrBuilder, Cloneable
    Enclosing class:
    Topic
    public static final class Topic.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Topic.Builder>
implements TopicOrBuilder
     A topic resource.
    Protobuf type google.pubsub.v1.Topic

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Topic.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Topic.Builder>

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Topic.Builder>

      • clear

        public Topic.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Topic.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Topic.Builder>

      • getDefaultInstanceForType

        public Topic getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public Topic build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public Topic buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public Topic.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Topic.Builder>

      • setField

        public Topic.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                              Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Topic.Builder>

      • clearField

        public Topic.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Topic.Builder>

      • clearOneof

        public Topic.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Topic.Builder>

      • setRepeatedField

        public Topic.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      int index,
                                      Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Topic.Builder>

      • addRepeatedField

        public Topic.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Topic.Builder>

      • mergeFrom

        public Topic.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Topic.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Topic.Builder>

      • mergeFrom

        public Topic.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Topic.Builder>
        Throws:
        IOException

      • getName

        public 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];
        Specified by:
        getName in interface TopicOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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];
        Specified by:
        getNameBytes in interface TopicOrBuilder
        Returns:
        The bytes for name.

      • setName

        public Topic.Builder setName​(String value)
         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];
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public Topic.Builder clearName()
         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:
        This builder for chaining.

      • setNameBytes

        public Topic.Builder setNameBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: TopicOrBuilder
         See [Creating and managing labels]
 (https://cloud.google.com/pubsub/docs/labels).
        map<string, string> labels = 2;
        Specified by:
        getLabelsCount in interface TopicOrBuilder

      • containsLabels

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

      • getLabelsMap

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

      • getLabelsOrDefault

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

      • getLabelsOrThrow

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

      • removeLabels

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

      • getMutableLabels

        @Deprecated
public Map<String,​String> getMutableLabels()
        Deprecated.
        Use alternate mutation accessors instead.

      • putLabels

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

      • putAllLabels

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

      • hasMessageStoragePolicy

        public 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;
        Specified by:
        hasMessageStoragePolicy in interface TopicOrBuilder
        Returns:
        Whether the messageStoragePolicy field is set.

      • getMessageStoragePolicy

        public 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;
        Specified by:
        getMessageStoragePolicy in interface TopicOrBuilder
        Returns:
        The messageStoragePolicy.

      • setMessageStoragePolicy

        public Topic.Builder setMessageStoragePolicy​(MessageStoragePolicy value)
         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;

      • setMessageStoragePolicy

        public Topic.Builder setMessageStoragePolicy​(MessageStoragePolicy.Builder builderForValue)
         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;

      • mergeMessageStoragePolicy

        public Topic.Builder mergeMessageStoragePolicy​(MessageStoragePolicy value)
         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;

      • clearMessageStoragePolicy

        public Topic.Builder clearMessageStoragePolicy()
         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;

      • getMessageStoragePolicyBuilder

        public MessageStoragePolicy.Builder getMessageStoragePolicyBuilder()
         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;

      • getMessageStoragePolicyOrBuilder

        public 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;
        Specified by:
        getMessageStoragePolicyOrBuilder in interface TopicOrBuilder

      • getKmsKeyName

        public 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;
        Specified by:
        getKmsKeyName in interface TopicOrBuilder
        Returns:
        The kmsKeyName.

      • getKmsKeyNameBytes

        public 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;
        Specified by:
        getKmsKeyNameBytes in interface TopicOrBuilder
        Returns:
        The bytes for kmsKeyName.

      • setKmsKeyName

        public Topic.Builder setKmsKeyName​(String value)
         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;
        Parameters:
        value - The kmsKeyName to set.
        Returns:
        This builder for chaining.

      • clearKmsKeyName

        public Topic.Builder clearKmsKeyName()
         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:
        This builder for chaining.

      • setKmsKeyNameBytes

        public Topic.Builder setKmsKeyNameBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for kmsKeyName to set.
        Returns:
        This builder for chaining.

      • hasSchemaSettings

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

      • getSchemaSettings

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

      • setSchemaSettings

        public Topic.Builder setSchemaSettings​(SchemaSettings value)
         Settings for validating messages published against a schema.
        .google.pubsub.v1.SchemaSettings schema_settings = 6;

      • setSchemaSettings

        public Topic.Builder setSchemaSettings​(SchemaSettings.Builder builderForValue)
         Settings for validating messages published against a schema.
        .google.pubsub.v1.SchemaSettings schema_settings = 6;

      • mergeSchemaSettings

        public Topic.Builder mergeSchemaSettings​(SchemaSettings value)
         Settings for validating messages published against a schema.
        .google.pubsub.v1.SchemaSettings schema_settings = 6;

      • clearSchemaSettings

        public Topic.Builder clearSchemaSettings()
         Settings for validating messages published against a schema.
        .google.pubsub.v1.SchemaSettings schema_settings = 6;

      • getSchemaSettingsBuilder

        public SchemaSettings.Builder getSchemaSettingsBuilder()
         Settings for validating messages published against a schema.
        .google.pubsub.v1.SchemaSettings schema_settings = 6;

      • getSatisfiesPzs

        public 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;
        Specified by:
        getSatisfiesPzs in interface TopicOrBuilder
        Returns:
        The satisfiesPzs.

      • setSatisfiesPzs

        public Topic.Builder setSatisfiesPzs​(boolean value)
         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;
        Parameters:
        value - The satisfiesPzs to set.
        Returns:
        This builder for chaining.

      • clearSatisfiesPzs

        public Topic.Builder clearSatisfiesPzs()
         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:
        This builder for chaining.

      • hasMessageRetentionDuration

        public 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;
        Specified by:
        hasMessageRetentionDuration in interface TopicOrBuilder
        Returns:
        Whether the messageRetentionDuration field is set.

      • getMessageRetentionDuration

        public 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;
        Specified by:
        getMessageRetentionDuration in interface TopicOrBuilder
        Returns:
        The messageRetentionDuration.

      • setMessageRetentionDuration

        public Topic.Builder setMessageRetentionDuration​(com.google.protobuf.Duration value)
         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;

      • setMessageRetentionDuration

        public Topic.Builder setMessageRetentionDuration​(com.google.protobuf.Duration.Builder builderForValue)
         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;

      • mergeMessageRetentionDuration

        public Topic.Builder mergeMessageRetentionDuration​(com.google.protobuf.Duration value)
         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;

      • clearMessageRetentionDuration

        public Topic.Builder clearMessageRetentionDuration()
         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;

      • getMessageRetentionDurationBuilder

        public com.google.protobuf.Duration.Builder getMessageRetentionDurationBuilder()
         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;

      • getMessageRetentionDurationOrBuilder

        public 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;
        Specified by:
        getMessageRetentionDurationOrBuilder in interface TopicOrBuilder

      • setUnknownFields

        public final Topic.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Topic.Builder>

      • mergeUnknownFields

        public final Topic.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Topic.Builder>