Class ExportConfig.Builder (1.7.1) 

public static final class ExportConfig.Builder extends GeneratedMessageV3.Builder<ExportConfig.Builder> implements ExportConfigOrBuilder

Configuration for a Pub/Sub Lite subscription that writes messages to a destination. User subscriber clients must not connect to this subscription.

Protobuf type google.cloud.pubsublite.v1.ExportConfig

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExportConfig.Builder

Static Methods

getDescriptor()

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

Methods

addAllStatuses(Iterable<? extends ExportConfig.PartitionStatus> values)

public ExportConfig.Builder addAllStatuses(Iterable<? extends ExportConfig.PartitionStatus> values)

Output only. The export statuses of each partition. This field is output only.

repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.cloud.pubsublite.proto.ExportConfig.PartitionStatus>
Returns
Type Description
ExportConfig.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExportConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExportConfig.Builder
Overrides

addStatuses(ExportConfig.PartitionStatus value)

public ExportConfig.Builder addStatuses(ExportConfig.PartitionStatus value)

Output only. The export statuses of each partition. This field is output only.

repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ExportConfig.PartitionStatus
Returns
Type Description
ExportConfig.Builder

addStatuses(ExportConfig.PartitionStatus.Builder builderForValue)

public ExportConfig.Builder addStatuses(ExportConfig.PartitionStatus.Builder builderForValue)

Output only. The export statuses of each partition. This field is output only.

repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue ExportConfig.PartitionStatus.Builder
Returns
Type Description
ExportConfig.Builder

addStatuses(int index, ExportConfig.PartitionStatus value)

public ExportConfig.Builder addStatuses(int index, ExportConfig.PartitionStatus value)

Output only. The export statuses of each partition. This field is output only.

repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value ExportConfig.PartitionStatus
Returns
Type Description
ExportConfig.Builder

addStatuses(int index, ExportConfig.PartitionStatus.Builder builderForValue)

public ExportConfig.Builder addStatuses(int index, ExportConfig.PartitionStatus.Builder builderForValue)

Output only. The export statuses of each partition. This field is output only.

repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue ExportConfig.PartitionStatus.Builder
Returns
Type Description
ExportConfig.Builder

addStatusesBuilder()

public ExportConfig.PartitionStatus.Builder addStatusesBuilder()

Output only. The export statuses of each partition. This field is output only.

repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ExportConfig.PartitionStatus.Builder

addStatusesBuilder(int index)

public ExportConfig.PartitionStatus.Builder addStatusesBuilder(int index)

Output only. The export statuses of each partition. This field is output only.

repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ExportConfig.PartitionStatus.Builder

build()

public ExportConfig build()
Returns
Type Description
ExportConfig

buildPartial()

public ExportConfig buildPartial()
Returns
Type Description
ExportConfig

clear()

public ExportConfig.Builder clear()
Returns
Type Description
ExportConfig.Builder
Overrides

clearDeadLetterTopic()

public ExportConfig.Builder clearDeadLetterTopic()

Optional. The name of an optional Pub/Sub Lite topic to publish messages that can not be exported to the destination. For example, the message can not be published to the Pub/Sub service because it does not satisfy the constraints documented at https://cloud.google.com/pubsub/docs/publisher. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}. Must be within the same project and location as the subscription. The topic may be changed or removed.

string dead_letter_topic = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ExportConfig.Builder

This builder for chaining.

clearDesiredState()

public ExportConfig.Builder clearDesiredState()

The desired state of this export.

.google.cloud.pubsublite.v1.ExportConfig.State desired_state = 1;

Returns
Type Description
ExportConfig.Builder

This builder for chaining.

clearDestination()

public ExportConfig.Builder clearDestination()
Returns
Type Description
ExportConfig.Builder

clearField(Descriptors.FieldDescriptor field)

public ExportConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ExportConfig.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ExportConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ExportConfig.Builder
Overrides

clearPubsubConfig()

public ExportConfig.Builder clearPubsubConfig()

Messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a Pub/Sub topic.

.google.cloud.pubsublite.v1.ExportConfig.PubSubConfig pubsub_config = 3;

Returns
Type Description
ExportConfig.Builder

clearStatuses()

public ExportConfig.Builder clearStatuses()

Output only. The export statuses of each partition. This field is output only.

repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ExportConfig.Builder

clone()

public ExportConfig.Builder clone()
Returns
Type Description
ExportConfig.Builder
Overrides

getDeadLetterTopic()

public String getDeadLetterTopic()

Optional. The name of an optional Pub/Sub Lite topic to publish messages that can not be exported to the destination. For example, the message can not be published to the Pub/Sub service because it does not satisfy the constraints documented at https://cloud.google.com/pubsub/docs/publisher. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}. Must be within the same project and location as the subscription. The topic may be changed or removed.

string dead_letter_topic = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The deadLetterTopic.

getDeadLetterTopicBytes()

public ByteString getDeadLetterTopicBytes()

Optional. The name of an optional Pub/Sub Lite topic to publish messages that can not be exported to the destination. For example, the message can not be published to the Pub/Sub service because it does not satisfy the constraints documented at https://cloud.google.com/pubsub/docs/publisher. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}. Must be within the same project and location as the subscription. The topic may be changed or removed.

string dead_letter_topic = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for deadLetterTopic.

getDefaultInstanceForType()

public ExportConfig getDefaultInstanceForType()
Returns
Type Description
ExportConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDesiredState()

public ExportConfig.State getDesiredState()

The desired state of this export.

.google.cloud.pubsublite.v1.ExportConfig.State desired_state = 1;

Returns
Type Description
ExportConfig.State

The desiredState.

getDesiredStateValue()

public int getDesiredStateValue()

The desired state of this export.

.google.cloud.pubsublite.v1.ExportConfig.State desired_state = 1;

Returns
Type Description
int

The enum numeric value on the wire for desiredState.

getDestinationCase()

public ExportConfig.DestinationCase getDestinationCase()
Returns
Type Description
ExportConfig.DestinationCase

getPubsubConfig()

public ExportConfig.PubSubConfig getPubsubConfig()

Messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a Pub/Sub topic.

.google.cloud.pubsublite.v1.ExportConfig.PubSubConfig pubsub_config = 3;

Returns
Type Description
ExportConfig.PubSubConfig

The pubsubConfig.

getPubsubConfigBuilder()

public ExportConfig.PubSubConfig.Builder getPubsubConfigBuilder()

Messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a Pub/Sub topic.

.google.cloud.pubsublite.v1.ExportConfig.PubSubConfig pubsub_config = 3;

Returns
Type Description
ExportConfig.PubSubConfig.Builder

getPubsubConfigOrBuilder()

public ExportConfig.PubSubConfigOrBuilder getPubsubConfigOrBuilder()

Messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a Pub/Sub topic.

.google.cloud.pubsublite.v1.ExportConfig.PubSubConfig pubsub_config = 3;

Returns
Type Description
ExportConfig.PubSubConfigOrBuilder

getStatuses(int index)

public ExportConfig.PartitionStatus getStatuses(int index)

Output only. The export statuses of each partition. This field is output only.

repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ExportConfig.PartitionStatus

getStatusesBuilder(int index)

public ExportConfig.PartitionStatus.Builder getStatusesBuilder(int index)

Output only. The export statuses of each partition. This field is output only.

repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ExportConfig.PartitionStatus.Builder

getStatusesBuilderList()

public List<ExportConfig.PartitionStatus.Builder> getStatusesBuilderList()

Output only. The export statuses of each partition. This field is output only.

repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Builder>

getStatusesCount()

public int getStatusesCount()

Output only. The export statuses of each partition. This field is output only.

repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getStatusesList()

public List<ExportConfig.PartitionStatus> getStatusesList()

Output only. The export statuses of each partition. This field is output only.

repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<PartitionStatus>

getStatusesOrBuilder(int index)

public ExportConfig.PartitionStatusOrBuilder getStatusesOrBuilder(int index)

Output only. The export statuses of each partition. This field is output only.

repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ExportConfig.PartitionStatusOrBuilder

getStatusesOrBuilderList()

public List<? extends ExportConfig.PartitionStatusOrBuilder> getStatusesOrBuilderList()

Output only. The export statuses of each partition. This field is output only.

repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.pubsublite.proto.ExportConfig.PartitionStatusOrBuilder>

hasPubsubConfig()

public boolean hasPubsubConfig()

Messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a Pub/Sub topic.

.google.cloud.pubsublite.v1.ExportConfig.PubSubConfig pubsub_config = 3;

Returns
Type Description
boolean

Whether the pubsubConfig field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ExportConfig other)

public ExportConfig.Builder mergeFrom(ExportConfig other)
Parameter
Name Description
other ExportConfig
Returns
Type Description
ExportConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExportConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportConfig.Builder
Overrides Exceptions
Type Description
IOException

mergeFrom(Message other)

public ExportConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ExportConfig.Builder
Overrides

mergePubsubConfig(ExportConfig.PubSubConfig value)

public ExportConfig.Builder mergePubsubConfig(ExportConfig.PubSubConfig value)

Messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a Pub/Sub topic.

.google.cloud.pubsublite.v1.ExportConfig.PubSubConfig pubsub_config = 3;

Parameter
Name Description
value ExportConfig.PubSubConfig
Returns
Type Description
ExportConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExportConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExportConfig.Builder
Overrides

removeStatuses(int index)

public ExportConfig.Builder removeStatuses(int index)

Output only. The export statuses of each partition. This field is output only.

repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ExportConfig.Builder

setDeadLetterTopic(String value)

public ExportConfig.Builder setDeadLetterTopic(String value)

Optional. The name of an optional Pub/Sub Lite topic to publish messages that can not be exported to the destination. For example, the message can not be published to the Pub/Sub service because it does not satisfy the constraints documented at https://cloud.google.com/pubsub/docs/publisher. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}. Must be within the same project and location as the subscription. The topic may be changed or removed.

string dead_letter_topic = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The deadLetterTopic to set.
Returns
Type Description
ExportConfig.Builder

This builder for chaining.

setDeadLetterTopicBytes(ByteString value)

public ExportConfig.Builder setDeadLetterTopicBytes(ByteString value)

Optional. The name of an optional Pub/Sub Lite topic to publish messages that can not be exported to the destination. For example, the message can not be published to the Pub/Sub service because it does not satisfy the constraints documented at https://cloud.google.com/pubsub/docs/publisher. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}. Must be within the same project and location as the subscription. The topic may be changed or removed.

string dead_letter_topic = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for deadLetterTopic to set.
Returns
Type Description
ExportConfig.Builder

This builder for chaining.

setDesiredState(ExportConfig.State value)

public ExportConfig.Builder setDesiredState(ExportConfig.State value)

The desired state of this export.

.google.cloud.pubsublite.v1.ExportConfig.State desired_state = 1;

Parameter
Name Description
value ExportConfig.State

The desiredState to set.
Returns
Type Description
ExportConfig.Builder

This builder for chaining.

setDesiredStateValue(int value)

public ExportConfig.Builder setDesiredStateValue(int value)

The desired state of this export.

.google.cloud.pubsublite.v1.ExportConfig.State desired_state = 1;

Parameter
Name Description
value int

The enum numeric value on the wire for desiredState to set.
Returns
Type Description
ExportConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ExportConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExportConfig.Builder
Overrides

setPubsubConfig(ExportConfig.PubSubConfig value)

public ExportConfig.Builder setPubsubConfig(ExportConfig.PubSubConfig value)

Messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a Pub/Sub topic.

.google.cloud.pubsublite.v1.ExportConfig.PubSubConfig pubsub_config = 3;

Parameter
Name Description
value ExportConfig.PubSubConfig
Returns
Type Description
ExportConfig.Builder

setPubsubConfig(ExportConfig.PubSubConfig.Builder builderForValue)

public ExportConfig.Builder setPubsubConfig(ExportConfig.PubSubConfig.Builder builderForValue)

Messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a Pub/Sub topic.

.google.cloud.pubsublite.v1.ExportConfig.PubSubConfig pubsub_config = 3;

Parameter
Name Description
builderForValue ExportConfig.PubSubConfig.Builder
Returns
Type Description
ExportConfig.Builder

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

public ExportConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ExportConfig.Builder
Overrides

setStatuses(int index, ExportConfig.PartitionStatus value)

public ExportConfig.Builder setStatuses(int index, ExportConfig.PartitionStatus value)

Output only. The export statuses of each partition. This field is output only.

repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value ExportConfig.PartitionStatus
Returns
Type Description
ExportConfig.Builder

setStatuses(int index, ExportConfig.PartitionStatus.Builder builderForValue)

public ExportConfig.Builder setStatuses(int index, ExportConfig.PartitionStatus.Builder builderForValue)

Output only. The export statuses of each partition. This field is output only.

repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue ExportConfig.PartitionStatus.Builder
Returns
Type Description
ExportConfig.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ExportConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExportConfig.Builder
Overrides