public class MetastoreServiceSettings extends ClientSettings<MetastoreServiceSettings>
Settings class to configure an instance of MetastoreServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (biglake.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 createCatalog:
// 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
MetastoreServiceSettings.Builder metastoreServiceSettingsBuilder =
MetastoreServiceSettings.newBuilder();
metastoreServiceSettingsBuilder
.createCatalogSettings()
.setRetrySettings(
metastoreServiceSettingsBuilder
.createCatalogSettings()
.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());
MetastoreServiceSettings metastoreServiceSettings = metastoreServiceSettingsBuilder.build();
Please refer to the Client Side Retry Guide for additional support in setting retries.
Static Methods
create(MetastoreServiceStubSettings stub)
public static final MetastoreServiceSettings create(MetastoreServiceStubSettings stub)
Parameter | |
---|---|
Name | Description |
stub |
MetastoreServiceStubSettings |
Returns | |
---|---|
Type | Description |
MetastoreServiceSettings |
Exceptions | |
---|---|
Type | Description |
IOException |
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 |
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.
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 |
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()
Returns the default service scopes.
Returns | |
---|---|
Type | Description |
List<String> |
newBuilder()
public static MetastoreServiceSettings.Builder newBuilder()
Returns a new gRPC builder for this class.
Returns | |
---|---|
Type | Description |
MetastoreServiceSettings.Builder |
newBuilder(ClientContext clientContext)
public static MetastoreServiceSettings.Builder newBuilder(ClientContext clientContext)
Returns a new builder for this class.
Parameter | |
---|---|
Name | Description |
clientContext |
ClientContext |
Returns | |
---|---|
Type | Description |
MetastoreServiceSettings.Builder |
newHttpJsonBuilder()
public static MetastoreServiceSettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
Returns | |
---|---|
Type | Description |
MetastoreServiceSettings.Builder |
Constructors
MetastoreServiceSettings(MetastoreServiceSettings.Builder settingsBuilder)
protected MetastoreServiceSettings(MetastoreServiceSettings.Builder settingsBuilder)
Parameter | |
---|---|
Name | Description |
settingsBuilder |
MetastoreServiceSettings.Builder |
Methods
createCatalogSettings()
public UnaryCallSettings<CreateCatalogRequest,Catalog> createCatalogSettings()
Returns the object with the settings used for calls to createCatalog.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<CreateCatalogRequest,Catalog> |
createDatabaseSettings()
public UnaryCallSettings<CreateDatabaseRequest,Database> createDatabaseSettings()
Returns the object with the settings used for calls to createDatabase.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<CreateDatabaseRequest,Database> |
createTableSettings()
public UnaryCallSettings<CreateTableRequest,Table> createTableSettings()
Returns the object with the settings used for calls to createTable.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<CreateTableRequest,Table> |
deleteCatalogSettings()
public UnaryCallSettings<DeleteCatalogRequest,Catalog> deleteCatalogSettings()
Returns the object with the settings used for calls to deleteCatalog.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<DeleteCatalogRequest,Catalog> |
deleteDatabaseSettings()
public UnaryCallSettings<DeleteDatabaseRequest,Database> deleteDatabaseSettings()
Returns the object with the settings used for calls to deleteDatabase.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<DeleteDatabaseRequest,Database> |
deleteTableSettings()
public UnaryCallSettings<DeleteTableRequest,Table> deleteTableSettings()
Returns the object with the settings used for calls to deleteTable.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<DeleteTableRequest,Table> |
getCatalogSettings()
public UnaryCallSettings<GetCatalogRequest,Catalog> getCatalogSettings()
Returns the object with the settings used for calls to getCatalog.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<GetCatalogRequest,Catalog> |
getDatabaseSettings()
public UnaryCallSettings<GetDatabaseRequest,Database> getDatabaseSettings()
Returns the object with the settings used for calls to getDatabase.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<GetDatabaseRequest,Database> |
getTableSettings()
public UnaryCallSettings<GetTableRequest,Table> getTableSettings()
Returns the object with the settings used for calls to getTable.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<GetTableRequest,Table> |
listCatalogsSettings()
public PagedCallSettings<ListCatalogsRequest,ListCatalogsResponse,MetastoreServiceClient.ListCatalogsPagedResponse> listCatalogsSettings()
Returns the object with the settings used for calls to listCatalogs.
Returns | |
---|---|
Type | Description |
PagedCallSettings<ListCatalogsRequest,ListCatalogsResponse,ListCatalogsPagedResponse> |
listDatabasesSettings()
public PagedCallSettings<ListDatabasesRequest,ListDatabasesResponse,MetastoreServiceClient.ListDatabasesPagedResponse> listDatabasesSettings()
Returns the object with the settings used for calls to listDatabases.
Returns | |
---|---|
Type | Description |
PagedCallSettings<ListDatabasesRequest,ListDatabasesResponse,ListDatabasesPagedResponse> |
listTablesSettings()
public PagedCallSettings<ListTablesRequest,ListTablesResponse,MetastoreServiceClient.ListTablesPagedResponse> listTablesSettings()
Returns the object with the settings used for calls to listTables.
Returns | |
---|---|
Type | Description |
PagedCallSettings<ListTablesRequest,ListTablesResponse,ListTablesPagedResponse> |
renameTableSettings()
public UnaryCallSettings<RenameTableRequest,Table> renameTableSettings()
Returns the object with the settings used for calls to renameTable.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<RenameTableRequest,Table> |
toBuilder()
public MetastoreServiceSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.
Returns | |
---|---|
Type | Description |
MetastoreServiceSettings.Builder |
updateDatabaseSettings()
public UnaryCallSettings<UpdateDatabaseRequest,Database> updateDatabaseSettings()
Returns the object with the settings used for calls to updateDatabase.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<UpdateDatabaseRequest,Database> |
updateTableSettings()
public UnaryCallSettings<UpdateTableRequest,Table> updateTableSettings()
Returns the object with the settings used for calls to updateTable.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<UpdateTableRequest,Table> |