Class Pipeline (3.35.1)

public final class Pipeline extends GeneratedMessageV3 implements PipelineOrBuilder

A Firestore query represented as an ordered list of operations / stages.

Protobuf type google.firestore.v1.Pipeline

Implements

PipelineOrBuilder

Static Fields

STAGES_FIELD_NUMBER

public static final int STAGES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Pipeline getDefaultInstance()
Returns
Type Description
Pipeline

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Pipeline.Builder newBuilder()
Returns
Type Description
Pipeline.Builder

newBuilder(Pipeline prototype)

public static Pipeline.Builder newBuilder(Pipeline prototype)
Parameter
Name Description
prototype Pipeline
Returns
Type Description
Pipeline.Builder

parseDelimitedFrom(InputStream input)

public static Pipeline parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Pipeline
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Pipeline parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Pipeline parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Pipeline
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Pipeline parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Pipeline parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Pipeline
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Pipeline parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Pipeline parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Pipeline
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Pipeline parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Pipeline parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Pipeline
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Pipeline parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Pipeline parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Pipeline
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Pipeline parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Pipeline> parser()
Returns
Type Description
Parser<Pipeline>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Pipeline getDefaultInstanceForType()
Returns
Type Description
Pipeline

getParserForType()

public Parser<Pipeline> getParserForType()
Returns
Type Description
Parser<Pipeline>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStages(int index)

public Pipeline.Stage getStages(int index)

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Pipeline.Stage

getStagesCount()

public int getStagesCount()

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getStagesList()

public List<Pipeline.Stage> getStagesList()

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Stage>

getStagesOrBuilder(int index)

public Pipeline.StageOrBuilder getStagesOrBuilder(int index)

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Pipeline.StageOrBuilder

getStagesOrBuilderList()

public List<? extends Pipeline.StageOrBuilder> getStagesOrBuilderList()

Required. Ordered list of stages to evaluate.

repeated .google.firestore.v1.Pipeline.Stage stages = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.firestore.v1.Pipeline.StageOrBuilder>

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Pipeline.Builder newBuilderForType()
Returns
Type Description
Pipeline.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Pipeline.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Pipeline.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Pipeline.Builder toBuilder()
Returns
Type Description
Pipeline.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException