Class MessageStoragePolicy (1.117.0)

public final class MessageStoragePolicy extends GeneratedMessageV3 implements MessageStoragePolicyOrBuilder

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

Protobuf type google.pubsub.v1.MessageStoragePolicy

Static Fields

ALLOWED_PERSISTENCE_REGIONS_FIELD_NUMBER

public static final int ALLOWED_PERSISTENCE_REGIONS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static MessageStoragePolicy getDefaultInstance()
Returns
TypeDescription
MessageStoragePolicy

getDescriptor()

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

newBuilder()

public static MessageStoragePolicy.Builder newBuilder()
Returns
TypeDescription
MessageStoragePolicy.Builder

newBuilder(MessageStoragePolicy prototype)

public static MessageStoragePolicy.Builder newBuilder(MessageStoragePolicy prototype)
Parameter
NameDescription
prototypeMessageStoragePolicy
Returns
TypeDescription
MessageStoragePolicy.Builder

parseDelimitedFrom(InputStream input)

public static MessageStoragePolicy parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
MessageStoragePolicy
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MessageStoragePolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MessageStoragePolicy
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static MessageStoragePolicy parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
MessageStoragePolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MessageStoragePolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MessageStoragePolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MessageStoragePolicy parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
MessageStoragePolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MessageStoragePolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MessageStoragePolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MessageStoragePolicy parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
MessageStoragePolicy
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MessageStoragePolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MessageStoragePolicy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static MessageStoragePolicy parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
MessageStoragePolicy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MessageStoragePolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MessageStoragePolicy
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static MessageStoragePolicy parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
MessageStoragePolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MessageStoragePolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MessageStoragePolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<MessageStoragePolicy> parser()
Returns
TypeDescription
Parser<MessageStoragePolicy>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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

getParserForType()

public Parser<MessageStoragePolicy> getParserForType()
Returns
TypeDescription
Parser<MessageStoragePolicy>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public MessageStoragePolicy.Builder newBuilderForType()
Returns
TypeDescription
MessageStoragePolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MessageStoragePolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
MessageStoragePolicy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public MessageStoragePolicy.Builder toBuilder()
Returns
TypeDescription
MessageStoragePolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException