Package com.google.cloud.pubsublite.proto

Class ExportConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.cloud.pubsublite.proto.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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ExportConfig.Builder
    Configuration for a Pub/Sub Lite subscription that writes messages to a destination.
    static enum 
    ExportConfig.DestinationCase
     
    static final class 
    ExportConfig.PubSubConfig
    Configuration for exporting to a Pub/Sub topic.
    static interface 
    ExportConfig.PubSubConfigOrBuilder
     
    static enum 
    ExportConfig.State
    The desired export state.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CURRENT_STATE_FIELD_NUMBER
     
    static final int
    DEAD_LETTER_TOPIC_FIELD_NUMBER
     
    static final int
    DESIRED_STATE_FIELD_NUMBER
     
    static final int
    PUBSUB_CONFIG_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    ExportConfig.State
    getCurrentState()
    Output only.
    int
    getCurrentStateValue()
    Output only.
    String
    getDeadLetterTopic()
    Optional.
    com.google.protobuf.ByteString
    getDeadLetterTopicBytes()
    Optional.
    static ExportConfig
    getDefaultInstance()
     
    ExportConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    ExportConfig.State
    getDesiredState()
    The desired state of this export.
    int
    getDesiredStateValue()
    The desired state of this export.
    ExportConfig.DestinationCase
    getDestinationCase()
     
    com.google.protobuf.Parser<ExportConfig>
    getParserForType()
     
    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.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasPubsubConfig()
    Messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a Pub/Sub topic.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ExportConfig.Builder
    newBuilder()
     
    static ExportConfig.Builder
    newBuilder(ExportConfig prototype)
     
    ExportConfig.Builder
    newBuilderForType()
     
    protected ExportConfig.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static ExportConfig
    parseDelimitedFrom(InputStream input)
     
    static ExportConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExportConfig
    parseFrom(byte[] data)
     
    static ExportConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExportConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static ExportConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExportConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ExportConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExportConfig
    parseFrom(InputStream input)
     
    static ExportConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExportConfig
    parseFrom(ByteBuffer data)
     
    static ExportConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ExportConfig>
    parser()
     
    ExportConfig.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • DESIRED_STATE_FIELD_NUMBER

      public static final int DESIRED_STATE_FIELD_NUMBER
      See Also:

    • CURRENT_STATE_FIELD_NUMBER

      public static final int CURRENT_STATE_FIELD_NUMBER
      See Also:

    • DEAD_LETTER_TOPIC_FIELD_NUMBER

      public static final int DEAD_LETTER_TOPIC_FIELD_NUMBER
      See Also:

    • PUBSUB_CONFIG_FIELD_NUMBER

      public static final int PUBSUB_CONFIG_FIELD_NUMBER
      See Also:

  • Method Details

    • 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

    • getDestinationCase

      public ExportConfig.DestinationCase getDestinationCase()
      Specified by:
      getDestinationCase in interface ExportConfigOrBuilder

    • 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.

    • 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;
      Specified by:
      getPubsubConfigOrBuilder in interface ExportConfigOrBuilder

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static ExportConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ExportConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • 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

    • newBuilder

      public static ExportConfig.Builder newBuilder()

    • newBuilder

      public static ExportConfig.Builder newBuilder(ExportConfig prototype)

    • 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