Class DocumentTransform.Builder (3.21.0)

public static final class DocumentTransform.Builder extends GeneratedMessageV3.Builder<DocumentTransform.Builder> implements DocumentTransformOrBuilder

A transformation of a document.

Protobuf type google.firestore.v1.DocumentTransform

Static Methods

getDescriptor()

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

Methods

addAllFieldTransforms(Iterable<? extends DocumentTransform.FieldTransform> values)

public DocumentTransform.Builder addAllFieldTransforms(Iterable<? extends DocumentTransform.FieldTransform> values)

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
values Iterable<? extends com.google.firestore.v1.DocumentTransform.FieldTransform>
Returns
Type Description
DocumentTransform.Builder

addFieldTransforms(DocumentTransform.FieldTransform value)

public DocumentTransform.Builder addFieldTransforms(DocumentTransform.FieldTransform value)

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
value DocumentTransform.FieldTransform
Returns
Type Description
DocumentTransform.Builder

addFieldTransforms(DocumentTransform.FieldTransform.Builder builderForValue)

public DocumentTransform.Builder addFieldTransforms(DocumentTransform.FieldTransform.Builder builderForValue)

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
builderForValue DocumentTransform.FieldTransform.Builder
Returns
Type Description
DocumentTransform.Builder

addFieldTransforms(int index, DocumentTransform.FieldTransform value)

public DocumentTransform.Builder addFieldTransforms(int index, DocumentTransform.FieldTransform value)

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;

Parameters
Name Description
index int
value DocumentTransform.FieldTransform
Returns
Type Description
DocumentTransform.Builder

addFieldTransforms(int index, DocumentTransform.FieldTransform.Builder builderForValue)

public DocumentTransform.Builder addFieldTransforms(int index, DocumentTransform.FieldTransform.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue DocumentTransform.FieldTransform.Builder
Returns
Type Description
DocumentTransform.Builder

addFieldTransformsBuilder()

public DocumentTransform.FieldTransform.Builder addFieldTransformsBuilder()

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
DocumentTransform.FieldTransform.Builder

addFieldTransformsBuilder(int index)

public DocumentTransform.FieldTransform.Builder addFieldTransformsBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DocumentTransform.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DocumentTransform.Builder
Overrides

build()

public DocumentTransform build()
Returns
Type Description
DocumentTransform

buildPartial()

public DocumentTransform buildPartial()
Returns
Type Description
DocumentTransform

clear()

public DocumentTransform.Builder clear()
Returns
Type Description
DocumentTransform.Builder
Overrides

clearDocument()

public DocumentTransform.Builder clearDocument()

The name of the document to transform.

string document = 1;

Returns
Type Description
DocumentTransform.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DocumentTransform.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DocumentTransform.Builder
Overrides

clearFieldTransforms()

public DocumentTransform.Builder clearFieldTransforms()

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
DocumentTransform.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public DocumentTransform.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DocumentTransform.Builder
Overrides

clone()

public DocumentTransform.Builder clone()
Returns
Type Description
DocumentTransform.Builder
Overrides

getDefaultInstanceForType()

public DocumentTransform getDefaultInstanceForType()
Returns
Type Description
DocumentTransform

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

getFieldTransformsBuilder(int index)

public DocumentTransform.FieldTransform.Builder getFieldTransformsBuilder(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.Builder

getFieldTransformsBuilderList()

public List<DocumentTransform.FieldTransform.Builder> getFieldTransformsBuilderList()

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<Builder>

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>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DocumentTransform other)

public DocumentTransform.Builder mergeFrom(DocumentTransform other)
Parameter
Name Description
other DocumentTransform
Returns
Type Description
DocumentTransform.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DocumentTransform.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentTransform.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DocumentTransform.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DocumentTransform.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DocumentTransform.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DocumentTransform.Builder
Overrides

removeFieldTransforms(int index)

public DocumentTransform.Builder removeFieldTransforms(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.Builder

setDocument(String value)

public DocumentTransform.Builder setDocument(String value)

The name of the document to transform.

string document = 1;

Parameter
Name Description
value String

The document to set.

Returns
Type Description
DocumentTransform.Builder

This builder for chaining.

setDocumentBytes(ByteString value)

public DocumentTransform.Builder setDocumentBytes(ByteString value)

The name of the document to transform.

string document = 1;

Parameter
Name Description
value ByteString

The bytes for document to set.

Returns
Type Description
DocumentTransform.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DocumentTransform.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DocumentTransform.Builder
Overrides

setFieldTransforms(int index, DocumentTransform.FieldTransform value)

public DocumentTransform.Builder setFieldTransforms(int index, DocumentTransform.FieldTransform value)

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;

Parameters
Name Description
index int
value DocumentTransform.FieldTransform
Returns
Type Description
DocumentTransform.Builder

setFieldTransforms(int index, DocumentTransform.FieldTransform.Builder builderForValue)

public DocumentTransform.Builder setFieldTransforms(int index, DocumentTransform.FieldTransform.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue DocumentTransform.FieldTransform.Builder
Returns
Type Description
DocumentTransform.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DocumentTransform.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DocumentTransform.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final DocumentTransform.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DocumentTransform.Builder
Overrides