Class RecommenderSettings (2.55.0) 

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 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 for additional support in setting retries.

Inheritance

java.lang.Object > ClientSettings > RecommenderSettings

Static Methods

create(RecommenderStubSettings stub)

public static final RecommenderSettings create(RecommenderStubSettings stub)
Parameter
Name Description
stub RecommenderStubSettings
Returns
Type Description
RecommenderSettings
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 RecommenderSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
RecommenderSettings.Builder

newBuilder(ClientContext clientContext)

public static RecommenderSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
RecommenderSettings.Builder

newHttpJsonBuilder()

public static RecommenderSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
RecommenderSettings.Builder

Constructors

RecommenderSettings(RecommenderSettings.Builder settingsBuilder)

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

Methods

getInsightSettings()

public UnaryCallSettings<GetInsightRequest,Insight> getInsightSettings()

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

Returns
Type Description
UnaryCallSettings<GetInsightRequest,Insight>

getInsightTypeConfigSettings()

public UnaryCallSettings<GetInsightTypeConfigRequest,InsightTypeConfig> getInsightTypeConfigSettings()

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

Returns
Type Description
UnaryCallSettings<GetInsightTypeConfigRequest,InsightTypeConfig>

getRecommendationSettings()

public UnaryCallSettings<GetRecommendationRequest,Recommendation> getRecommendationSettings()

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

Returns
Type Description
UnaryCallSettings<GetRecommendationRequest,Recommendation>

getRecommenderConfigSettings()

public UnaryCallSettings<GetRecommenderConfigRequest,RecommenderConfig> getRecommenderConfigSettings()

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

Returns
Type Description
UnaryCallSettings<GetRecommenderConfigRequest,RecommenderConfig>

listInsightTypesSettings()

public PagedCallSettings<ListInsightTypesRequest,ListInsightTypesResponse,RecommenderClient.ListInsightTypesPagedResponse> listInsightTypesSettings()

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

Returns
Type Description
PagedCallSettings<ListInsightTypesRequest,ListInsightTypesResponse,ListInsightTypesPagedResponse>

listInsightsSettings()

public PagedCallSettings<ListInsightsRequest,ListInsightsResponse,RecommenderClient.ListInsightsPagedResponse> listInsightsSettings()

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

Returns
Type Description
PagedCallSettings<ListInsightsRequest,ListInsightsResponse,ListInsightsPagedResponse>

listRecommendationsSettings()

public PagedCallSettings<ListRecommendationsRequest,ListRecommendationsResponse,RecommenderClient.ListRecommendationsPagedResponse> listRecommendationsSettings()

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

Returns
Type Description
PagedCallSettings<ListRecommendationsRequest,ListRecommendationsResponse,ListRecommendationsPagedResponse>

listRecommendersSettings()

public PagedCallSettings<ListRecommendersRequest,ListRecommendersResponse,RecommenderClient.ListRecommendersPagedResponse> listRecommendersSettings()

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

Returns
Type Description
PagedCallSettings<ListRecommendersRequest,ListRecommendersResponse,ListRecommendersPagedResponse>

markInsightAcceptedSettings()

public UnaryCallSettings<MarkInsightAcceptedRequest,Insight> markInsightAcceptedSettings()

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

Returns
Type Description
UnaryCallSettings<MarkInsightAcceptedRequest,Insight>

markRecommendationClaimedSettings()

public UnaryCallSettings<MarkRecommendationClaimedRequest,Recommendation> markRecommendationClaimedSettings()

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

Returns
Type Description
UnaryCallSettings<MarkRecommendationClaimedRequest,Recommendation>

markRecommendationFailedSettings()

public UnaryCallSettings<MarkRecommendationFailedRequest,Recommendation> markRecommendationFailedSettings()

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

Returns
Type Description
UnaryCallSettings<MarkRecommendationFailedRequest,Recommendation>

markRecommendationSucceededSettings()

public UnaryCallSettings<MarkRecommendationSucceededRequest,Recommendation> markRecommendationSucceededSettings()

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

Returns
Type Description
UnaryCallSettings<MarkRecommendationSucceededRequest,Recommendation>

toBuilder()

public RecommenderSettings.Builder toBuilder()

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

Returns
Type Description
RecommenderSettings.Builder
Overrides

updateInsightTypeConfigSettings()

public UnaryCallSettings<UpdateInsightTypeConfigRequest,InsightTypeConfig> updateInsightTypeConfigSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateInsightTypeConfigRequest,InsightTypeConfig>

updateRecommenderConfigSettings()

public UnaryCallSettings<UpdateRecommenderConfigRequest,RecommenderConfig> updateRecommenderConfigSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateRecommenderConfigRequest,RecommenderConfig>