Package com.google.firestore.v1

Class Pipeline.Stage.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Pipeline.Stage.Builder>
com.google.firestore.v1.Pipeline.Stage.Builder
All Implemented Interfaces:
Pipeline.StageOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Pipeline.Stage
public static final class Pipeline.Stage.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Pipeline.Stage.Builder> 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

  • Method Details

    • 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.Builder<Pipeline.Stage.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<Pipeline.Stage.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Pipeline.Stage.Builder>

    • clear

      public Pipeline.Stage.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<Pipeline.Stage.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Pipeline.Stage.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public Pipeline.Stage.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<Pipeline.Stage.Builder>

    • setField

      public Pipeline.Stage.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<Pipeline.Stage.Builder>

    • clearField

      public Pipeline.Stage.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Pipeline.Stage.Builder>

    • clearOneof

      public Pipeline.Stage.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Pipeline.Stage.Builder>

    • setRepeatedField

      public Pipeline.Stage.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Pipeline.Stage.Builder>

    • addRepeatedField

      public Pipeline.Stage.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Pipeline.Stage.Builder>

    • mergeFrom

      public Pipeline.Stage.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Pipeline.Stage.Builder>

    • mergeFrom

      public Pipeline.Stage.Builder mergeFrom(Pipeline.Stage other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Pipeline.Stage.Builder>

    • mergeFrom

      public Pipeline.Stage.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Pipeline.Stage.Builder>
      Throws:
      IOException

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

    • setName

      public Pipeline.Stage.Builder setName(String value)
       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];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public Pipeline.Stage.Builder clearName()
       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];
      Returns:
      This builder for chaining.

    • setNameBytes

      public Pipeline.Stage.Builder setNameBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • 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

    • 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

    • setArgs

      public Pipeline.Stage.Builder setArgs(int index, Value value)
       Optional. Ordered list of arguments the given stage expects.
      repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

    • setArgs

      public Pipeline.Stage.Builder setArgs(int index, Value.Builder builderForValue)
       Optional. Ordered list of arguments the given stage expects.
      repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

    • addArgs

      public Pipeline.Stage.Builder addArgs(Value value)
       Optional. Ordered list of arguments the given stage expects.
      repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

    • addArgs

      public Pipeline.Stage.Builder addArgs(int index, Value value)
       Optional. Ordered list of arguments the given stage expects.
      repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

    • addArgs

      public Pipeline.Stage.Builder addArgs(Value.Builder builderForValue)
       Optional. Ordered list of arguments the given stage expects.
      repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

    • addArgs

      public Pipeline.Stage.Builder addArgs(int index, Value.Builder builderForValue)
       Optional. Ordered list of arguments the given stage expects.
      repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

    • addAllArgs

      public Pipeline.Stage.Builder addAllArgs(Iterable<? extends Value> values)
       Optional. Ordered list of arguments the given stage expects.
      repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

    • clearArgs

      public Pipeline.Stage.Builder clearArgs()
       Optional. Ordered list of arguments the given stage expects.
      repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

    • removeArgs

      public Pipeline.Stage.Builder removeArgs(int index)
       Optional. Ordered list of arguments the given stage expects.
      repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getArgsBuilder

      public Value.Builder getArgsBuilder(int index)
       Optional. Ordered list of arguments the given stage expects.
      repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

    • 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

    • 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

    • addArgsBuilder

      public Value.Builder addArgsBuilder()
       Optional. Ordered list of arguments the given stage expects.
      repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

    • addArgsBuilder

      public Value.Builder addArgsBuilder(int index)
       Optional. Ordered list of arguments the given stage expects.
      repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getArgsBuilderList

      public List<Value.Builder> getArgsBuilderList()
       Optional. Ordered list of arguments the given stage expects.
      repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];

    • 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

    • clearOptions

      public Pipeline.Stage.Builder clearOptions()

    • removeOptions

      public Pipeline.Stage.Builder removeOptions(String key)
       Optional. Optional named arguments that certain functions may support.
      map<string, .google.firestore.v1.Value> options = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getMutableOptions

      @Deprecated public Map<String,Value> getMutableOptions()
      Deprecated.
      Use alternate mutation accessors instead.

    • putOptions

      public Pipeline.Stage.Builder putOptions(String key, Value value)
       Optional. Optional named arguments that certain functions may support.
      map<string, .google.firestore.v1.Value> options = 3 [(.google.api.field_behavior) = OPTIONAL];

    • putAllOptions

      public Pipeline.Stage.Builder putAllOptions(Map<String,Value> values)
       Optional. Optional named arguments that certain functions may support.
      map<string, .google.firestore.v1.Value> options = 3 [(.google.api.field_behavior) = OPTIONAL];

    • putOptionsBuilderIfAbsent

      public Value.Builder putOptionsBuilderIfAbsent(String key)
       Optional. Optional named arguments that certain functions may support.
      map<string, .google.firestore.v1.Value> options = 3 [(.google.api.field_behavior) = OPTIONAL];

    • setUnknownFields

      public final Pipeline.Stage.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Pipeline.Stage.Builder>

    • mergeUnknownFields

      public final Pipeline.Stage.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Pipeline.Stage.Builder>