Class DocumentTransform (3.0.21)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version 3.0.21keyboard_arrow_down
public final class DocumentTransform extends GeneratedMessageV3 implements DocumentTransformOrBuilder
A transformation of a document.
Protobuf type google.firestore.v1.DocumentTransform
Static Fields
public static final int DOCUMENT_FIELD_NUMBER
Field Value
public static final int FIELD_TRANSFORMS_FIELD_NUMBER
Field Value
Static Methods
public static DocumentTransform getDefaultInstance ()
Returns
public static final Descriptors . Descriptor getDescriptor ()
Returns
public static DocumentTransform . Builder newBuilder ()
Returns
public static DocumentTransform . Builder newBuilder ( DocumentTransform prototype )
Parameter
Returns
public static DocumentTransform parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static DocumentTransform parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static DocumentTransform parseFrom ( byte [] data )
Parameter
Name Description
data byte []
Returns
Exceptions
public static DocumentTransform parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static DocumentTransform parseFrom ( ByteString data )
Parameter
Returns
Exceptions
public static DocumentTransform parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static DocumentTransform parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static DocumentTransform parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static DocumentTransform parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static DocumentTransform parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static DocumentTransform parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
public static DocumentTransform parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Parser<DocumentTransform> parser ()
Returns
Methods
public boolean equals ( Object obj )
Parameter
Returns
Overrides
public DocumentTransform getDefaultInstanceForType ()
Returns
public String getDocument ()
The name of the document to transform.
string document = 1;
Returns
Type Description
String The document.
public ByteString getDocumentBytes ()
The name of the document to transform.
string document = 1;
Returns
Type Description
ByteString The bytes for document.
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
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
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
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
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 >
public Parser<DocumentTransform> getParserForType ()
Returns
Overrides
public int getSerializedSize ()
Returns
Overrides
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
Returns
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
public final boolean isInitialized ()
Returns
Overrides
public DocumentTransform . Builder newBuilderForType ()
Returns
protected DocumentTransform . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
public DocumentTransform . Builder toBuilder ()
Returns
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-07 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[]]
