public static interface Pipeline.StageOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsOptions(String key)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getArgs(int index)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Value |
|
getArgsCount()
public abstract int getArgsCount()Optional. Ordered list of arguments the given stage expects.
repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getArgsList()
public abstract List<Value> getArgsList()Optional. Ordered list of arguments the given stage expects.
repeated .google.firestore.v1.Value args = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Value> |
|
getArgsOrBuilder(int index)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ValueOrBuilder |
|
getArgsOrBuilderList()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.firestore.v1.ValueOrBuilder> |
|
getName()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getOptions() (deprecated)
public abstract Map<String,Value> getOptions()Use #getOptionsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Value> |
|
getOptionsCount()
public abstract int getOptionsCount()Optional. Optional named arguments that certain functions may support.
map<string, .google.firestore.v1.Value> options = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getOptionsMap()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
Map<String,Value> |
|
getOptionsOrDefault(String key, Value defaultValue)
public abstract 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];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
Value |
| Returns | |
|---|---|
| Type | Description |
Value |
|
getOptionsOrThrow(String key)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
Value |
|