public static final class ExportConfig.Builder extends GeneratedMessageV3.Builder<ExportConfig.Builder> implements ExportConfigOrBuilderConfiguration 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.BuilderImplements
ExportConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
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 |
|
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 |
|
clearCurrentState()
public ExportConfig.Builder clearCurrentState()Output only. The current state of the export, which may be different to the desired state due to errors. This field is output only.
.google.cloud.pubsublite.v1.ExportConfig.State current_state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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 |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public ExportConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ExportConfig.Builder |
|
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 |
|
clone()
public ExportConfig.Builder clone()| Returns | |
|---|---|
| Type | Description |
ExportConfig.Builder |
|
getCurrentState()
public ExportConfig.State getCurrentState()Output only. The current state of the export, which may be different to the desired state due to errors. This field is output only.
.google.cloud.pubsublite.v1.ExportConfig.State current_state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
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. This field is output only.
.google.cloud.pubsublite.v1.ExportConfig.State current_state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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 |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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 |
|
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 |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ExportConfig.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ExportConfig.Builder |
|
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 |
|
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. This field is output only.
.google.cloud.pubsublite.v1.ExportConfig.State current_state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
ExportConfig.StateThe currentState to set. |
| Returns | |
|---|---|
| Type | Description |
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. This field is output only.
.google.cloud.pubsublite.v1.ExportConfig.State current_state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for currentState to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
StringThe 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 |
ByteStringThe 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. Setting this to values other than
ACTIVE and PAUSED will result in an error.
.google.cloud.pubsublite.v1.ExportConfig.State desired_state = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ExportConfig.StateThe 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. Setting this to values other than
ACTIVE and PAUSED will result in an error.
.google.cloud.pubsublite.v1.ExportConfig.State desired_state = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe 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 |
|
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 |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ExportConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ExportConfig.Builder |
|