Class FeaturestoreServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<FeaturestoreServiceSettings>
com.google.cloud.aiplatform.v1beta1.FeaturestoreServiceSettings
@BetaApi
@Generated("by gapic-generator-java")
public class FeaturestoreServiceSettings
extends ClientSettings<FeaturestoreServiceSettings>
Settings class to configure an instance of
FeaturestoreServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (aiplatform.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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of getFeaturestore:
// 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
FeaturestoreServiceSettings.Builder featurestoreServiceSettingsBuilder =
FeaturestoreServiceSettings.newBuilder();
featurestoreServiceSettingsBuilder
.getFeaturestoreSettings()
.setRetrySettings(
featurestoreServiceSettingsBuilder
.getFeaturestoreSettings()
.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());
FeaturestoreServiceSettings featurestoreServiceSettings =
featurestoreServiceSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
retries.
To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createFeaturestore:
// 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
FeaturestoreServiceSettings.Builder featurestoreServiceSettingsBuilder =
FeaturestoreServiceSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
featurestoreServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for FeaturestoreServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedFeaturestoreServiceSettings(FeaturestoreServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionOperationCallSettings<BatchCreateFeaturesRequest,BatchCreateFeaturesResponse, BatchCreateFeaturesOperationMetadata> Returns the object with the settings used for calls to batchCreateFeatures.Returns the object with the settings used for calls to batchCreateFeatures.OperationCallSettings<BatchReadFeatureValuesRequest,BatchReadFeatureValuesResponse, BatchReadFeatureValuesOperationMetadata> Returns the object with the settings used for calls to batchReadFeatureValues.Returns the object with the settings used for calls to batchReadFeatureValues.static final FeaturestoreServiceSettingsReturns the object with the settings used for calls to createEntityType.Returns the object with the settings used for calls to createEntityType.Returns the object with the settings used for calls to createFeature.Returns the object with the settings used for calls to createFeature.Returns the object with the settings used for calls to createFeaturestore.Returns the object with the settings used for calls to createFeaturestore.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteEntityTypeRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteEntityType.Returns the object with the settings used for calls to deleteEntityType.OperationCallSettings<DeleteFeatureRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteFeature.Returns the object with the settings used for calls to deleteFeature.OperationCallSettings<DeleteFeaturestoreRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteFeaturestore.Returns the object with the settings used for calls to deleteFeaturestore.OperationCallSettings<DeleteFeatureValuesRequest,DeleteFeatureValuesResponse, DeleteFeatureValuesOperationMetadata> Returns the object with the settings used for calls to deleteFeatureValues.Returns the object with the settings used for calls to deleteFeatureValues.OperationCallSettings<ExportFeatureValuesRequest,ExportFeatureValuesResponse, ExportFeatureValuesOperationMetadata> Returns the object with the settings used for calls to exportFeatureValues.Returns the object with the settings used for calls to exportFeatureValues.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getEntityType.Returns the object with the settings used for calls to getFeature.Returns the object with the settings used for calls to getFeaturestore.Returns the object with the settings used for calls to getIamPolicy.Returns the object with the settings used for calls to getLocation.OperationCallSettings<ImportFeatureValuesRequest,ImportFeatureValuesResponse, ImportFeatureValuesOperationMetadata> Returns the object with the settings used for calls to importFeatureValues.Returns the object with the settings used for calls to importFeatureValues.PagedCallSettings<ListEntityTypesRequest,ListEntityTypesResponse, FeaturestoreServiceClient.ListEntityTypesPagedResponse> Returns the object with the settings used for calls to listEntityTypes.PagedCallSettings<ListFeaturesRequest,ListFeaturesResponse, FeaturestoreServiceClient.ListFeaturesPagedResponse> Returns the object with the settings used for calls to listFeatures.PagedCallSettings<ListFeaturestoresRequest,ListFeaturestoresResponse, FeaturestoreServiceClient.ListFeaturestoresPagedResponse> Returns the object with the settings used for calls to listFeaturestores.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, FeaturestoreServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.Returns a new builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.PagedCallSettings<SearchFeaturesRequest,SearchFeaturesResponse, FeaturestoreServiceClient.SearchFeaturesPagedResponse> Returns the object with the settings used for calls to searchFeatures.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateEntityType.Returns the object with the settings used for calls to updateFeature.Returns the object with the settings used for calls to updateFeaturestore.Returns the object with the settings used for calls to updateFeaturestore.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
FeaturestoreServiceSettings
protected FeaturestoreServiceSettings(FeaturestoreServiceSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
createFeaturestoreSettings
Returns the object with the settings used for calls to createFeaturestore. -
createFeaturestoreOperationSettings
public OperationCallSettings<CreateFeaturestoreRequest,Featurestore, createFeaturestoreOperationSettings()CreateFeaturestoreOperationMetadata> Returns the object with the settings used for calls to createFeaturestore. -
getFeaturestoreSettings
Returns the object with the settings used for calls to getFeaturestore. -
listFeaturestoresSettings
public PagedCallSettings<ListFeaturestoresRequest,ListFeaturestoresResponse, listFeaturestoresSettings()FeaturestoreServiceClient.ListFeaturestoresPagedResponse> Returns the object with the settings used for calls to listFeaturestores. -
updateFeaturestoreSettings
Returns the object with the settings used for calls to updateFeaturestore. -
updateFeaturestoreOperationSettings
public OperationCallSettings<UpdateFeaturestoreRequest,Featurestore, updateFeaturestoreOperationSettings()UpdateFeaturestoreOperationMetadata> Returns the object with the settings used for calls to updateFeaturestore. -
deleteFeaturestoreSettings
Returns the object with the settings used for calls to deleteFeaturestore. -
deleteFeaturestoreOperationSettings
public OperationCallSettings<DeleteFeaturestoreRequest,com.google.protobuf.Empty, deleteFeaturestoreOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteFeaturestore. -
createEntityTypeSettings
Returns the object with the settings used for calls to createEntityType. -
createEntityTypeOperationSettings
public OperationCallSettings<CreateEntityTypeRequest,EntityType, createEntityTypeOperationSettings()CreateEntityTypeOperationMetadata> Returns the object with the settings used for calls to createEntityType. -
getEntityTypeSettings
Returns the object with the settings used for calls to getEntityType. -
listEntityTypesSettings
public PagedCallSettings<ListEntityTypesRequest,ListEntityTypesResponse, listEntityTypesSettings()FeaturestoreServiceClient.ListEntityTypesPagedResponse> Returns the object with the settings used for calls to listEntityTypes. -
updateEntityTypeSettings
Returns the object with the settings used for calls to updateEntityType. -
deleteEntityTypeSettings
Returns the object with the settings used for calls to deleteEntityType. -
deleteEntityTypeOperationSettings
public OperationCallSettings<DeleteEntityTypeRequest,com.google.protobuf.Empty, deleteEntityTypeOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteEntityType. -
createFeatureSettings
Returns the object with the settings used for calls to createFeature. -
createFeatureOperationSettings
public OperationCallSettings<CreateFeatureRequest,Feature, createFeatureOperationSettings()CreateFeatureOperationMetadata> Returns the object with the settings used for calls to createFeature. -
batchCreateFeaturesSettings
Returns the object with the settings used for calls to batchCreateFeatures. -
batchCreateFeaturesOperationSettings
public OperationCallSettings<BatchCreateFeaturesRequest,BatchCreateFeaturesResponse, batchCreateFeaturesOperationSettings()BatchCreateFeaturesOperationMetadata> Returns the object with the settings used for calls to batchCreateFeatures. -
getFeatureSettings
Returns the object with the settings used for calls to getFeature. -
listFeaturesSettings
public PagedCallSettings<ListFeaturesRequest,ListFeaturesResponse, listFeaturesSettings()FeaturestoreServiceClient.ListFeaturesPagedResponse> Returns the object with the settings used for calls to listFeatures. -
updateFeatureSettings
Returns the object with the settings used for calls to updateFeature. -
deleteFeatureSettings
Returns the object with the settings used for calls to deleteFeature. -
deleteFeatureOperationSettings
public OperationCallSettings<DeleteFeatureRequest,com.google.protobuf.Empty, deleteFeatureOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteFeature. -
importFeatureValuesSettings
Returns the object with the settings used for calls to importFeatureValues. -
importFeatureValuesOperationSettings
public OperationCallSettings<ImportFeatureValuesRequest,ImportFeatureValuesResponse, importFeatureValuesOperationSettings()ImportFeatureValuesOperationMetadata> Returns the object with the settings used for calls to importFeatureValues. -
batchReadFeatureValuesSettings
Returns the object with the settings used for calls to batchReadFeatureValues. -
batchReadFeatureValuesOperationSettings
public OperationCallSettings<BatchReadFeatureValuesRequest,BatchReadFeatureValuesResponse, batchReadFeatureValuesOperationSettings()BatchReadFeatureValuesOperationMetadata> Returns the object with the settings used for calls to batchReadFeatureValues. -
exportFeatureValuesSettings
Returns the object with the settings used for calls to exportFeatureValues. -
exportFeatureValuesOperationSettings
public OperationCallSettings<ExportFeatureValuesRequest,ExportFeatureValuesResponse, exportFeatureValuesOperationSettings()ExportFeatureValuesOperationMetadata> Returns the object with the settings used for calls to exportFeatureValues. -
deleteFeatureValuesSettings
Returns the object with the settings used for calls to deleteFeatureValues. -
deleteFeatureValuesOperationSettings
public OperationCallSettings<DeleteFeatureValuesRequest,DeleteFeatureValuesResponse, deleteFeatureValuesOperationSettings()DeleteFeatureValuesOperationMetadata> Returns the object with the settings used for calls to deleteFeatureValues. -
searchFeaturesSettings
public PagedCallSettings<SearchFeaturesRequest,SearchFeaturesResponse, searchFeaturesSettings()FeaturestoreServiceClient.SearchFeaturesPagedResponse> Returns the object with the settings used for calls to searchFeatures. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()FeaturestoreServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
create
public static final FeaturestoreServiceSettings create(FeaturestoreServiceStubSettings stub) throws IOException - Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<FeaturestoreServiceSettings>
-