public final class ExportConfig extends GeneratedMessageV3 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 Fields
CURRENT_STATE_FIELD_NUMBER
public static final int CURRENT_STATE_FIELD_NUMBER
Field Value
DEAD_LETTER_TOPIC_FIELD_NUMBER
public static final int DEAD_LETTER_TOPIC_FIELD_NUMBER
Field Value
DESIRED_STATE_FIELD_NUMBER
public static final int DESIRED_STATE_FIELD_NUMBER
Field Value
PUBSUB_CONFIG_FIELD_NUMBER
public static final int PUBSUB_CONFIG_FIELD_NUMBER
Field Value
STATUSES_FIELD_NUMBER
public static final int STATUSES_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ExportConfig getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ExportConfig.Builder newBuilder()
Returns
newBuilder(ExportConfig prototype)
public static ExportConfig.Builder newBuilder(ExportConfig prototype)
Parameter
Returns
public static ExportConfig parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ExportConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ExportConfig parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ExportConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ExportConfig parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExportConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ExportConfig parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ExportConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ExportConfig parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ExportConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ExportConfig parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ExportConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ExportConfig> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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
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
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
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
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
getParserForType()
public Parser<ExportConfig> getParserForType()
Returns
Overrides
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
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
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getStatuses(int index)
public ExportConfig.PartitionStatus getStatuses(int index)
Output only. Deprecated: replaced by current_state
.
The export statuses of each partition.
repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];
Parameter
Returns
getStatusesCount()
public int getStatusesCount()
Output only. Deprecated: replaced by current_state
.
The export statuses of each partition.
repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getStatusesList()
public List<ExportConfig.PartitionStatus> getStatusesList()
Output only. Deprecated: replaced by current_state
.
The export statuses of each partition.
repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getStatusesOrBuilder(int index)
public ExportConfig.PartitionStatusOrBuilder getStatusesOrBuilder(int index)
Output only. Deprecated: replaced by current_state
.
The export statuses of each partition.
repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];
Parameter
Returns
getStatusesOrBuilderList()
public List<? extends ExportConfig.PartitionStatusOrBuilder> getStatusesOrBuilderList()
Output only. Deprecated: replaced by current_state
.
The export statuses of each partition.
repeated .google.cloud.pubsublite.v1.ExportConfig.PartitionStatus statuses = 4 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type | Description |
List<? extends com.google.cloud.pubsublite.proto.ExportConfig.PartitionStatusOrBuilder> | |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ExportConfig.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ExportConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ExportConfig.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions