Class HiveMetastoreServiceStubSettings (0.76.0)

public class HiveMetastoreServiceStubSettings extends StubSettings<HiveMetastoreServiceStubSettings>

Settings class to configure an instance of HiveMetastoreServiceStub.

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 createHiveCatalog:


 // 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
 HiveMetastoreServiceStubSettings.Builder hiveMetastoreServiceSettingsBuilder =
     HiveMetastoreServiceStubSettings.newBuilder();
 hiveMetastoreServiceSettingsBuilder
     .createHiveCatalogSettings()
     .setRetrySettings(
         hiveMetastoreServiceSettingsBuilder
             .createHiveCatalogSettings()
             .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());
 HiveMetastoreServiceStubSettings hiveMetastoreServiceSettings =
     hiveMetastoreServiceSettingsBuilder.build();
 

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

Inheritance

java.lang.Object > StubSettings > HiveMetastoreServiceStubSettings

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 HiveMetastoreServiceStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
HiveMetastoreServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static HiveMetastoreServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
HiveMetastoreServiceStubSettings.Builder

newHttpJsonBuilder()

public static HiveMetastoreServiceStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
HiveMetastoreServiceStubSettings.Builder

Constructors

HiveMetastoreServiceStubSettings(HiveMetastoreServiceStubSettings.Builder settingsBuilder)

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

Methods

batchCreatePartitionsSettings()

public UnaryCallSettings<BatchCreatePartitionsRequest,BatchCreatePartitionsResponse> batchCreatePartitionsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchCreatePartitionsRequest,BatchCreatePartitionsResponse>

batchDeletePartitionsSettings()

public UnaryCallSettings<BatchDeletePartitionsRequest,Empty> batchDeletePartitionsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchDeletePartitionsRequest,Empty>

batchUpdatePartitionsSettings()

public UnaryCallSettings<BatchUpdatePartitionsRequest,BatchUpdatePartitionsResponse> batchUpdatePartitionsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchUpdatePartitionsRequest,BatchUpdatePartitionsResponse>

createHiveCatalogSettings()

public UnaryCallSettings<CreateHiveCatalogRequest,HiveCatalog> createHiveCatalogSettings()

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

Returns
Type Description
UnaryCallSettings<CreateHiveCatalogRequest,HiveCatalog>

createHiveDatabaseSettings()

public UnaryCallSettings<CreateHiveDatabaseRequest,HiveDatabase> createHiveDatabaseSettings()

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

Returns
Type Description
UnaryCallSettings<CreateHiveDatabaseRequest,HiveDatabase>

createHiveTableSettings()

public UnaryCallSettings<CreateHiveTableRequest,HiveTable> createHiveTableSettings()

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

Returns
Type Description
UnaryCallSettings<CreateHiveTableRequest,HiveTable>

createStub()

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

deleteHiveCatalogSettings()

public UnaryCallSettings<DeleteHiveCatalogRequest,Empty> deleteHiveCatalogSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteHiveCatalogRequest,Empty>

deleteHiveDatabaseSettings()

public UnaryCallSettings<DeleteHiveDatabaseRequest,Empty> deleteHiveDatabaseSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteHiveDatabaseRequest,Empty>

deleteHiveTableSettings()

public UnaryCallSettings<DeleteHiveTableRequest,Empty> deleteHiveTableSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteHiveTableRequest,Empty>

getHiveCatalogSettings()

public UnaryCallSettings<GetHiveCatalogRequest,HiveCatalog> getHiveCatalogSettings()

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

Returns
Type Description
UnaryCallSettings<GetHiveCatalogRequest,HiveCatalog>

getHiveDatabaseSettings()

public UnaryCallSettings<GetHiveDatabaseRequest,HiveDatabase> getHiveDatabaseSettings()

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

Returns
Type Description
UnaryCallSettings<GetHiveDatabaseRequest,HiveDatabase>

getHiveTableSettings()

public UnaryCallSettings<GetHiveTableRequest,HiveTable> getHiveTableSettings()

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

Returns
Type Description
UnaryCallSettings<GetHiveTableRequest,HiveTable>

getLibraryMetadata()

protected LibraryMetadata getLibraryMetadata()
Returns
Type Description
LibraryMetadata
Overrides

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

listHiveCatalogsSettings()

public PagedCallSettings<ListHiveCatalogsRequest,ListHiveCatalogsResponse,HiveMetastoreServiceClient.ListHiveCatalogsPagedResponse> listHiveCatalogsSettings()

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

Returns
Type Description
PagedCallSettings<ListHiveCatalogsRequest,ListHiveCatalogsResponse,ListHiveCatalogsPagedResponse>

listHiveDatabasesSettings()

public PagedCallSettings<ListHiveDatabasesRequest,ListHiveDatabasesResponse,HiveMetastoreServiceClient.ListHiveDatabasesPagedResponse> listHiveDatabasesSettings()

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

Returns
Type Description
PagedCallSettings<ListHiveDatabasesRequest,ListHiveDatabasesResponse,ListHiveDatabasesPagedResponse>

listHiveTablesSettings()

public PagedCallSettings<ListHiveTablesRequest,ListHiveTablesResponse,HiveMetastoreServiceClient.ListHiveTablesPagedResponse> listHiveTablesSettings()

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

Returns
Type Description
PagedCallSettings<ListHiveTablesRequest,ListHiveTablesResponse,ListHiveTablesPagedResponse>

listPartitionsSettings()

public ServerStreamingCallSettings<ListPartitionsRequest,ListPartitionsResponse> listPartitionsSettings()

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

Returns
Type Description
ServerStreamingCallSettings<ListPartitionsRequest,ListPartitionsResponse>

toBuilder()

public HiveMetastoreServiceStubSettings.Builder toBuilder()

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

Returns
Type Description
HiveMetastoreServiceStubSettings.Builder
Overrides

updateHiveCatalogSettings()

public UnaryCallSettings<UpdateHiveCatalogRequest,HiveCatalog> updateHiveCatalogSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateHiveCatalogRequest,HiveCatalog>

updateHiveDatabaseSettings()

public UnaryCallSettings<UpdateHiveDatabaseRequest,HiveDatabase> updateHiveDatabaseSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateHiveDatabaseRequest,HiveDatabase>

updateHiveTableSettings()

public UnaryCallSettings<UpdateHiveTableRequest,HiveTable> updateHiveTableSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateHiveTableRequest,HiveTable>