Interface StructuredPipelineOrBuilder (3.35.1) 

public interface StructuredPipelineOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsOptions(String key)

public abstract boolean containsOptions(String key)

Optional. Optional query-level arguments.

map<string, .google.firestore.v1.Value> options = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getOptions() (deprecated)

public abstract Map<String,Value> getOptions()

Use #getOptionsMap() instead.

Returns
Type Description
Map<String,Value>

getOptionsCount()

public abstract int getOptionsCount()

Optional. Optional query-level arguments.

map<string, .google.firestore.v1.Value> options = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getOptionsMap()

public abstract Map<String,Value> getOptionsMap()

Optional. Optional query-level arguments.

map<string, .google.firestore.v1.Value> options = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,Value>

getOptionsOrDefault(String key, Value defaultValue)

public abstract Value getOptionsOrDefault(String key, Value defaultValue)

Optional. Optional query-level arguments.

map<string, .google.firestore.v1.Value> options = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue Value
Returns
Type Description
Value

getOptionsOrThrow(String key)

public abstract Value getOptionsOrThrow(String key)

Optional. Optional query-level arguments.

map<string, .google.firestore.v1.Value> options = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
Value

getPipeline()

public abstract Pipeline getPipeline()

Required. The pipeline query to execute.

.google.firestore.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Pipeline

The pipeline.

getPipelineOrBuilder()

public abstract PipelineOrBuilder getPipelineOrBuilder()

Required. The pipeline query to execute.

.google.firestore.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PipelineOrBuilder

hasPipeline()

public abstract boolean hasPipeline()

Required. The pipeline query to execute.

.google.firestore.v1.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the pipeline field is set.