Class RecommenderSettings (2.2.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 total timeout of getInsight to 30 seconds:


 RecommenderSettings.Builder recommenderSettingsBuilder = RecommenderSettings.newBuilder();
 recommenderSettingsBuilder
     .getInsightSettings()
     .setRetrySettings(
         recommenderSettingsBuilder
             .getInsightSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 RecommenderSettings recommenderSettings = recommenderSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > RecommenderSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

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>

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>

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

ClientSettings<SettingsT>.<B>toBuilder()

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>