Class ExportConfig.Builder (1.9.4)

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExportConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExportConfig.Builder
Overrides

build()

public ExportConfig build()
Returns
TypeDescription
ExportConfig

buildPartial()

public ExportConfig buildPartial()
Returns
TypeDescription
ExportConfig

clear()

public ExportConfig.Builder clear()
Returns
TypeDescription
ExportConfig.Builder
Overrides

clearCurrentState()

public ExportConfig.Builder clearCurrentState()

Output only. The current state of the export, which may be different to the desired state due to errors.

.google.cloud.pubsublite.v1.ExportConfig.State current_state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ExportConfig.Builder

This builder for chaining.

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
TypeDescription
ExportConfig.Builder

This builder for chaining.

clearDesiredState()

public ExportConfig.Builder clearDesiredState()

The desired state of this export. Setting this to values other than ACTIVE and PAUSED will result in an error.

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

Returns
TypeDescription
ExportConfig.Builder

This builder for chaining.

clearDestination()

public ExportConfig.Builder clearDestination()
Returns
TypeDescription
ExportConfig.Builder

clearField(Descriptors.FieldDescriptor field)

public ExportConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ExportConfig.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ExportConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
ExportConfig.Builder

clone()

public ExportConfig.Builder clone()
Returns
TypeDescription
ExportConfig.Builder
Overrides

getCurrentState()

public ExportConfig.State getCurrentState()

Output only. The current state of the export, which may be different to the desired state due to errors.

.google.cloud.pubsublite.v1.ExportConfig.State current_state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ExportConfig.State

The currentState.

getCurrentStateValue()

public int getCurrentStateValue()

Output only. The current state of the export, which may be different to the desired state due to errors.

.google.cloud.pubsublite.v1.ExportConfig.State current_state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for currentState.

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
TypeDescription
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
TypeDescription
ByteString

The bytes for deadLetterTopic.

getDefaultInstanceForType()

public ExportConfig getDefaultInstanceForType()
Returns
TypeDescription
ExportConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDesiredState()

public ExportConfig.State getDesiredState()

The desired state of this export. Setting this to values other than ACTIVE and PAUSED will result in an error.

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

Returns
TypeDescription
ExportConfig.State

The desiredState.

getDesiredStateValue()

public int getDesiredStateValue()

The desired state of this export. Setting this to values other than ACTIVE and PAUSED will result in an error.

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

Returns
TypeDescription
int

The enum numeric value on the wire for desiredState.

getDestinationCase()

public ExportConfig.DestinationCase getDestinationCase()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ExportConfig.PubSubConfigOrBuilder

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
TypeDescription
boolean

Whether the pubsubConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ExportConfig other)

public ExportConfig.Builder mergeFrom(ExportConfig other)
Parameter
NameDescription
otherExportConfig
Returns
TypeDescription
ExportConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExportConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExportConfig.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ExportConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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
NameDescription
valueExportConfig.PubSubConfig
Returns
TypeDescription
ExportConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExportConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ExportConfig.Builder
Overrides

setCurrentState(ExportConfig.State value)

public ExportConfig.Builder setCurrentState(ExportConfig.State value)

Output only. The current state of the export, which may be different to the desired state due to errors.

.google.cloud.pubsublite.v1.ExportConfig.State current_state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueExportConfig.State

The currentState to set.

Returns
TypeDescription
ExportConfig.Builder

This builder for chaining.

setCurrentStateValue(int value)

public ExportConfig.Builder setCurrentStateValue(int value)

Output only. The current state of the export, which may be different to the desired state due to errors.

.google.cloud.pubsublite.v1.ExportConfig.State current_state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueint

The enum numeric value on the wire for currentState to set.

Returns
TypeDescription
ExportConfig.Builder

This builder for chaining.

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
NameDescription
valueString

The deadLetterTopic to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for deadLetterTopic to set.

Returns
TypeDescription
ExportConfig.Builder

This builder for chaining.

setDesiredState(ExportConfig.State value)

public ExportConfig.Builder setDesiredState(ExportConfig.State value)

The desired state of this export. Setting this to values other than ACTIVE and PAUSED will result in an error.

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

Parameter
NameDescription
valueExportConfig.State

The desiredState to set.

Returns
TypeDescription
ExportConfig.Builder

This builder for chaining.

setDesiredStateValue(int value)

public ExportConfig.Builder setDesiredStateValue(int value)

The desired state of this export. Setting this to values other than ACTIVE and PAUSED will result in an error.

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for desiredState to set.

Returns
TypeDescription
ExportConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ExportConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueExportConfig.PubSubConfig
Returns
TypeDescription
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
NameDescription
builderForValueExportConfig.PubSubConfig.Builder
Returns
TypeDescription
ExportConfig.Builder

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

public ExportConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ExportConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ExportConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ExportConfig.Builder
Overrides