Class Topic.PartitionConfig (1.14.3)

public static final class Topic.PartitionConfig extends GeneratedMessageV3 implements Topic.PartitionConfigOrBuilder

The settings for a topic's partitions.

Protobuf type google.cloud.pubsublite.v1.Topic.PartitionConfig

Static Fields

CAPACITY_FIELD_NUMBER

public static final int CAPACITY_FIELD_NUMBER
Field Value
Type Description
int

COUNT_FIELD_NUMBER

public static final int COUNT_FIELD_NUMBER
Field Value
Type Description
int

SCALE_FIELD_NUMBER

public static final int SCALE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Topic.PartitionConfig getDefaultInstance()
Returns
Type Description
Topic.PartitionConfig

getDescriptor()

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

newBuilder()

public static Topic.PartitionConfig.Builder newBuilder()
Returns
Type Description
Topic.PartitionConfig.Builder

newBuilder(Topic.PartitionConfig prototype)

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

parseDelimitedFrom(InputStream input)

public static Topic.PartitionConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Topic.PartitionConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Topic.PartitionConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Topic.PartitionConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Topic.PartitionConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Topic.PartitionConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Topic.PartitionConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Topic.PartitionConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Topic.PartitionConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Topic.PartitionConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Topic.PartitionConfig> parser()
Returns
Type Description
Parser<PartitionConfig>

Methods

equals(Object obj)

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

getCapacity()

public Topic.PartitionConfig.Capacity getCapacity()

The capacity configuration.

.google.cloud.pubsublite.v1.Topic.PartitionConfig.Capacity capacity = 3;

Returns
Type Description
Topic.PartitionConfig.Capacity

The capacity.

getCapacityOrBuilder()

public Topic.PartitionConfig.CapacityOrBuilder getCapacityOrBuilder()

The capacity configuration.

.google.cloud.pubsublite.v1.Topic.PartitionConfig.Capacity capacity = 3;

Returns
Type Description
Topic.PartitionConfig.CapacityOrBuilder

getCount()

public long getCount()

The number of partitions in the topic. Must be at least 1.

Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity

int64 count = 1;

Returns
Type Description
long

The count.

getDefaultInstanceForType()

public Topic.PartitionConfig getDefaultInstanceForType()
Returns
Type Description
Topic.PartitionConfig

getDimensionCase()

public Topic.PartitionConfig.DimensionCase getDimensionCase()
Returns
Type Description
Topic.PartitionConfig.DimensionCase

getParserForType()

public Parser<Topic.PartitionConfig> getParserForType()
Returns
Type Description
Parser<PartitionConfig>
Overrides

getScale() (deprecated)

public int getScale()

Deprecated. google.cloud.pubsublite.v1.Topic.PartitionConfig.scale is deprecated. See google/cloud/pubsublite/v1/common.proto;l=138

DEPRECATED: Use capacity instead which can express a superset of configurations.

Every partition in the topic is allocated throughput equivalent to scale times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with scale of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].

int32 scale = 2 [deprecated = true];

Returns
Type Description
int

The scale.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasCapacity()

public boolean hasCapacity()

The capacity configuration.

.google.cloud.pubsublite.v1.Topic.PartitionConfig.Capacity capacity = 3;

Returns
Type Description
boolean

Whether the capacity field is set.

hasScale() (deprecated)

public boolean hasScale()

Deprecated. google.cloud.pubsublite.v1.Topic.PartitionConfig.scale is deprecated. See google/cloud/pubsublite/v1/common.proto;l=138

DEPRECATED: Use capacity instead which can express a superset of configurations.

Every partition in the topic is allocated throughput equivalent to scale times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with scale of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].

int32 scale = 2 [deprecated = true];

Returns
Type Description
boolean

Whether the scale field is set.

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 Topic.PartitionConfig.Builder newBuilderForType()
Returns
Type Description
Topic.PartitionConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Topic.PartitionConfig.Builder toBuilder()
Returns
Type Description
Topic.PartitionConfig.Builder

writeTo(CodedOutputStream output)

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