Package com.google.firestore.v1

Class StructuredPipeline.Builder

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

  • 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.GeneratedMessage.Builder<StructuredPipeline.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<StructuredPipeline.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<StructuredPipeline.Builder>

    • clear

      public StructuredPipeline.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.GeneratedMessage.Builder<StructuredPipeline.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.GeneratedMessage.Builder<StructuredPipeline.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public StructuredPipeline.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<StructuredPipeline.Builder>

    • mergeFrom

      public StructuredPipeline.Builder mergeFrom(StructuredPipeline other)

    • isInitialized

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

    • mergeFrom

      public StructuredPipeline.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<StructuredPipeline.Builder>
      Throws:
      IOException

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

    • setPipeline

      public StructuredPipeline.Builder setPipeline(Pipeline value)
       Required. The pipeline query to execute.
      .google.firestore.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

    • setPipeline

      public StructuredPipeline.Builder setPipeline(Pipeline.Builder builderForValue)
       Required. The pipeline query to execute.
      .google.firestore.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

    • mergePipeline

      public StructuredPipeline.Builder mergePipeline(Pipeline value)
       Required. The pipeline query to execute.
      .google.firestore.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

    • clearPipeline

      public StructuredPipeline.Builder clearPipeline()
       Required. The pipeline query to execute.
      .google.firestore.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

    • getPipelineBuilder

      public Pipeline.Builder getPipelineBuilder()
       Required. The pipeline query to execute.
      .google.firestore.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

    • 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

    • clearOptions

      public StructuredPipeline.Builder clearOptions()

    • removeOptions

      public StructuredPipeline.Builder removeOptions(String key)
       Optional. Optional query-level arguments.
      map<string, .google.firestore.v1.Value> options = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getMutableOptions

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

    • putOptions

      public StructuredPipeline.Builder putOptions(String key, Value value)
       Optional. Optional query-level arguments.
      map<string, .google.firestore.v1.Value> options = 2 [(.google.api.field_behavior) = OPTIONAL];

    • putAllOptions

      public StructuredPipeline.Builder putAllOptions(Map<String,Value> values)
       Optional. Optional query-level arguments.
      map<string, .google.firestore.v1.Value> options = 2 [(.google.api.field_behavior) = OPTIONAL];

    • putOptionsBuilderIfAbsent

      public Value.Builder putOptionsBuilderIfAbsent(String key)
       Optional. Optional query-level arguments.
      map<string, .google.firestore.v1.Value> options = 2 [(.google.api.field_behavior) = OPTIONAL];