Package com.google.firestore.v1

Class StructuredPipeline

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.firestore.v1.StructuredPipeline
All Implemented Interfaces:
StructuredPipelineOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class StructuredPipeline extends com.google.protobuf.GeneratedMessageV3 implements StructuredPipelineOrBuilder
 A Firestore query represented as an ordered list of operations / stages.

 This is considered the top-level function which plans and executes a query.
 It is logically equivalent to `query(stages, options)`, but prevents the
 client from having to build a function wrapper.
Protobuf type google.firestore.v1.StructuredPipeline
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    StructuredPipeline.Builder
    A Firestore query represented as an ordered list of operations / stages.

    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
    OPTIONS_FIELD_NUMBER
     
    static final int
    PIPELINE_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
    containsOptions(String key)
    Optional.
    boolean
    equals(Object obj)
     
    static StructuredPipeline
    getDefaultInstance()
     
    StructuredPipeline
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Map<String,Value>
    getOptions()
    Deprecated.
    int
    getOptionsCount()
    Optional.
    Map<String,Value>
    getOptionsMap()
    Optional.
    Value
    getOptionsOrDefault(String key, Value defaultValue)
    Optional.
    Value
    getOptionsOrThrow(String key)
    Optional.
    com.google.protobuf.Parser<StructuredPipeline>
    getParserForType()
     
    Pipeline
    getPipeline()
    Required.
    PipelineOrBuilder
    getPipelineOrBuilder()
    Required.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasPipeline()
    Required.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static StructuredPipeline.Builder
    newBuilder()
     
    static StructuredPipeline.Builder
    newBuilder(StructuredPipeline prototype)
     
    StructuredPipeline.Builder
    newBuilderForType()
     
    protected StructuredPipeline.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static StructuredPipeline
    parseDelimitedFrom(InputStream input)
     
    static StructuredPipeline
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StructuredPipeline
    parseFrom(byte[] data)
     
    static StructuredPipeline
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StructuredPipeline
    parseFrom(com.google.protobuf.ByteString data)
     
    static StructuredPipeline
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StructuredPipeline
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static StructuredPipeline
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StructuredPipeline
    parseFrom(InputStream input)
     
    static StructuredPipeline
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StructuredPipeline
    parseFrom(ByteBuffer data)
     
    static StructuredPipeline
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<StructuredPipeline>
    parser()
     
    StructuredPipeline.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, 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

  • 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()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

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

    • hasPipeline

      public boolean hasPipeline()
       Required. The pipeline query to execute.
      .google.firestore.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasPipeline in interface StructuredPipelineOrBuilder
      Returns:
      Whether the pipeline field is set.

    • getPipeline

      public Pipeline getPipeline()
       Required. The pipeline query to execute.
      .google.firestore.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPipeline in interface StructuredPipelineOrBuilder
      Returns:
      The pipeline.

    • getPipelineOrBuilder

      public PipelineOrBuilder getPipelineOrBuilder()
       Required. The pipeline query to execute.
      .google.firestore.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPipelineOrBuilder in interface StructuredPipelineOrBuilder

    • getOptionsCount

      public int getOptionsCount()
      Description copied from interface: StructuredPipelineOrBuilder
       Optional. Optional query-level arguments.
      map<string, .google.firestore.v1.Value> options = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOptionsCount in interface StructuredPipelineOrBuilder

    • containsOptions

      public boolean containsOptions(String key)
       Optional. Optional query-level arguments.
      map<string, .google.firestore.v1.Value> options = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsOptions in interface StructuredPipelineOrBuilder

    • getOptions

      @Deprecated public Map<String,Value> getOptions()
      Deprecated.
      Use getOptionsMap() instead.
      Specified by:
      getOptions in interface StructuredPipelineOrBuilder

    • getOptionsMap

      public Map<String,Value> getOptionsMap()
       Optional. Optional query-level arguments.
      map<string, .google.firestore.v1.Value> options = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOptionsMap in interface StructuredPipelineOrBuilder

    • getOptionsOrDefault

      public Value getOptionsOrDefault(String key, Value defaultValue)
       Optional. Optional query-level arguments.
      map<string, .google.firestore.v1.Value> options = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOptionsOrDefault in interface StructuredPipelineOrBuilder

    • getOptionsOrThrow

      public Value getOptionsOrThrow(String key)
       Optional. Optional query-level arguments.
      map<string, .google.firestore.v1.Value> options = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOptionsOrThrow in interface StructuredPipelineOrBuilder

    • 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 StructuredPipeline parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static StructuredPipeline parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static StructuredPipeline.Builder newBuilder()

    • newBuilder

      public static StructuredPipeline.Builder newBuilder(StructuredPipeline prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static StructuredPipeline getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<StructuredPipeline> 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 StructuredPipeline getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder