Package com.google.firestore.v1

Class Pipeline.Stage

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.firestore.v1.Pipeline.Stage
All Implemented Interfaces:
Pipeline.StageOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Pipeline
public static final class Pipeline.Stage extends com.google.protobuf.GeneratedMessageV3 implements Pipeline.StageOrBuilder
 A single operation within a pipeline.

 A stage is made up of a unique name, and a list of arguments. The exact
 number of arguments & types is dependent on the stage type.

 To give an example, the stage `filter(state = "MD")` would be encoded as:

 ```
 name: "filter"
 args {
   function_value {
     name: "eq"
     args { field_reference_value: "state" }
     args { string_value: "MD" }
   }
 }
 ```

 See public documentation for the full list.
Protobuf type google.firestore.v1.Pipeline.Stage
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Pipeline.Stage.Builder
    A single operation within a pipeline.

    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
    ARGS_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    OPTIONS_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)
     
    Value
    getArgs(int index)
    Optional.
    int
    getArgsCount()
    Optional.
    List<Value>
    getArgsList()
    Optional.
    ValueOrBuilder
    getArgsOrBuilder(int index)
    Optional.
    List<? extends ValueOrBuilder>
    getArgsOrBuilderList()
    Optional.
    static Pipeline.Stage
    getDefaultInstance()
     
    Pipeline.Stage
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    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<Pipeline.Stage>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static Pipeline.Stage.Builder
    newBuilder()
     
    static Pipeline.Stage.Builder
    newBuilder(Pipeline.Stage prototype)
     
    Pipeline.Stage.Builder
    newBuilderForType()
     
    protected Pipeline.Stage.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Pipeline.Stage
    parseDelimitedFrom(InputStream input)
     
    static Pipeline.Stage
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Pipeline.Stage
    parseFrom(byte[] data)
     
    static Pipeline.Stage
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Pipeline.Stage
    parseFrom(com.google.protobuf.ByteString data)
     
    static Pipeline.Stage
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Pipeline.Stage
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Pipeline.Stage
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Pipeline.Stage
    parseFrom(InputStream input)
     
    static Pipeline.Stage
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Pipeline.Stage
    parseFrom(ByteBuffer data)
     
    static Pipeline.Stage
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Pipeline.Stage>
    parser()
     
    Pipeline.Stage.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

    • getName

      public String getName()
       Required. The name of the stage to evaluate.

 **Requires:**

 * must be in snake case (lower case with underscore separator).
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getName in interface Pipeline.StageOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Required. The name of the stage to evaluate.

 **Requires:**

 * must be in snake case (lower case with underscore separator).
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getNameBytes in interface Pipeline.StageOrBuilder
      Returns:
      The bytes for name.

    • getArgsList

      public List<Value> getArgsList()
       Optional. Ordered list of arguments the given stage expects.
      repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getArgsList in interface Pipeline.StageOrBuilder

    • getArgsOrBuilderList

      public List<? extends ValueOrBuilder> getArgsOrBuilderList()
       Optional. Ordered list of arguments the given stage expects.
      repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getArgsOrBuilderList in interface Pipeline.StageOrBuilder

    • getArgsCount

      public int getArgsCount()
       Optional. Ordered list of arguments the given stage expects.
      repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getArgsCount in interface Pipeline.StageOrBuilder

    • getArgs

      public Value getArgs(int index)
       Optional. Ordered list of arguments the given stage expects.
      repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getArgs in interface Pipeline.StageOrBuilder

    • getArgsOrBuilder

      public ValueOrBuilder getArgsOrBuilder(int index)
       Optional. Ordered list of arguments the given stage expects.
      repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getArgsOrBuilder in interface Pipeline.StageOrBuilder

    • getOptionsCount

      public int getOptionsCount()
      Description copied from interface: Pipeline.StageOrBuilder
       Optional. Optional named arguments that certain functions may support.
      map<string, .google.firestore.v1.Value> options = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOptionsCount in interface Pipeline.StageOrBuilder

    • containsOptions

      public boolean containsOptions(String key)
       Optional. Optional named arguments that certain functions may support.
      map<string, .google.firestore.v1.Value> options = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsOptions in interface Pipeline.StageOrBuilder

    • getOptions

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

    • getOptionsMap

      public Map<String,Value> getOptionsMap()
       Optional. Optional named arguments that certain functions may support.
      map<string, .google.firestore.v1.Value> options = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOptionsMap in interface Pipeline.StageOrBuilder

    • getOptionsOrDefault

      public Value getOptionsOrDefault(String key, Value defaultValue)
       Optional. Optional named arguments that certain functions may support.
      map<string, .google.firestore.v1.Value> options = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOptionsOrDefault in interface Pipeline.StageOrBuilder

    • getOptionsOrThrow

      public Value getOptionsOrThrow(String key)
       Optional. Optional named arguments that certain functions may support.
      map<string, .google.firestore.v1.Value> options = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOptionsOrThrow in interface Pipeline.StageOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Pipeline.Stage parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Pipeline.Stage parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Pipeline.Stage.Builder newBuilder()

    • newBuilder

      public static Pipeline.Stage.Builder newBuilder(Pipeline.Stage prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Pipeline.Stage getDefaultInstance()

    • parser

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

    • getParserForType

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