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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
FirestoreStubSettings.Builder firestoreSettingsBuilder = FirestoreStubSettings.newBuilder();
firestoreSettingsBuilder
.getDocumentSettings()
.setRetrySettings(
firestoreSettingsBuilder
.getDocumentSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
FirestoreStubSettings firestoreSettings = firestoreSettingsBuilder.build();
Static Methods
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.
public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.
public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()
getDefaultEndpoint()
public static String getDefaultEndpoint()
Returns the default service endpoint.
getDefaultMtlsEndpoint()
public static String getDefaultMtlsEndpoint()
Returns the default mTLS service endpoint.
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()
Returns the default service scopes.
newBuilder()
public static FirestoreStubSettings.Builder newBuilder()
Returns a new gRPC builder for this class.
newBuilder(ClientContext clientContext)
public static FirestoreStubSettings.Builder newBuilder(ClientContext clientContext)
Returns a new builder for this class.
newHttpJsonBuilder()
public static FirestoreStubSettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
Constructors
FirestoreStubSettings(FirestoreStubSettings.Builder settingsBuilder)
protected FirestoreStubSettings(FirestoreStubSettings.Builder settingsBuilder)
Methods
batchGetDocumentsSettings()
public ServerStreamingCallSettings<BatchGetDocumentsRequest,BatchGetDocumentsResponse> batchGetDocumentsSettings()
Returns the object with the settings used for calls to batchGetDocuments.
batchWriteSettings()
public UnaryCallSettings<BatchWriteRequest,BatchWriteResponse> batchWriteSettings()
Returns the object with the settings used for calls to batchWrite.
beginTransactionSettings()
public UnaryCallSettings<BeginTransactionRequest,BeginTransactionResponse> beginTransactionSettings()
Returns the object with the settings used for calls to beginTransaction.
commitSettings()
public UnaryCallSettings<CommitRequest,CommitResponse> commitSettings()
Returns the object with the settings used for calls to commit.
createDocumentSettings()
public UnaryCallSettings<CreateDocumentRequest,Document> createDocumentSettings()
Returns the object with the settings used for calls to createDocument.
createStub()
public FirestoreStub createStub()
deleteDocumentSettings()
public UnaryCallSettings<DeleteDocumentRequest,Empty> deleteDocumentSettings()
Returns the object with the settings used for calls to deleteDocument.
getDocumentSettings()
public UnaryCallSettings<GetDocumentRequest,Document> getDocumentSettings()
Returns the object with the settings used for calls to getDocument.
getEndpoint()
public String getEndpoint()
Returns the endpoint set by the user or the the service's default endpoint.
getServiceName()
public String getServiceName()
Returns the default service name.
listCollectionIdsSettings()
public PagedCallSettings<ListCollectionIdsRequest,ListCollectionIdsResponse,FirestoreClient.ListCollectionIdsPagedResponse> listCollectionIdsSettings()
Returns the object with the settings used for calls to listCollectionIds.
listDocumentsSettings()
public PagedCallSettings<ListDocumentsRequest,ListDocumentsResponse,FirestoreClient.ListDocumentsPagedResponse> listDocumentsSettings()
Returns the object with the settings used for calls to listDocuments.
listenSettings()
public StreamingCallSettings<ListenRequest,ListenResponse> listenSettings()
Returns the object with the settings used for calls to listen.
partitionQuerySettings()
public PagedCallSettings<PartitionQueryRequest,PartitionQueryResponse,FirestoreClient.PartitionQueryPagedResponse> partitionQuerySettings()
Returns the object with the settings used for calls to partitionQuery.
rollbackSettings()
public UnaryCallSettings<RollbackRequest,Empty> rollbackSettings()
Returns the object with the settings used for calls to rollback.
runAggregationQuerySettings()
public ServerStreamingCallSettings<RunAggregationQueryRequest,RunAggregationQueryResponse> runAggregationQuerySettings()
Returns the object with the settings used for calls to runAggregationQuery.
runQuerySettings()
public ServerStreamingCallSettings<RunQueryRequest,RunQueryResponse> runQuerySettings()
Returns the object with the settings used for calls to runQuery.
toBuilder()
public FirestoreStubSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.
updateDocumentSettings()
public UnaryCallSettings<UpdateDocumentRequest,Document> updateDocumentSettings()
Returns the object with the settings used for calls to updateDocument.
writeSettings()
public StreamingCallSettings<WriteRequest,WriteResponse> writeSettings()
Returns the object with the settings used for calls to write.
