Package 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 com.google.api.gax.rpc.ClientSettings.Builder<FirestoreSettings,FirestoreSettings.Builder>

Builder for FirestoreSettings.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()
protected	Builder(com.google.api.gax.rpc.ClientContext clientContext)
protected	Builder(FirestoreSettings settings)
protected	Builder(FirestoreStubSettings.Builder stubSettings)

Method Summary

Modifier and Type	Method	Description
FirestoreSettings.Builder	applyToAllUnaryMethods(com.google.api.core.ApiFunction<com.google.api.gax.rpc.UnaryCallSettings.Builder<?,?>,Void> settingsUpdater)	Applies the given settings updater function to all of the unary API methods in this service.
com.google.api.gax.rpc.ServerStreamingCallSettings.Builder<BatchGetDocumentsRequest,BatchGetDocumentsResponse>	batchGetDocumentsSettings()	Returns the builder for the settings used for calls to batchGetDocuments.
com.google.api.gax.rpc.UnaryCallSettings.Builder<BatchWriteRequest,BatchWriteResponse>	batchWriteSettings()	Returns the builder for the settings used for calls to batchWrite.
com.google.api.gax.rpc.UnaryCallSettings.Builder<BeginTransactionRequest,BeginTransactionResponse>	beginTransactionSettings()	Returns the builder for the settings used for calls to beginTransaction.
FirestoreSettings	build()
com.google.api.gax.rpc.UnaryCallSettings.Builder<CommitRequest,CommitResponse>	commitSettings()	Returns the builder for the settings used for calls to commit.
com.google.api.gax.rpc.UnaryCallSettings.Builder<CreateDocumentRequest,Document>	createDocumentSettings()	Returns the builder for the settings used for calls to createDocument.
com.google.api.gax.rpc.UnaryCallSettings.Builder<DeleteDocumentRequest,com.google.protobuf.Empty>	deleteDocumentSettings()	Returns the builder for the settings used for calls to deleteDocument.
com.google.api.gax.rpc.UnaryCallSettings.Builder<GetDocumentRequest,Document>	getDocumentSettings()	Returns the builder for the settings used for calls to getDocument.
FirestoreStubSettings.Builder	getStubSettingsBuilder()
com.google.api.gax.rpc.PagedCallSettings.Builder<ListCollectionIdsRequest,ListCollectionIdsResponse,FirestoreClient.ListCollectionIdsPagedResponse>	listCollectionIdsSettings()	Returns the builder for the settings used for calls to listCollectionIds.
com.google.api.gax.rpc.PagedCallSettings.Builder<ListDocumentsRequest,ListDocumentsResponse,FirestoreClient.ListDocumentsPagedResponse>	listDocumentsSettings()	Returns the builder for the settings used for calls to listDocuments.
com.google.api.gax.rpc.StreamingCallSettings.Builder<ListenRequest,ListenResponse>	listenSettings()	Returns the builder for the settings used for calls to listen.
com.google.api.gax.rpc.PagedCallSettings.Builder<PartitionQueryRequest,PartitionQueryResponse,FirestoreClient.PartitionQueryPagedResponse>	partitionQuerySettings()	Returns the builder for the settings used for calls to partitionQuery.
com.google.api.gax.rpc.UnaryCallSettings.Builder<RollbackRequest,com.google.protobuf.Empty>	rollbackSettings()	Returns the builder for the settings used for calls to rollback.
com.google.api.gax.rpc.ServerStreamingCallSettings.Builder<RunAggregationQueryRequest,RunAggregationQueryResponse>	runAggregationQuerySettings()	Returns the builder for the settings used for calls to runAggregationQuery.
com.google.api.gax.rpc.ServerStreamingCallSettings.Builder<RunQueryRequest,RunQueryResponse>	runQuerySettings()	Returns the builder for the settings used for calls to runQuery.
com.google.api.gax.rpc.UnaryCallSettings.Builder<UpdateDocumentRequest,Document>	updateDocumentSettings()	Returns the builder for the settings used for calls to updateDocument.
com.google.api.gax.rpc.StreamingCallSettings.Builder<WriteRequest,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, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, self, setBackgroundExecutorProvider, setClock, setCredentialsProvider, setEndpoint, setExecutorProvider, setGdchApiAudience, setHeaderProvider, setInternalHeaderProvider, setQuotaProjectId, setTransportChannelProvider, setUniverseDomain, setWatchdogCheckInterval, setWatchdogCheckIntervalDuration, setWatchdogProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()
           throws IOException

Throws:

IOException

Builder

protected Builder(com.google.api.gax.rpc.ClientContext clientContext)

Builder

protected Builder(FirestoreSettings settings)

Builder

protected Builder(FirestoreStubSettings.Builder stubSettings)

Method Details

getStubSettingsBuilder

public FirestoreStubSettings.Builder getStubSettingsBuilder()

applyToAllUnaryMethods

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

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.

getDocumentSettings

public com.google.api.gax.rpc.UnaryCallSettings.Builder<GetDocumentRequest,Document> getDocumentSettings()

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

listDocumentsSettings

public com.google.api.gax.rpc.PagedCallSettings.Builder<ListDocumentsRequest,ListDocumentsResponse,FirestoreClient.ListDocumentsPagedResponse> listDocumentsSettings()

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

updateDocumentSettings

public com.google.api.gax.rpc.UnaryCallSettings.Builder<UpdateDocumentRequest,Document> updateDocumentSettings()

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

deleteDocumentSettings

public com.google.api.gax.rpc.UnaryCallSettings.Builder<DeleteDocumentRequest,com.google.protobuf.Empty> deleteDocumentSettings()

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

batchGetDocumentsSettings

public com.google.api.gax.rpc.ServerStreamingCallSettings.Builder<BatchGetDocumentsRequest,BatchGetDocumentsResponse> batchGetDocumentsSettings()

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

beginTransactionSettings

public com.google.api.gax.rpc.UnaryCallSettings.Builder<BeginTransactionRequest,BeginTransactionResponse> beginTransactionSettings()

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

commitSettings

public com.google.api.gax.rpc.UnaryCallSettings.Builder<CommitRequest,CommitResponse> commitSettings()

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

rollbackSettings

public com.google.api.gax.rpc.UnaryCallSettings.Builder<RollbackRequest,com.google.protobuf.Empty> rollbackSettings()

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

runQuerySettings

public com.google.api.gax.rpc.ServerStreamingCallSettings.Builder<RunQueryRequest,RunQueryResponse> runQuerySettings()

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

runAggregationQuerySettings

public com.google.api.gax.rpc.ServerStreamingCallSettings.Builder<RunAggregationQueryRequest,RunAggregationQueryResponse> runAggregationQuerySettings()

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

partitionQuerySettings

public com.google.api.gax.rpc.PagedCallSettings.Builder<PartitionQueryRequest,PartitionQueryResponse,FirestoreClient.PartitionQueryPagedResponse> partitionQuerySettings()

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

writeSettings

public com.google.api.gax.rpc.StreamingCallSettings.Builder<WriteRequest,WriteResponse> writeSettings()

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

listenSettings

public com.google.api.gax.rpc.StreamingCallSettings.Builder<ListenRequest,ListenResponse> listenSettings()

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

listCollectionIdsSettings

public com.google.api.gax.rpc.PagedCallSettings.Builder<ListCollectionIdsRequest,ListCollectionIdsResponse,FirestoreClient.ListCollectionIdsPagedResponse> listCollectionIdsSettings()

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

batchWriteSettings

public com.google.api.gax.rpc.UnaryCallSettings.Builder<BatchWriteRequest,BatchWriteResponse> batchWriteSettings()

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

createDocumentSettings

public com.google.api.gax.rpc.UnaryCallSettings.Builder<CreateDocumentRequest,Document> createDocumentSettings()

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

build

public FirestoreSettings build()
                        throws IOException

Specified by:

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

Throws:

IOException