com.google.cloud.firestore.v1

Class FirestoreSettings

java.lang.Object

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

com.google.cloud.firestore.v1.FirestoreSettings

@Generated(value="by gapic-generator-java")
public class FirestoreSettings
extends com.google.api.gax.rpc.ClientSettings<FirestoreSettings>

Settings class to configure an instance of FirestoreClient.

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
 FirestoreSettings.Builder firestoreSettingsBuilder = FirestoreSettings.newBuilder();
 firestoreSettingsBuilder
     .getDocumentSettings()
     .setRetrySettings(
         firestoreSettingsBuilder
             .getDocumentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 FirestoreSettings firestoreSettings = firestoreSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FirestoreSettings.Builder Builder for FirestoreSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FirestoreSettings(FirestoreSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.ServerStreamingCallSettings<BatchGetDocumentsRequest,BatchGetDocumentsResponse>	batchGetDocumentsSettings() Returns the object with the settings used for calls to batchGetDocuments.
com.google.api.gax.rpc.UnaryCallSettings<BatchWriteRequest,BatchWriteResponse>	batchWriteSettings() Returns the object with the settings used for calls to batchWrite.
com.google.api.gax.rpc.UnaryCallSettings<BeginTransactionRequest,BeginTransactionResponse>	beginTransactionSettings() Returns the object with the settings used for calls to beginTransaction.
com.google.api.gax.rpc.UnaryCallSettings<CommitRequest,CommitResponse>	commitSettings() Returns the object with the settings used for calls to commit.
static FirestoreSettings	create(FirestoreStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreateDocumentRequest,Document>	createDocumentSettings() Returns the object with the settings used for calls to createDocument.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DeleteDocumentRequest,com.google.protobuf.Empty>	deleteDocumentSettings() Returns the object with the settings used for calls to deleteDocument.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetDocumentRequest,Document>	getDocumentSettings() Returns the object with the settings used for calls to getDocument.
com.google.api.gax.rpc.PagedCallSettings<ListCollectionIdsRequest,ListCollectionIdsResponse,FirestoreClient.ListCollectionIdsPagedResponse>	listCollectionIdsSettings() Returns the object with the settings used for calls to listCollectionIds.
com.google.api.gax.rpc.PagedCallSettings<ListDocumentsRequest,ListDocumentsResponse,FirestoreClient.ListDocumentsPagedResponse>	listDocumentsSettings() Returns the object with the settings used for calls to listDocuments.
com.google.api.gax.rpc.StreamingCallSettings<ListenRequest,ListenResponse>	listenSettings() Returns the object with the settings used for calls to listen.
static FirestoreSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static FirestoreSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static FirestoreSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.PagedCallSettings<PartitionQueryRequest,PartitionQueryResponse,FirestoreClient.PartitionQueryPagedResponse>	partitionQuerySettings() Returns the object with the settings used for calls to partitionQuery.
com.google.api.gax.rpc.UnaryCallSettings<RollbackRequest,com.google.protobuf.Empty>	rollbackSettings() Returns the object with the settings used for calls to rollback.
com.google.api.gax.rpc.ServerStreamingCallSettings<RunAggregationQueryRequest,RunAggregationQueryResponse>	runAggregationQuerySettings() Returns the object with the settings used for calls to runAggregationQuery.
com.google.api.gax.rpc.ServerStreamingCallSettings<RunQueryRequest,RunQueryResponse>	runQuerySettings() Returns the object with the settings used for calls to runQuery.
FirestoreSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UpdateDocumentRequest,Document>	updateDocumentSettings() Returns the object with the settings used for calls to updateDocument.
com.google.api.gax.rpc.StreamingCallSettings<WriteRequest,WriteResponse>	writeSettings() Returns the object with the settings used for calls to write.

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

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FirestoreSettings

protected FirestoreSettings(FirestoreSettings.Builder settingsBuilder)
                     throws IOException

Throws:

IOException

Method Detail

getDocumentSettings

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

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

listDocumentsSettings

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

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

updateDocumentSettings

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

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

deleteDocumentSettings

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

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

batchGetDocumentsSettings

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

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

beginTransactionSettings

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

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

commitSettings

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

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

rollbackSettings

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

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

runQuerySettings

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

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

runAggregationQuerySettings

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

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

partitionQuerySettings

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

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

writeSettings

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

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

listenSettings

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

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

listCollectionIdsSettings

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

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

batchWriteSettings

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

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

createDocumentSettings

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

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

create

public static final FirestoreSettings create(FirestoreStubSettings stub)
                                      throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static FirestoreSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

@BetaApi
public static FirestoreSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static FirestoreSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public FirestoreSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<FirestoreSettings>