Class Precondition (3.5.0)

public final class Precondition extends GeneratedMessageV3 implements PreconditionOrBuilder

A precondition on a document, used for conditional operations.

Protobuf type google.firestore.v1.Precondition

Static Fields

EXISTS_FIELD_NUMBER

public static final int EXISTS_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Precondition getDefaultInstance()
Returns
TypeDescription
Precondition

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Precondition.Builder newBuilder()
Returns
TypeDescription
Precondition.Builder

newBuilder(Precondition prototype)

public static Precondition.Builder newBuilder(Precondition prototype)
Parameter
NameDescription
prototypePrecondition
Returns
TypeDescription
Precondition.Builder

parseDelimitedFrom(InputStream input)

public static Precondition parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Precondition
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Precondition parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Precondition
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Precondition parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Precondition
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Precondition parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Precondition
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Precondition parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Precondition
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Precondition parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Precondition
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Precondition parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Precondition
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Precondition parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Precondition
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Precondition parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Precondition
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Precondition parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Precondition
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Precondition parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Precondition
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Precondition parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Precondition
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Precondition> parser()
Returns
TypeDescription
Parser<Precondition>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getConditionTypeCase()

public Precondition.ConditionTypeCase getConditionTypeCase()
Returns
TypeDescription
Precondition.ConditionTypeCase

getDefaultInstanceForType()

public Precondition getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
boolean

The exists.

getParserForType()

public Parser<Precondition> getParserForType()
Returns
TypeDescription
Parser<Precondition>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Precondition.Builder newBuilderForType()
Returns
TypeDescription
Precondition.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Precondition.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Precondition.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Precondition.Builder toBuilder()
Returns
TypeDescription
Precondition.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException