Class MessageStoragePolicy (1.133.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
Type Description
int

ENFORCE_IN_TRANSIT_FIELD_NUMBER

public static final int ENFORCE_IN_TRANSIT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MessageStoragePolicy getDefaultInstance()
Returns
Type Description
MessageStoragePolicy

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static MessageStoragePolicy.Builder newBuilder()
Returns
Type Description
MessageStoragePolicy.Builder

newBuilder(MessageStoragePolicy prototype)

public static MessageStoragePolicy.Builder newBuilder(MessageStoragePolicy prototype)
Parameter
Name Description
prototype MessageStoragePolicy
Returns
Type Description
MessageStoragePolicy.Builder

parseDelimitedFrom(InputStream input)

public static MessageStoragePolicy parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MessageStoragePolicy
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MessageStoragePolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MessageStoragePolicy
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static MessageStoragePolicy parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
MessageStoragePolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MessageStoragePolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MessageStoragePolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MessageStoragePolicy parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
MessageStoragePolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MessageStoragePolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MessageStoragePolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MessageStoragePolicy parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
MessageStoragePolicy
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MessageStoragePolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MessageStoragePolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static MessageStoragePolicy parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MessageStoragePolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MessageStoragePolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MessageStoragePolicy
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static MessageStoragePolicy parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
MessageStoragePolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MessageStoragePolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MessageStoragePolicy
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<MessageStoragePolicy> parser()
Returns
Type Description
Parser<MessageStoragePolicy>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAllowedPersistenceRegions(int index)

public String getAllowedPersistenceRegions(int index)

Optional. A list of IDs of Google Cloud regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed Google Cloud regions (or running outside of Google Cloud altogether) are 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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The allowedPersistenceRegions at the given index.

getAllowedPersistenceRegionsBytes(int index)

public ByteString getAllowedPersistenceRegionsBytes(int index)

Optional. A list of IDs of Google Cloud regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed Google Cloud regions (or running outside of Google Cloud altogether) are 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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the allowedPersistenceRegions at the given index.

getAllowedPersistenceRegionsCount()

public int getAllowedPersistenceRegionsCount()

Optional. A list of IDs of Google Cloud regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed Google Cloud regions (or running outside of Google Cloud altogether) are 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of allowedPersistenceRegions.

getAllowedPersistenceRegionsList()

public ProtocolStringList getAllowedPersistenceRegionsList()

Optional. A list of IDs of Google Cloud regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed Google Cloud regions (or running outside of Google Cloud altogether) are 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the allowedPersistenceRegions.

getDefaultInstanceForType()

public MessageStoragePolicy getDefaultInstanceForType()
Returns
Type Description
MessageStoragePolicy

getEnforceInTransit()

public boolean getEnforceInTransit()

Optional. If true, allowed_persistence_regions is also used to enforce in-transit guarantees for messages. That is, Pub/Sub will fail Publish operations on this topic and subscribe operations on any subscription attached to this topic in any region that is not in allowed_persistence_regions.

bool enforce_in_transit = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enforceInTransit.

getParserForType()

public Parser<MessageStoragePolicy> getParserForType()
Returns
Type Description
Parser<MessageStoragePolicy>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public MessageStoragePolicy.Builder newBuilderForType()
Returns
Type Description
MessageStoragePolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MessageStoragePolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MessageStoragePolicy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public MessageStoragePolicy.Builder toBuilder()
Returns
Type Description
MessageStoragePolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException