Package com.google.cloud.pubsublite.proto

Class ExportConfig

  • All Implemented Interfaces:
    ExportConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ExportConfig
extends com.google.protobuf.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
    See Also:
    Serialized Form

    • Field Detail

      • DESIRED_STATE_FIELD_NUMBER

        public static final int DESIRED_STATE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CURRENT_STATE_FIELD_NUMBER

        public static final int CURRENT_STATE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEAD_LETTER_TOPIC_FIELD_NUMBER

        public static final int DEAD_LETTER_TOPIC_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PUBSUB_CONFIG_FIELD_NUMBER

        public static final int PUBSUB_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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;
        Specified by:
        getDesiredStateValue in interface ExportConfigOrBuilder
        Returns:
        The enum numeric value on the wire for desiredState.

      • 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;
        Specified by:
        getDesiredState in interface ExportConfigOrBuilder
        Returns:
        The desiredState.

      • 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];
        Specified by:
        getCurrentStateValue in interface ExportConfigOrBuilder
        Returns:
        The enum numeric value on the wire for currentState.

      • 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];
        Specified by:
        getCurrentState in interface ExportConfigOrBuilder
        Returns:
        The 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) = { ... }
        Specified by:
        getDeadLetterTopic in interface ExportConfigOrBuilder
        Returns:
        The deadLetterTopic.

      • getDeadLetterTopicBytes

        public 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) = { ... }
        Specified by:
        getDeadLetterTopicBytes in interface ExportConfigOrBuilder
        Returns:
        The bytes for deadLetterTopic.

      • 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;
        Specified by:
        hasPubsubConfig in interface ExportConfigOrBuilder
        Returns:
        Whether the pubsubConfig field is set.

      • 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;
        Specified by:
        getPubsubConfig in interface ExportConfigOrBuilder
        Returns:
        The pubsubConfig.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ExportConfig parseFrom​(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExportConfig parseFrom​(ByteBuffer data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExportConfig parseFrom​(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExportConfig parseFrom​(com.google.protobuf.ByteString data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExportConfig parseFrom​(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExportConfig parseFrom​(byte[] data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExportConfig parseFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Throws:
        IOException

      • newBuilderForType

        public ExportConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ExportConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ExportConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static ExportConfig getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<ExportConfig> parser()

      • getParserForType

        public com.google.protobuf.Parser<ExportConfig> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ExportConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder