com.google.pubsub.v1

Class Topic.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<Topic.Builder>

com.google.pubsub.v1.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 Summary

Modifier and Type	Method and Description
Topic.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Topic	build()
Topic	buildPartial()
Topic.Builder	clear()
Topic.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Topic.Builder	clearKmsKeyName() The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic.
Topic.Builder	clearLabels()
Topic.Builder	clearMessageStoragePolicy() Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored.
Topic.Builder	clearName() Required.
Topic.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Topic.Builder	clone()
boolean	containsLabels(String key) See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
Topic	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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).
MessageStoragePolicy	getMessageStoragePolicy() Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored.
MessageStoragePolicy.Builder	getMessageStoragePolicyBuilder() 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.
Map<String,String>	getMutableLabels() Deprecated.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
boolean	hasMessageStoragePolicy() Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
protected com.google.protobuf.MapField	internalGetMutableMapField(int number)
boolean	isInitialized()
Topic.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Topic.Builder	mergeFrom(com.google.protobuf.Message other)
Topic.Builder	mergeFrom(Topic other)
Topic.Builder	mergeMessageStoragePolicy(MessageStoragePolicy value) Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored.
Topic.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Topic.Builder	putAllLabels(Map<String,String> values) See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
Topic.Builder	putLabels(String key, String value) See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
Topic.Builder	removeLabels(String key) See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
Topic.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
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.
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.
Topic.Builder	setMessageStoragePolicy(MessageStoragePolicy.Builder builderForValue) Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored.
Topic.Builder	setMessageStoragePolicy(MessageStoragePolicy value) Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored.
Topic.Builder	setName(String value) Required.
Topic.Builder	setNameBytes(com.google.protobuf.ByteString value) Required.
Topic.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Topic.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

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>

mergeFrom

public Topic.Builder mergeFrom(Topic other)

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

getLabels

@Deprecated
public Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

Specified by:

getLabels 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

clearLabels

public Topic.Builder clearLabels()

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.

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>