public final class Precondition extends GeneratedMessage implements PreconditionOrBuilderA precondition on a document, used for conditional operations.
Protobuf type google.firestore.v1.Precondition
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > PreconditionImplements
PreconditionOrBuilderStatic Fields
EXISTS_FIELD_NUMBER
public static final int EXISTS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static Precondition getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
Precondition |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static Precondition.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
Precondition.Builder |
|
newBuilder(Precondition prototype)
public static Precondition.Builder newBuilder(Precondition prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
Precondition |
| Returns | |
|---|---|
| Type | Description |
Precondition.Builder |
|
parseDelimitedFrom(InputStream input)
public static Precondition parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Precondition |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Precondition parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Precondition |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static Precondition parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
Precondition |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Precondition parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Precondition |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static Precondition parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
Precondition |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Precondition parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Precondition |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static Precondition parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
Precondition |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Precondition parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Precondition |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static Precondition parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Precondition |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Precondition parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Precondition |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static Precondition parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
Precondition |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Precondition parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Precondition |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<Precondition> parser()| Returns | |
|---|---|
| Type | Description |
Parser<Precondition> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getConditionTypeCase()
public Precondition.ConditionTypeCase getConditionTypeCase()| Returns | |
|---|---|
| Type | Description |
Precondition.ConditionTypeCase |
|
getDefaultInstanceForType()
public Precondition getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Precondition |
|
getExists()
public boolean getExists() When set to true, the target document must exist.
When set to false, the target document must not exist.
bool exists = 1;
| Returns | |
|---|---|
| Type | Description |
boolean |
The exists. |
getParserForType()
public Parser<Precondition> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<Precondition> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
getUpdateTime()
public Timestamp getUpdateTime()When set, the target document must exist and have been last updated at that time. Timestamp must be microsecond aligned.
.google.protobuf.Timestamp update_time = 2;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()When set, the target document must exist and have been last updated at that time. Timestamp must be microsecond aligned.
.google.protobuf.Timestamp update_time = 2;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
hasExists()
public boolean hasExists() When set to true, the target document must exist.
When set to false, the target document must not exist.
bool exists = 1;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the exists field is set. |
hasUpdateTime()
public boolean hasUpdateTime()When set, the target document must exist and have been last updated at that time. Timestamp must be microsecond aligned.
.google.protobuf.Timestamp update_time = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateTime field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public Precondition.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
Precondition.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected Precondition.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
Precondition.Builder |
|
toBuilder()
public Precondition.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
Precondition.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|