Class DocumentTransform (3.11.0)

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

FIELD_TRANSFORMS_FIELD_NUMBER

public static final int FIELD_TRANSFORMS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DocumentTransform getDefaultInstance()
Returns
TypeDescription
DocumentTransform

getDescriptor()

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

newBuilder()

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

newBuilder(DocumentTransform prototype)

public static DocumentTransform.Builder newBuilder(DocumentTransform prototype)
Parameter
NameDescription
prototypeDocumentTransform
Returns
TypeDescription
DocumentTransform.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public DocumentTransform getDefaultInstanceForType()
Returns
TypeDescription
DocumentTransform

getDocument()

public String getDocument()

The name of the document to transform.

string document = 1;

Returns
TypeDescription
String

The document.

getDocumentBytes()

public ByteString getDocumentBytes()

The name of the document to transform.

string document = 1;

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.firestore.v1.DocumentTransform.FieldTransformOrBuilder>

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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