Class MessageStoragePolicy.Builder (1.123.18)

public static final class MessageStoragePolicy.Builder extends GeneratedMessageV3.Builder<MessageStoragePolicy.Builder> implements MessageStoragePolicyOrBuilder

A policy constraining the storage of messages published to the topic.

Protobuf type google.pubsub.v1.MessageStoragePolicy

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllAllowedPersistenceRegions(Iterable<String> values)

public MessageStoragePolicy.Builder addAllAllowedPersistenceRegions(Iterable<String> values)

A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.

repeated string allowed_persistence_regions = 1;

Parameter
NameDescription
valuesIterable<String>

The allowedPersistenceRegions to add.

Returns
TypeDescription
MessageStoragePolicy.Builder

This builder for chaining.

addAllowedPersistenceRegions(String value)

public MessageStoragePolicy.Builder addAllowedPersistenceRegions(String value)

A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.

repeated string allowed_persistence_regions = 1;

Parameter
NameDescription
valueString

The allowedPersistenceRegions to add.

Returns
TypeDescription
MessageStoragePolicy.Builder

This builder for chaining.

addAllowedPersistenceRegionsBytes(ByteString value)

public MessageStoragePolicy.Builder addAllowedPersistenceRegionsBytes(ByteString value)

A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.

repeated string allowed_persistence_regions = 1;

Parameter
NameDescription
valueByteString

The bytes of the allowedPersistenceRegions to add.

Returns
TypeDescription
MessageStoragePolicy.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public MessageStoragePolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
MessageStoragePolicy.Builder
Overrides

build()

public MessageStoragePolicy build()
Returns
TypeDescription
MessageStoragePolicy

buildPartial()

public MessageStoragePolicy buildPartial()
Returns
TypeDescription
MessageStoragePolicy

clear()

public MessageStoragePolicy.Builder clear()
Returns
TypeDescription
MessageStoragePolicy.Builder
Overrides

clearAllowedPersistenceRegions()

public MessageStoragePolicy.Builder clearAllowedPersistenceRegions()

A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.

repeated string allowed_persistence_regions = 1;

Returns
TypeDescription
MessageStoragePolicy.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public MessageStoragePolicy.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
MessageStoragePolicy.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public MessageStoragePolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
MessageStoragePolicy.Builder
Overrides

clone()

public MessageStoragePolicy.Builder clone()
Returns
TypeDescription
MessageStoragePolicy.Builder
Overrides

getAllowedPersistenceRegions(int index)

public String getAllowedPersistenceRegions(int index)

A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.

repeated string allowed_persistence_regions = 1;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The allowedPersistenceRegions at the given index.

getAllowedPersistenceRegionsBytes(int index)

public ByteString getAllowedPersistenceRegionsBytes(int index)

A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.

repeated string allowed_persistence_regions = 1;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the allowedPersistenceRegions at the given index.

getAllowedPersistenceRegionsCount()

public int getAllowedPersistenceRegionsCount()

A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.

repeated string allowed_persistence_regions = 1;

Returns
TypeDescription
int

The count of allowedPersistenceRegions.

getAllowedPersistenceRegionsList()

public ProtocolStringList getAllowedPersistenceRegionsList()

A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.

repeated string allowed_persistence_regions = 1;

Returns
TypeDescription
ProtocolStringList

A list containing the allowedPersistenceRegions.

getDefaultInstanceForType()

public MessageStoragePolicy getDefaultInstanceForType()
Returns
TypeDescription
MessageStoragePolicy

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public MessageStoragePolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MessageStoragePolicy.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public MessageStoragePolicy.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
MessageStoragePolicy.Builder
Overrides

mergeFrom(MessageStoragePolicy other)

public MessageStoragePolicy.Builder mergeFrom(MessageStoragePolicy other)
Parameter
NameDescription
otherMessageStoragePolicy
Returns
TypeDescription
MessageStoragePolicy.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final MessageStoragePolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
MessageStoragePolicy.Builder
Overrides

setAllowedPersistenceRegions(int index, String value)

public MessageStoragePolicy.Builder setAllowedPersistenceRegions(int index, String value)

A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.

repeated string allowed_persistence_regions = 1;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The allowedPersistenceRegions to set.

Returns
TypeDescription
MessageStoragePolicy.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public MessageStoragePolicy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
MessageStoragePolicy.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public MessageStoragePolicy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
MessageStoragePolicy.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final MessageStoragePolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
MessageStoragePolicy.Builder
Overrides