public class FirestoreStubSettings extends StubSettings<FirestoreStubSettings>Settings class to configure an instance of FirestoreStub.
The default instance has everything set to sensible defaults:
- The default service address (firestore.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getDocument to 30 seconds:
FirestoreStubSettings.Builder firestoreSettingsBuilder = FirestoreStubSettings.newBuilder();
firestoreSettingsBuilder
.getDocumentSettings()
.setRetrySettings(
firestoreSettingsBuilder
.getDocumentSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
FirestoreStubSettings firestoreSettings = firestoreSettingsBuilder.build();
Static Methods
defaultApiClientHeaderProviderBuilder()
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()| Type | Description |
| Builder |
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()Returns a builder for the default credentials for this service.
| Type | Description |
| Builder |
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service.
| Type | Description |
| Builder |
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()Returns a builder for the default ChannelProvider for this service.
| Type | Description |
| Builder |
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()| Type | Description |
| TransportChannelProvider |
getDefaultEndpoint()
public static String getDefaultEndpoint()Returns the default service endpoint.
| Type | Description |
| String |
getDefaultMtlsEndpoint()
public static String getDefaultMtlsEndpoint()Returns the default mTLS service endpoint.
| Type | Description |
| String |
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()Returns the default service scopes.
| Type | Description |
| List<String> |
newBuilder()
public static FirestoreStubSettings.Builder newBuilder()Returns a new builder for this class.
| Type | Description |
| FirestoreStubSettings.Builder |
newBuilder(ClientContext clientContext)
public static FirestoreStubSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Name | Description |
| clientContext | ClientContext |
| Type | Description |
| FirestoreStubSettings.Builder |
Constructors
FirestoreStubSettings(FirestoreStubSettings.Builder settingsBuilder)
protected FirestoreStubSettings(FirestoreStubSettings.Builder settingsBuilder)| Name | Description |
| settingsBuilder | FirestoreStubSettings.Builder |
Methods
batchGetDocumentsSettings()
public ServerStreamingCallSettings<BatchGetDocumentsRequest,BatchGetDocumentsResponse> batchGetDocumentsSettings()Returns the object with the settings used for calls to batchGetDocuments.
| Type | Description |
| ServerStreamingCallSettings<BatchGetDocumentsRequest,BatchGetDocumentsResponse> |
batchWriteSettings()
public UnaryCallSettings<BatchWriteRequest,BatchWriteResponse> batchWriteSettings()Returns the object with the settings used for calls to batchWrite.
| Type | Description |
| UnaryCallSettings<BatchWriteRequest,BatchWriteResponse> |
beginTransactionSettings()
public UnaryCallSettings<BeginTransactionRequest,BeginTransactionResponse> beginTransactionSettings()Returns the object with the settings used for calls to beginTransaction.
| Type | Description |
| UnaryCallSettings<BeginTransactionRequest,BeginTransactionResponse> |
commitSettings()
public UnaryCallSettings<CommitRequest,CommitResponse> commitSettings()Returns the object with the settings used for calls to commit.
| Type | Description |
| UnaryCallSettings<CommitRequest,CommitResponse> |
createDocumentSettings()
public UnaryCallSettings<CreateDocumentRequest,Document> createDocumentSettings()Returns the object with the settings used for calls to createDocument.
| Type | Description |
| UnaryCallSettings<CreateDocumentRequest,Document> |
createStub()
public FirestoreStub createStub()| Type | Description |
| FirestoreStub |
| Type | Description |
| IOException |
deleteDocumentSettings()
public UnaryCallSettings<DeleteDocumentRequest,Empty> deleteDocumentSettings()Returns the object with the settings used for calls to deleteDocument.
| Type | Description |
| UnaryCallSettings<DeleteDocumentRequest,Empty> |
getDocumentSettings()
public UnaryCallSettings<GetDocumentRequest,Document> getDocumentSettings()Returns the object with the settings used for calls to getDocument.
| Type | Description |
| UnaryCallSettings<GetDocumentRequest,Document> |
listCollectionIdsSettings()
public PagedCallSettings<ListCollectionIdsRequest,ListCollectionIdsResponse,FirestoreClient.ListCollectionIdsPagedResponse> listCollectionIdsSettings()Returns the object with the settings used for calls to listCollectionIds.
| Type | Description |
| PagedCallSettings<ListCollectionIdsRequest,ListCollectionIdsResponse,ListCollectionIdsPagedResponse> |
listDocumentsSettings()
public PagedCallSettings<ListDocumentsRequest,ListDocumentsResponse,FirestoreClient.ListDocumentsPagedResponse> listDocumentsSettings()Returns the object with the settings used for calls to listDocuments.
| Type | Description |
| PagedCallSettings<ListDocumentsRequest,ListDocumentsResponse,ListDocumentsPagedResponse> |
listenSettings()
public StreamingCallSettings<ListenRequest,ListenResponse> listenSettings()Returns the object with the settings used for calls to listen.
| Type | Description |
| StreamingCallSettings<ListenRequest,ListenResponse> |
partitionQuerySettings()
public PagedCallSettings<PartitionQueryRequest,PartitionQueryResponse,FirestoreClient.PartitionQueryPagedResponse> partitionQuerySettings()Returns the object with the settings used for calls to partitionQuery.
| Type | Description |
| PagedCallSettings<PartitionQueryRequest,PartitionQueryResponse,PartitionQueryPagedResponse> |
rollbackSettings()
public UnaryCallSettings<RollbackRequest,Empty> rollbackSettings()Returns the object with the settings used for calls to rollback.
| Type | Description |
| UnaryCallSettings<RollbackRequest,Empty> |
runQuerySettings()
public ServerStreamingCallSettings<RunQueryRequest,RunQueryResponse> runQuerySettings()Returns the object with the settings used for calls to runQuery.
| Type | Description |
| ServerStreamingCallSettings<RunQueryRequest,RunQueryResponse> |
toBuilder()
public FirestoreStubSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Type | Description |
| FirestoreStubSettings.Builder |
updateDocumentSettings()
public UnaryCallSettings<UpdateDocumentRequest,Document> updateDocumentSettings()Returns the object with the settings used for calls to updateDocument.
| Type | Description |
| UnaryCallSettings<UpdateDocumentRequest,Document> |
writeSettings()
public StreamingCallSettings<WriteRequest,WriteResponse> writeSettings()Returns the object with the settings used for calls to write.
| Type | Description |
| StreamingCallSettings<WriteRequest,WriteResponse> |