Interface ExportConfigOrBuilder (1.9.0)

public interface ExportConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCurrentState()

public abstract 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 abstract 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 abstract 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 abstract 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.

getDesiredState()

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

getPubsubConfig()

public abstract 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.

getPubsubConfigOrBuilder()

public abstract 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

getStatuses(int index)

public abstract 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
NameDescription
indexint
Returns
TypeDescription
ExportConfig.PartitionStatus

getStatusesCount()

public abstract 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
TypeDescription
int

getStatusesList()

public abstract 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
TypeDescription
List<PartitionStatus>

getStatusesOrBuilder(int index)

public abstract 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
NameDescription
indexint
Returns
TypeDescription
ExportConfig.PartitionStatusOrBuilder

getStatusesOrBuilderList()

public abstract 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
TypeDescription
List<? extends com.google.cloud.pubsublite.proto.ExportConfig.PartitionStatusOrBuilder>

hasPubsubConfig()

public abstract 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.