Class FirestoreStubSettings (3.28.0) 

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 RetrySettings of getDocument:


 // 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()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 FirestoreStubSettings firestoreSettings = firestoreSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

Inheritance

java.lang.Object > StubSettings > FirestoreStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static FirestoreStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
FirestoreStubSettings.Builder

newBuilder(ClientContext clientContext)

public static FirestoreStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
FirestoreStubSettings.Builder

newHttpJsonBuilder()

public static FirestoreStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
FirestoreStubSettings.Builder

Constructors

FirestoreStubSettings(FirestoreStubSettings.Builder settingsBuilder)

protected FirestoreStubSettings(FirestoreStubSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder FirestoreStubSettings.Builder

Methods

batchGetDocumentsSettings()

public ServerStreamingCallSettings<BatchGetDocumentsRequest,BatchGetDocumentsResponse> batchGetDocumentsSettings()

Returns the object with the settings used for calls to batchGetDocuments.

Returns
Type Description
ServerStreamingCallSettings<BatchGetDocumentsRequest,BatchGetDocumentsResponse>

batchWriteSettings()

public UnaryCallSettings<BatchWriteRequest,BatchWriteResponse> batchWriteSettings()

Returns the object with the settings used for calls to batchWrite.

Returns
Type Description
UnaryCallSettings<BatchWriteRequest,BatchWriteResponse>

beginTransactionSettings()

public UnaryCallSettings<BeginTransactionRequest,BeginTransactionResponse> beginTransactionSettings()

Returns the object with the settings used for calls to beginTransaction.

Returns
Type Description
UnaryCallSettings<BeginTransactionRequest,BeginTransactionResponse>

commitSettings()

public UnaryCallSettings<CommitRequest,CommitResponse> commitSettings()

Returns the object with the settings used for calls to commit.

Returns
Type Description
UnaryCallSettings<CommitRequest,CommitResponse>

createDocumentSettings()

public UnaryCallSettings<CreateDocumentRequest,Document> createDocumentSettings()

Returns the object with the settings used for calls to createDocument.

Returns
Type Description
UnaryCallSettings<CreateDocumentRequest,Document>

createStub()

public FirestoreStub createStub()
Returns
Type Description
FirestoreStub
Exceptions
Type Description
IOException

deleteDocumentSettings()

public UnaryCallSettings<DeleteDocumentRequest,Empty> deleteDocumentSettings()

Returns the object with the settings used for calls to deleteDocument.

Returns
Type Description
UnaryCallSettings<DeleteDocumentRequest,Empty>

getDocumentSettings()

public UnaryCallSettings<GetDocumentRequest,Document> getDocumentSettings()

Returns the object with the settings used for calls to getDocument.

Returns
Type Description
UnaryCallSettings<GetDocumentRequest,Document>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

listCollectionIdsSettings()

public PagedCallSettings<ListCollectionIdsRequest,ListCollectionIdsResponse,FirestoreClient.ListCollectionIdsPagedResponse> listCollectionIdsSettings()

Returns the object with the settings used for calls to listCollectionIds.

Returns
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.

Returns
Type Description
PagedCallSettings<ListDocumentsRequest,ListDocumentsResponse,ListDocumentsPagedResponse>

listenSettings()

public StreamingCallSettings<ListenRequest,ListenResponse> listenSettings()

Returns the object with the settings used for calls to listen.

Returns
Type Description
StreamingCallSettings<ListenRequest,ListenResponse>

partitionQuerySettings()

public PagedCallSettings<PartitionQueryRequest,PartitionQueryResponse,FirestoreClient.PartitionQueryPagedResponse> partitionQuerySettings()

Returns the object with the settings used for calls to partitionQuery.

Returns
Type Description
PagedCallSettings<PartitionQueryRequest,PartitionQueryResponse,PartitionQueryPagedResponse>

rollbackSettings()

public UnaryCallSettings<RollbackRequest,Empty> rollbackSettings()

Returns the object with the settings used for calls to rollback.

Returns
Type Description
UnaryCallSettings<RollbackRequest,Empty>

runAggregationQuerySettings()

public ServerStreamingCallSettings<RunAggregationQueryRequest,RunAggregationQueryResponse> runAggregationQuerySettings()

Returns the object with the settings used for calls to runAggregationQuery.

Returns
Type Description
ServerStreamingCallSettings<RunAggregationQueryRequest,RunAggregationQueryResponse>

runQuerySettings()

public ServerStreamingCallSettings<RunQueryRequest,RunQueryResponse> runQuerySettings()

Returns the object with the settings used for calls to runQuery.

Returns
Type Description
ServerStreamingCallSettings<RunQueryRequest,RunQueryResponse>

toBuilder()

public FirestoreStubSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type Description
FirestoreStubSettings.Builder
Overrides

updateDocumentSettings()

public UnaryCallSettings<UpdateDocumentRequest,Document> updateDocumentSettings()

Returns the object with the settings used for calls to updateDocument.

Returns
Type Description
UnaryCallSettings<UpdateDocumentRequest,Document>

writeSettings()

public StreamingCallSettings<WriteRequest,WriteResponse> writeSettings()

Returns the object with the settings used for calls to write.

Returns
Type Description
StreamingCallSettings<WriteRequest,WriteResponse>