Class StorageInsightsSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<StorageInsightsSettings>
com.google.cloud.storageinsights.v1.StorageInsightsSettings
@Generated("by gapic-generator-java")
public class StorageInsightsSettings
extends ClientSettings<StorageInsightsSettings>
Settings class to configure an instance of
StorageInsightsClient.
The default instance has everything set to sensible defaults:
- The default service address (storageinsights.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 getReportConfig:
// 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
StorageInsightsSettings.Builder storageInsightsSettingsBuilder =
StorageInsightsSettings.newBuilder();
storageInsightsSettingsBuilder
.getReportConfigSettings()
.setRetrySettings(
storageInsightsSettingsBuilder
.getReportConfigSettings()
.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());
StorageInsightsSettings storageInsightsSettings = storageInsightsSettingsBuilder.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 createDatasetConfig:
// 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
StorageInsightsSettings.Builder storageInsightsSettingsBuilder =
StorageInsightsSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
storageInsightsSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for StorageInsightsSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedStorageInsightsSettings(StorageInsightsSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final StorageInsightsSettingsReturns the object with the settings used for calls to createDatasetConfig.Returns the object with the settings used for calls to createDatasetConfig.Returns the object with the settings used for calls to createReportConfig.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 gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteDatasetConfigRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteDatasetConfig.Returns the object with the settings used for calls to deleteDatasetConfig.UnaryCallSettings<DeleteReportConfigRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteReportConfig.Returns the object with the settings used for calls to getDatasetConfig.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getReportConfig.Returns the object with the settings used for calls to getReportDetail.Returns the object with the settings used for calls to linkDataset.Returns the object with the settings used for calls to linkDataset.PagedCallSettings<ListDatasetConfigsRequest,ListDatasetConfigsResponse, StorageInsightsClient.ListDatasetConfigsPagedResponse> Returns the object with the settings used for calls to listDatasetConfigs.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, StorageInsightsClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListReportConfigsRequest,ListReportConfigsResponse, StorageInsightsClient.ListReportConfigsPagedResponse> Returns the object with the settings used for calls to listReportConfigs.PagedCallSettings<ListReportDetailsRequest,ListReportDetailsResponse, StorageInsightsClient.ListReportDetailsPagedResponse> Returns the object with the settings used for calls to listReportDetails.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.Returns a builder containing all the values of this settings class.OperationCallSettings<UnlinkDatasetRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to unlinkDataset.Returns the object with the settings used for calls to unlinkDataset.Returns the object with the settings used for calls to updateDatasetConfig.Returns the object with the settings used for calls to updateDatasetConfig.Returns the object with the settings used for calls to updateReportConfig.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
-
StorageInsightsSettings
protected StorageInsightsSettings(StorageInsightsSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listReportConfigsSettings
public PagedCallSettings<ListReportConfigsRequest,ListReportConfigsResponse, listReportConfigsSettings()StorageInsightsClient.ListReportConfigsPagedResponse> Returns the object with the settings used for calls to listReportConfigs. -
getReportConfigSettings
Returns the object with the settings used for calls to getReportConfig. -
createReportConfigSettings
Returns the object with the settings used for calls to createReportConfig. -
updateReportConfigSettings
Returns the object with the settings used for calls to updateReportConfig. -
deleteReportConfigSettings
public UnaryCallSettings<DeleteReportConfigRequest,com.google.protobuf.Empty> deleteReportConfigSettings()Returns the object with the settings used for calls to deleteReportConfig. -
listReportDetailsSettings
public PagedCallSettings<ListReportDetailsRequest,ListReportDetailsResponse, listReportDetailsSettings()StorageInsightsClient.ListReportDetailsPagedResponse> Returns the object with the settings used for calls to listReportDetails. -
getReportDetailSettings
Returns the object with the settings used for calls to getReportDetail. -
listDatasetConfigsSettings
public PagedCallSettings<ListDatasetConfigsRequest,ListDatasetConfigsResponse, listDatasetConfigsSettings()StorageInsightsClient.ListDatasetConfigsPagedResponse> Returns the object with the settings used for calls to listDatasetConfigs. -
getDatasetConfigSettings
Returns the object with the settings used for calls to getDatasetConfig. -
createDatasetConfigSettings
Returns the object with the settings used for calls to createDatasetConfig. -
createDatasetConfigOperationSettings
public OperationCallSettings<CreateDatasetConfigRequest,DatasetConfig, createDatasetConfigOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createDatasetConfig. -
updateDatasetConfigSettings
Returns the object with the settings used for calls to updateDatasetConfig. -
updateDatasetConfigOperationSettings
public OperationCallSettings<UpdateDatasetConfigRequest,DatasetConfig, updateDatasetConfigOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateDatasetConfig. -
deleteDatasetConfigSettings
Returns the object with the settings used for calls to deleteDatasetConfig. -
deleteDatasetConfigOperationSettings
public OperationCallSettings<DeleteDatasetConfigRequest,com.google.protobuf.Empty, deleteDatasetConfigOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteDatasetConfig. -
linkDatasetSettings
Returns the object with the settings used for calls to linkDataset. -
linkDatasetOperationSettings
public OperationCallSettings<LinkDatasetRequest,LinkDatasetResponse, linkDatasetOperationSettings()OperationMetadata> Returns the object with the settings used for calls to linkDataset. -
unlinkDatasetSettings
Returns the object with the settings used for calls to unlinkDataset. -
unlinkDatasetOperationSettings
public OperationCallSettings<UnlinkDatasetRequest,com.google.protobuf.Empty, unlinkDatasetOperationSettings()OperationMetadata> Returns the object with the settings used for calls to unlinkDataset. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()StorageInsightsClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
create
public static final StorageInsightsSettings create(StorageInsightsStubSettings 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 gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST 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<StorageInsightsSettings>
-