public class FirestoreAdminStubSettings extends StubSettings<FirestoreAdminStubSettings>
Settings class to configure an instance of FirestoreAdminStub.
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 getIndex 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
FirestoreAdminStubSettings.Builder firestoreAdminSettingsBuilder =
FirestoreAdminStubSettings.newBuilder();
firestoreAdminSettingsBuilder
.getIndexSettings()
.setRetrySettings(
firestoreAdminSettingsBuilder.getIndexSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
FirestoreAdminStubSettings firestoreAdminSettings = firestoreAdminSettingsBuilder.build();
Static Methods
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
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()
Returns
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.
public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()
Returns
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 FirestoreAdminStubSettings.Builder newBuilder()
Returns a new gRPC builder for this class.
newBuilder(ClientContext clientContext)
public static FirestoreAdminStubSettings.Builder newBuilder(ClientContext clientContext)
Returns a new builder for this class.
newHttpJsonBuilder()
public static FirestoreAdminStubSettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
Constructors
FirestoreAdminStubSettings(FirestoreAdminStubSettings.Builder settingsBuilder)
protected FirestoreAdminStubSettings(FirestoreAdminStubSettings.Builder settingsBuilder)
Parameter
Methods
createIndexOperationSettings()
public OperationCallSettings<CreateIndexRequest,Index,IndexOperationMetadata> createIndexOperationSettings()
Returns the object with the settings used for calls to createIndex.
createIndexSettings()
public UnaryCallSettings<CreateIndexRequest,Operation> createIndexSettings()
Returns the object with the settings used for calls to createIndex.
createStub()
public FirestoreAdminStub createStub()
Returns
Exceptions
deleteIndexSettings()
public UnaryCallSettings<DeleteIndexRequest,Empty> deleteIndexSettings()
Returns the object with the settings used for calls to deleteIndex.
exportDocumentsOperationSettings()
public OperationCallSettings<ExportDocumentsRequest,ExportDocumentsResponse,ExportDocumentsMetadata> exportDocumentsOperationSettings()
Returns the object with the settings used for calls to exportDocuments.
exportDocumentsSettings()
public UnaryCallSettings<ExportDocumentsRequest,Operation> exportDocumentsSettings()
Returns the object with the settings used for calls to exportDocuments.
getDatabaseSettings()
public UnaryCallSettings<GetDatabaseRequest,Database> getDatabaseSettings()
Returns the object with the settings used for calls to getDatabase.
getFieldSettings()
public UnaryCallSettings<GetFieldRequest,Field> getFieldSettings()
Returns the object with the settings used for calls to getField.
getIndexSettings()
public UnaryCallSettings<GetIndexRequest,Index> getIndexSettings()
Returns the object with the settings used for calls to getIndex.
importDocumentsOperationSettings()
public OperationCallSettings<ImportDocumentsRequest,Empty,ImportDocumentsMetadata> importDocumentsOperationSettings()
Returns the object with the settings used for calls to importDocuments.
importDocumentsSettings()
public UnaryCallSettings<ImportDocumentsRequest,Operation> importDocumentsSettings()
Returns the object with the settings used for calls to importDocuments.
listDatabasesSettings()
public UnaryCallSettings<ListDatabasesRequest,ListDatabasesResponse> listDatabasesSettings()
Returns the object with the settings used for calls to listDatabases.
listFieldsSettings()
public PagedCallSettings<ListFieldsRequest,ListFieldsResponse,FirestoreAdminClient.ListFieldsPagedResponse> listFieldsSettings()
Returns the object with the settings used for calls to listFields.
listIndexesSettings()
public PagedCallSettings<ListIndexesRequest,ListIndexesResponse,FirestoreAdminClient.ListIndexesPagedResponse> listIndexesSettings()
Returns the object with the settings used for calls to listIndexes.
toBuilder()
public FirestoreAdminStubSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.
updateDatabaseOperationSettings()
public OperationCallSettings<UpdateDatabaseRequest,Database,UpdateDatabaseMetadata> updateDatabaseOperationSettings()
Returns the object with the settings used for calls to updateDatabase.
updateDatabaseSettings()
public UnaryCallSettings<UpdateDatabaseRequest,Operation> updateDatabaseSettings()
Returns the object with the settings used for calls to updateDatabase.
updateFieldOperationSettings()
public OperationCallSettings<UpdateFieldRequest,Field,FieldOperationMetadata> updateFieldOperationSettings()
Returns the object with the settings used for calls to updateField.
updateFieldSettings()
public UnaryCallSettings<UpdateFieldRequest,Operation> updateFieldSettings()
Returns the object with the settings used for calls to updateField.
