Package com.google.cloud.recommender.v1
Class RecommenderSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<RecommenderSettings>
com.google.cloud.recommender.v1.RecommenderSettings
@Generated("by gapic-generator-java")
public class RecommenderSettings
extends ClientSettings<RecommenderSettings>
Settings class to configure an instance of
RecommenderClient.
The default instance has everything set to sensible defaults:
- The default service address (recommender.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 getInsight:
// 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
RecommenderSettings.Builder recommenderSettingsBuilder = RecommenderSettings.newBuilder();
recommenderSettingsBuilder
.getInsightSettings()
.setRetrySettings(
recommenderSettingsBuilder
.getInsightSettings()
.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());
RecommenderSettings recommenderSettings = recommenderSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
retries.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for RecommenderSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedRecommenderSettings(RecommenderSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final RecommenderSettingsReturns 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 TransportChannelProviderstatic StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getInsight.Returns the object with the settings used for calls to getInsightTypeConfig.Returns the object with the settings used for calls to getRecommendation.Returns the object with the settings used for calls to getRecommenderConfig.PagedCallSettings<ListInsightsRequest,ListInsightsResponse, RecommenderClient.ListInsightsPagedResponse> Returns the object with the settings used for calls to listInsights.PagedCallSettings<ListRecommendationsRequest,ListRecommendationsResponse, RecommenderClient.ListRecommendationsPagedResponse> Returns the object with the settings used for calls to listRecommendations.Returns the object with the settings used for calls to markInsightAccepted.Returns the object with the settings used for calls to markRecommendationClaimed.Returns the object with the settings used for calls to markRecommendationDismissed.Returns the object with the settings used for calls to markRecommendationFailed.Returns the object with the settings used for calls to markRecommendationSucceeded.static RecommenderSettings.BuilderReturns a new gRPC builder for this class.static RecommenderSettings.BuildernewBuilder(ClientContext clientContext) Returns a new builder for this class.static RecommenderSettings.BuilderReturns a new REST builder for this class.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateInsightTypeConfig.Returns the object with the settings used for calls to updateRecommenderConfig.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
-
RecommenderSettings
- Throws:
IOException
-
-
Method Details
-
listInsightsSettings
public PagedCallSettings<ListInsightsRequest,ListInsightsResponse, listInsightsSettings()RecommenderClient.ListInsightsPagedResponse> Returns the object with the settings used for calls to listInsights. -
getInsightSettings
Returns the object with the settings used for calls to getInsight. -
markInsightAcceptedSettings
Returns the object with the settings used for calls to markInsightAccepted. -
listRecommendationsSettings
public PagedCallSettings<ListRecommendationsRequest,ListRecommendationsResponse, listRecommendationsSettings()RecommenderClient.ListRecommendationsPagedResponse> Returns the object with the settings used for calls to listRecommendations. -
getRecommendationSettings
Returns the object with the settings used for calls to getRecommendation. -
markRecommendationDismissedSettings
public UnaryCallSettings<MarkRecommendationDismissedRequest,Recommendation> markRecommendationDismissedSettings()Returns the object with the settings used for calls to markRecommendationDismissed. -
markRecommendationClaimedSettings
public UnaryCallSettings<MarkRecommendationClaimedRequest,Recommendation> markRecommendationClaimedSettings()Returns the object with the settings used for calls to markRecommendationClaimed. -
markRecommendationSucceededSettings
public UnaryCallSettings<MarkRecommendationSucceededRequest,Recommendation> markRecommendationSucceededSettings()Returns the object with the settings used for calls to markRecommendationSucceeded. -
markRecommendationFailedSettings
public UnaryCallSettings<MarkRecommendationFailedRequest,Recommendation> markRecommendationFailedSettings()Returns the object with the settings used for calls to markRecommendationFailed. -
getRecommenderConfigSettings
public UnaryCallSettings<GetRecommenderConfigRequest,RecommenderConfig> getRecommenderConfigSettings()Returns the object with the settings used for calls to getRecommenderConfig. -
updateRecommenderConfigSettings
public UnaryCallSettings<UpdateRecommenderConfigRequest,RecommenderConfig> updateRecommenderConfigSettings()Returns the object with the settings used for calls to updateRecommenderConfig. -
getInsightTypeConfigSettings
public UnaryCallSettings<GetInsightTypeConfigRequest,InsightTypeConfig> getInsightTypeConfigSettings()Returns the object with the settings used for calls to getInsightTypeConfig. -
updateInsightTypeConfigSettings
public UnaryCallSettings<UpdateInsightTypeConfigRequest,InsightTypeConfig> updateInsightTypeConfigSettings()Returns the object with the settings used for calls to updateInsightTypeConfig. -
create
- 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<RecommenderSettings>
-