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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ExportConfigImplements
ExportConfigOrBuilderStatic Fields
CURRENT_STATE_FIELD_NUMBER
public static final int CURRENT_STATE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DEAD_LETTER_TOPIC_FIELD_NUMBER
public static final int DEAD_LETTER_TOPIC_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DESIRED_STATE_FIELD_NUMBER
public static final int DESIRED_STATE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
PUBSUB_CONFIG_FIELD_NUMBER
public static final int PUBSUB_CONFIG_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static ExportConfig getDefaultInstance()
Returns | |
---|---|
Type | Description |
ExportConfig |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static ExportConfig.Builder newBuilder()
Returns | |
---|---|
Type | Description |
ExportConfig.Builder |
newBuilder(ExportConfig prototype)
public static ExportConfig.Builder newBuilder(ExportConfig prototype)
Parameter | |
---|---|
Name | Description |
prototype | ExportConfig |
Returns | |
---|---|
Type | Description |
ExportConfig.Builder |
parseDelimitedFrom(InputStream input)
public static ExportConfig parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
ExportConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ExportConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ExportConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static ExportConfig parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data | byte[] |
Returns | |
---|---|
Type | Description |
ExportConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ExportConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ExportConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static ExportConfig parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data | ByteString |
Returns | |
---|---|
Type | Description |
ExportConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExportConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ExportConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static ExportConfig parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input | CodedInputStream |
Returns | |
---|---|
Type | Description |
ExportConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ExportConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ExportConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static ExportConfig parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
ExportConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ExportConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ExportConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static ExportConfig parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data | ByteBuffer |
Returns | |
---|---|
Type | Description |
ExportConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ExportConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ExportConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<ExportConfig> parser()
Returns | |
---|---|
Type | Description |
Parser<ExportConfig> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj | Object |
Returns | |
---|---|
Type | Description |
boolean |
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 |
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 |
getParserForType()
public Parser<ExportConfig> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<ExportConfig> |
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. |
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 |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns | |
---|---|
Type | Description |
UnknownFieldSet |
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()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public ExportConfig.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
ExportConfig.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ExportConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent | BuilderParent |
Returns | |
---|---|
Type | Description |
ExportConfig.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused | UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public ExportConfig.Builder toBuilder()
Returns | |
---|---|
Type | Description |
ExportConfig.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output | CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |