com.google.cloud.firestore.v1

Class FirestoreSettings.Builder

java.lang.Object

com.google.api.gax.rpc.ClientSettings.Builder<FirestoreSettings,FirestoreSettings.Builder>

com.google.cloud.firestore.v1.FirestoreSettings.Builder

Enclosing class:

FirestoreSettings

public static class FirestoreSettings.Builder
extends ClientSettings.Builder<FirestoreSettings,FirestoreSettings.Builder>

Builder for FirestoreSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder()
protected	Builder(ClientContext clientContext)
protected	Builder(FirestoreSettings settings)
protected	Builder(FirestoreStubSettings.Builder stubSettings)

Method Summary

Modifier and Type	Method and Description
FirestoreSettings.Builder	applyToAllUnaryMethods(com.google.api.core.ApiFunction<UnaryCallSettings.Builder<?,?>,Void> settingsUpdater) Applies the given settings updater function to all of the unary API methods in this service.
ServerStreamingCallSettings.Builder<com.google.firestore.v1.BatchGetDocumentsRequest,com.google.firestore.v1.BatchGetDocumentsResponse>	batchGetDocumentsSettings() Returns the builder for the settings used for calls to batchGetDocuments.
UnaryCallSettings.Builder<com.google.firestore.v1.BeginTransactionRequest,com.google.firestore.v1.BeginTransactionResponse>	beginTransactionSettings() Returns the builder for the settings used for calls to beginTransaction.
FirestoreSettings	build()
UnaryCallSettings.Builder<com.google.firestore.v1.CommitRequest,com.google.firestore.v1.CommitResponse>	commitSettings() Returns the builder for the settings used for calls to commit.
UnaryCallSettings.Builder<com.google.firestore.v1.CreateDocumentRequest,com.google.firestore.v1.Document>	createDocumentSettings() Returns the builder for the settings used for calls to createDocument.
UnaryCallSettings.Builder<com.google.firestore.v1.DeleteDocumentRequest,Empty>	deleteDocumentSettings() Returns the builder for the settings used for calls to deleteDocument.
UnaryCallSettings.Builder<com.google.firestore.v1.GetDocumentRequest,com.google.firestore.v1.Document>	getDocumentSettings() Returns the builder for the settings used for calls to getDocument.
FirestoreStubSettings.Builder	getStubSettingsBuilder()
PagedCallSettings.Builder<com.google.firestore.v1.ListCollectionIdsRequest,com.google.firestore.v1.ListCollectionIdsResponse,FirestoreClient.ListCollectionIdsPagedResponse>	listCollectionIdsSettings() Returns the builder for the settings used for calls to listCollectionIds.
PagedCallSettings.Builder<com.google.firestore.v1.ListDocumentsRequest,com.google.firestore.v1.ListDocumentsResponse,FirestoreClient.ListDocumentsPagedResponse>	listDocumentsSettings() Returns the builder for the settings used for calls to listDocuments.
StreamingCallSettings.Builder<com.google.firestore.v1.ListenRequest,com.google.firestore.v1.ListenResponse>	listenSettings() Returns the builder for the settings used for calls to listen.
UnaryCallSettings.Builder<com.google.firestore.v1.RollbackRequest,Empty>	rollbackSettings() Returns the builder for the settings used for calls to rollback.
ServerStreamingCallSettings.Builder<com.google.firestore.v1.RunQueryRequest,com.google.firestore.v1.RunQueryResponse>	runQuerySettings() Returns the builder for the settings used for calls to runQuery.
UnaryCallSettings.Builder<com.google.firestore.v1.UpdateDocumentRequest,com.google.firestore.v1.Document>	updateDocumentSettings() Returns the builder for the settings used for calls to updateDocument.
StreamingCallSettings.Builder<com.google.firestore.v1.WriteRequest,com.google.firestore.v1.WriteResponse>	writeSettings() Returns the builder for the settings used for calls to write.

Methods inherited from class com.google.api.gax.rpc.ClientSettings.Builder

applyToAllUnaryMethods, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, self, setClock, setCredentialsProvider, setEndpoint, setExecutorProvider, setHeaderProvider, setInternalHeaderProvider, setTransportChannelProvider, setWatchdogCheckInterval, setWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Builder

protected Builder()
           throws IOException

Throws:

IOException

Builder

protected Builder(ClientContext clientContext)

Builder

protected Builder(FirestoreSettings settings)

Builder

protected Builder(FirestoreStubSettings.Builder stubSettings)

Method Detail

getStubSettingsBuilder

public FirestoreStubSettings.Builder getStubSettingsBuilder()

applyToAllUnaryMethods

public FirestoreSettings.Builder applyToAllUnaryMethods(com.google.api.core.ApiFunction<UnaryCallSettings.Builder<?,?>,Void> settingsUpdater)
                                                 throws Exception

Applies the given settings updater function to all of the unary API methods in this service.

Note: This method does not support applying settings to streaming methods.

Throws:

Exception

getDocumentSettings

public UnaryCallSettings.Builder<com.google.firestore.v1.GetDocumentRequest,com.google.firestore.v1.Document> getDocumentSettings()

Returns the builder for the settings used for calls to getDocument.

listDocumentsSettings

public PagedCallSettings.Builder<com.google.firestore.v1.ListDocumentsRequest,com.google.firestore.v1.ListDocumentsResponse,FirestoreClient.ListDocumentsPagedResponse> listDocumentsSettings()

Returns the builder for the settings used for calls to listDocuments.

createDocumentSettings

public UnaryCallSettings.Builder<com.google.firestore.v1.CreateDocumentRequest,com.google.firestore.v1.Document> createDocumentSettings()

Returns the builder for the settings used for calls to createDocument.

updateDocumentSettings

public UnaryCallSettings.Builder<com.google.firestore.v1.UpdateDocumentRequest,com.google.firestore.v1.Document> updateDocumentSettings()

Returns the builder for the settings used for calls to updateDocument.

deleteDocumentSettings

public UnaryCallSettings.Builder<com.google.firestore.v1.DeleteDocumentRequest,Empty> deleteDocumentSettings()

Returns the builder for the settings used for calls to deleteDocument.

batchGetDocumentsSettings

public ServerStreamingCallSettings.Builder<com.google.firestore.v1.BatchGetDocumentsRequest,com.google.firestore.v1.BatchGetDocumentsResponse> batchGetDocumentsSettings()

Returns the builder for the settings used for calls to batchGetDocuments.

beginTransactionSettings

public UnaryCallSettings.Builder<com.google.firestore.v1.BeginTransactionRequest,com.google.firestore.v1.BeginTransactionResponse> beginTransactionSettings()

Returns the builder for the settings used for calls to beginTransaction.

commitSettings

public UnaryCallSettings.Builder<com.google.firestore.v1.CommitRequest,com.google.firestore.v1.CommitResponse> commitSettings()

Returns the builder for the settings used for calls to commit.

rollbackSettings

public UnaryCallSettings.Builder<com.google.firestore.v1.RollbackRequest,Empty> rollbackSettings()

Returns the builder for the settings used for calls to rollback.

runQuerySettings

public ServerStreamingCallSettings.Builder<com.google.firestore.v1.RunQueryRequest,com.google.firestore.v1.RunQueryResponse> runQuerySettings()

Returns the builder for the settings used for calls to runQuery.

writeSettings

public StreamingCallSettings.Builder<com.google.firestore.v1.WriteRequest,com.google.firestore.v1.WriteResponse> writeSettings()

Returns the builder for the settings used for calls to write.

listenSettings

public StreamingCallSettings.Builder<com.google.firestore.v1.ListenRequest,com.google.firestore.v1.ListenResponse> listenSettings()

Returns the builder for the settings used for calls to listen.

listCollectionIdsSettings

public PagedCallSettings.Builder<com.google.firestore.v1.ListCollectionIdsRequest,com.google.firestore.v1.ListCollectionIdsResponse,FirestoreClient.ListCollectionIdsPagedResponse> listCollectionIdsSettings()

Returns the builder for the settings used for calls to listCollectionIds.

build

public FirestoreSettings build()
                        throws IOException

Specified by:

build in class ClientSettings.Builder<FirestoreSettings,FirestoreSettings.Builder>

Throws:

IOException