com.google.cloud.pubsublite.proto

Interface ExportConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ExportConfig, ExportConfig.Builder

public interface ExportConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
ExportConfig.State	getCurrentState() Output only.
int	getCurrentStateValue() Output only.
String	getDeadLetterTopic() Optional.
com.google.protobuf.ByteString	getDeadLetterTopicBytes() Optional.
ExportConfig.State	getDesiredState() The desired state of this export.
int	getDesiredStateValue() The desired state of this export.
ExportConfig.DestinationCase	getDestinationCase()
ExportConfig.PubSubConfig	getPubsubConfig() Messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a Pub/Sub topic.
ExportConfig.PubSubConfigOrBuilder	getPubsubConfigOrBuilder() Messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a Pub/Sub topic.
boolean	hasPubsubConfig() Messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a Pub/Sub topic.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getDesiredStateValue

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:

The enum numeric value on the wire for desiredState.

getDesiredState

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:

The desiredState.

getCurrentStateValue

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:

The enum numeric value on the wire for currentState.

getCurrentState

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:

The currentState.

getDeadLetterTopic

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:

The deadLetterTopic.

getDeadLetterTopicBytes

com.google.protobuf.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:

The bytes for deadLetterTopic.

hasPubsubConfig

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:

Whether the pubsubConfig field is set.

getPubsubConfig

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:

The pubsubConfig.

getPubsubConfigOrBuilder

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;

getDestinationCase

ExportConfig.DestinationCase getDestinationCase()