BeginTransactionRequest.Builder (proto-google-cloud-firestore-v1 3.6.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<BeginTransactionRequest.Builder>
    - - com.google.firestore.v1.BeginTransactionRequest.Builder

All Implemented Interfaces:

BeginTransactionRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

BeginTransactionRequest
```
public static final class BeginTransactionRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<BeginTransactionRequest.Builder>
implements BeginTransactionRequestOrBuilder
```
```
 The request for [Firestore.BeginTransaction][google.firestore.v1.Firestore.BeginTransaction].
 
```
Protobuf type google.firestore.v1.BeginTransactionRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BeginTransactionRequest.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`BeginTransactionRequest`	`build()`
`BeginTransactionRequest`	`buildPartial()`
`BeginTransactionRequest.Builder`	`clear()`
`BeginTransactionRequest.Builder`	`clearDatabase()` Required.
`BeginTransactionRequest.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`BeginTransactionRequest.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`BeginTransactionRequest.Builder`	`clearOptions()` The options for the transaction.
`BeginTransactionRequest.Builder`	`clone()`
`String`	`getDatabase()` Required.
`com.google.protobuf.ByteString`	`getDatabaseBytes()` Required.
`BeginTransactionRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`TransactionOptions`	`getOptions()` The options for the transaction.
`TransactionOptions.Builder`	`getOptionsBuilder()` The options for the transaction.
`TransactionOptionsOrBuilder`	`getOptionsOrBuilder()` The options for the transaction.
`boolean`	`hasOptions()` The options for the transaction.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`BeginTransactionRequest.Builder`	`mergeFrom(BeginTransactionRequest other)`
`BeginTransactionRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`BeginTransactionRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`BeginTransactionRequest.Builder`	`mergeOptions(TransactionOptions value)` The options for the transaction.
`BeginTransactionRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`BeginTransactionRequest.Builder`	`setDatabase(String value)` Required.
`BeginTransactionRequest.Builder`	`setDatabaseBytes(com.google.protobuf.ByteString value)` Required.
`BeginTransactionRequest.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`BeginTransactionRequest.Builder`	`setOptions(TransactionOptions.Builder builderForValue)` The options for the transaction.
`BeginTransactionRequest.Builder`	`setOptions(TransactionOptions value)` The options for the transaction.
`BeginTransactionRequest.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`BeginTransactionRequest.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<BeginTransactionRequest.Builder>
  - clear
```
public BeginTransactionRequest.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<BeginTransactionRequest.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<BeginTransactionRequest.Builder>
  - getDefaultInstanceForType
```
public BeginTransactionRequest getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public BeginTransactionRequest build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public BeginTransactionRequest buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public BeginTransactionRequest.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<BeginTransactionRequest.Builder>
  - setField
```
public BeginTransactionRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<BeginTransactionRequest.Builder>
  - clearField
```
public BeginTransactionRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<BeginTransactionRequest.Builder>
  - clearOneof
```
public BeginTransactionRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<BeginTransactionRequest.Builder>
  - setRepeatedField
```
public BeginTransactionRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        int index,
                                                        Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BeginTransactionRequest.Builder>
  - addRepeatedField
```
public BeginTransactionRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BeginTransactionRequest.Builder>
  - mergeFrom
```
public BeginTransactionRequest.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BeginTransactionRequest.Builder>
  - mergeFrom
```
public BeginTransactionRequest.Builder mergeFrom(BeginTransactionRequest other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<BeginTransactionRequest.Builder>
  - mergeFrom
```
public BeginTransactionRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BeginTransactionRequest.Builder>
    
    Throws:
    
    IOException
  - getDatabase
```
public String getDatabase()
```
```
 Required. The database name. In the format:
 `projects/{project_id}/databases/{database_id}`.
 
```
    string database = 1 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getDatabase in interface BeginTransactionRequestOrBuilder
    
    Returns:
    
    The database.
  - getDatabaseBytes
```
public com.google.protobuf.ByteString getDatabaseBytes()
```
```
 Required. The database name. In the format:
 `projects/{project_id}/databases/{database_id}`.
 
```
    string database = 1 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getDatabaseBytes in interface BeginTransactionRequestOrBuilder
    
    Returns:
    
    The bytes for database.
  - setDatabase
```
public BeginTransactionRequest.Builder setDatabase(String value)
```
```
 Required. The database name. In the format:
 `projects/{project_id}/databases/{database_id}`.
 
```
    string database = 1 [(.google.api.field_behavior) = REQUIRED];
    Parameters:
    
    value - The database to set.
    
    Returns:
    
    This builder for chaining.
  - clearDatabase
```
public BeginTransactionRequest.Builder clearDatabase()
```
```
 Required. The database name. In the format:
 `projects/{project_id}/databases/{database_id}`.
 
```
    string database = 1 [(.google.api.field_behavior) = REQUIRED];
    Returns:
    
    This builder for chaining.
  - setDatabaseBytes
```
public BeginTransactionRequest.Builder setDatabaseBytes(com.google.protobuf.ByteString value)
```
```
 Required. The database name. In the format:
 `projects/{project_id}/databases/{database_id}`.
 
```
    string database = 1 [(.google.api.field_behavior) = REQUIRED];
    Parameters:
    
    value - The bytes for database to set.
    
    Returns:
    
    This builder for chaining.
  - hasOptions
```
public boolean hasOptions()
```
```
 The options for the transaction.
 Defaults to a read-write transaction.
 
```
    .google.firestore.v1.TransactionOptions options = 2;
    Specified by:
    
    hasOptions in interface BeginTransactionRequestOrBuilder
    
    Returns:
    
    Whether the options field is set.
  - getOptions
```
public TransactionOptions getOptions()
```
```
 The options for the transaction.
 Defaults to a read-write transaction.
 
```
    .google.firestore.v1.TransactionOptions options = 2;
    Specified by:
    
    getOptions in interface BeginTransactionRequestOrBuilder
    
    Returns:
    
    The options.
  - setOptions
```
public BeginTransactionRequest.Builder setOptions(TransactionOptions value)
```
```
 The options for the transaction.
 Defaults to a read-write transaction.
 
```
    .google.firestore.v1.TransactionOptions options = 2;
  - setOptions
```
public BeginTransactionRequest.Builder setOptions(TransactionOptions.Builder builderForValue)
```
```
 The options for the transaction.
 Defaults to a read-write transaction.
 
```
    .google.firestore.v1.TransactionOptions options = 2;
  - mergeOptions
```
public BeginTransactionRequest.Builder mergeOptions(TransactionOptions value)
```
```
 The options for the transaction.
 Defaults to a read-write transaction.
 
```
    .google.firestore.v1.TransactionOptions options = 2;
  - clearOptions
```
public BeginTransactionRequest.Builder clearOptions()
```
```
 The options for the transaction.
 Defaults to a read-write transaction.
 
```
    .google.firestore.v1.TransactionOptions options = 2;
  - getOptionsBuilder
```
public TransactionOptions.Builder getOptionsBuilder()
```
```
 The options for the transaction.
 Defaults to a read-write transaction.
 
```
    .google.firestore.v1.TransactionOptions options = 2;
  - getOptionsOrBuilder
```
public TransactionOptionsOrBuilder getOptionsOrBuilder()
```
```
 The options for the transaction.
 Defaults to a read-write transaction.
 
```
    .google.firestore.v1.TransactionOptions options = 2;
    Specified by:
    
    getOptionsOrBuilder in interface BeginTransactionRequestOrBuilder
  - setUnknownFields
```
public final BeginTransactionRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BeginTransactionRequest.Builder>
  - mergeUnknownFields
```
public final BeginTransactionRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BeginTransactionRequest.Builder>

Class BeginTransactionRequest.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getDatabase

getDatabaseBytes

setDatabase

clearDatabase

setDatabaseBytes

hasOptions

getOptions

setOptions

setOptions

mergeOptions

clearOptions

getOptionsBuilder

getOptionsOrBuilder

setUnknownFields

mergeUnknownFields