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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addAllAllowedPersistenceRegions(Iterable<String> values)
public MessageStoragePolicy.Builder addAllAllowedPersistenceRegions(Iterable<String> values)
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 |
values |
Iterable<String>
The allowedPersistenceRegions to add.
|
addAllowedPersistenceRegions(String value)
public MessageStoragePolicy.Builder addAllowedPersistenceRegions(String value)
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 |
value |
String
The allowedPersistenceRegions to add.
|
addAllowedPersistenceRegionsBytes(ByteString value)
public MessageStoragePolicy.Builder addAllowedPersistenceRegionsBytes(ByteString value)
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 |
value |
ByteString
The bytes of the allowedPersistenceRegions to add.
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public MessageStoragePolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public MessageStoragePolicy build()
buildPartial()
public MessageStoragePolicy buildPartial()
clear()
public MessageStoragePolicy.Builder clear()
Overrides
clearAllowedPersistenceRegions()
public MessageStoragePolicy.Builder clearAllowedPersistenceRegions()
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];
clearEnforceInTransit()
public MessageStoragePolicy.Builder clearEnforceInTransit()
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];
clearField(Descriptors.FieldDescriptor field)
public MessageStoragePolicy.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public MessageStoragePolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clone()
public MessageStoragePolicy.Builder clone()
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()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
public MessageStoragePolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public MessageStoragePolicy.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
mergeFrom(MessageStoragePolicy other)
public MessageStoragePolicy.Builder mergeFrom(MessageStoragePolicy other)
mergeUnknownFields(UnknownFieldSet unknownFields)
public final MessageStoragePolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setAllowedPersistenceRegions(int index, String value)
public MessageStoragePolicy.Builder setAllowedPersistenceRegions(int index, String value)
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];
| Parameters |
| Name |
Description |
index |
int
The index to set the value at.
|
value |
String
The allowedPersistenceRegions to set.
|
setEnforceInTransit(boolean value)
public MessageStoragePolicy.Builder setEnforceInTransit(boolean value)
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];
| Parameter |
| Name |
Description |
value |
boolean
The enforceInTransit to set.
|
setField(Descriptors.FieldDescriptor field, Object value)
public MessageStoragePolicy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public MessageStoragePolicy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final MessageStoragePolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
