Class DocumentTransform (3.24.3)

public final class DocumentTransform extends GeneratedMessageV3 implements DocumentTransformOrBuilder

A transformation of a document.

Protobuf type google.firestore.v1.DocumentTransform

Static Fields

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER
Field Value
Type Description
int

FIELD_TRANSFORMS_FIELD_NUMBER

public static final int FIELD_TRANSFORMS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DocumentTransform getDefaultInstance()
Returns
Type Description
DocumentTransform

getDescriptor()

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

newBuilder()

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

newBuilder(DocumentTransform prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public DocumentTransform getDefaultInstanceForType()
Returns
Type Description
DocumentTransform

getDocument()

public String getDocument()

The name of the document to transform.

string document = 1;

Returns
Type Description
String

The document.

getDocumentBytes()

public ByteString getDocumentBytes()

The name of the document to transform.

string document = 1;

Returns
Type Description
ByteString

The bytes for document.

getFieldTransforms(int index)

public DocumentTransform.FieldTransform getFieldTransforms(int index)

The list of transformations to apply to the fields of the document, in order. This must not be empty.

repeated .google.firestore.v1.DocumentTransform.FieldTransform field_transforms = 2;

Parameter
Name Description
index int
Returns
Type Description
DocumentTransform.FieldTransform

getFieldTransformsCount()

public int getFieldTransformsCount()

The list of transformations to apply to the fields of the document, in order. This must not be empty.

repeated .google.firestore.v1.DocumentTransform.FieldTransform field_transforms = 2;

Returns
Type Description
int

getFieldTransformsList()

public List<DocumentTransform.FieldTransform> getFieldTransformsList()

The list of transformations to apply to the fields of the document, in order. This must not be empty.

repeated .google.firestore.v1.DocumentTransform.FieldTransform field_transforms = 2;

Returns
Type Description
List<FieldTransform>

getFieldTransformsOrBuilder(int index)

public DocumentTransform.FieldTransformOrBuilder getFieldTransformsOrBuilder(int index)

The list of transformations to apply to the fields of the document, in order. This must not be empty.

repeated .google.firestore.v1.DocumentTransform.FieldTransform field_transforms = 2;

Parameter
Name Description
index int
Returns
Type Description
DocumentTransform.FieldTransformOrBuilder

getFieldTransformsOrBuilderList()

public List<? extends DocumentTransform.FieldTransformOrBuilder> getFieldTransformsOrBuilderList()

The list of transformations to apply to the fields of the document, in order. This must not be empty.

repeated .google.firestore.v1.DocumentTransform.FieldTransform field_transforms = 2;

Returns
Type Description
List<? extends com.google.firestore.v1.DocumentTransform.FieldTransformOrBuilder>

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 DocumentTransform.Builder newBuilderForType()
Returns
Type Description
DocumentTransform.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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