Class SearchServiceSettings (2.1.0) 

public class SearchServiceSettings extends ClientSettings<SearchServiceSettings>

Settings class to configure an instance of SearchServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (retail.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 search to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 SearchServiceSettings.Builder searchServiceSettingsBuilder = SearchServiceSettings.newBuilder();
 searchServiceSettingsBuilder
     .searchSettings()
     .setRetrySettings(
         searchServiceSettingsBuilder
             .searchSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 SearchServiceSettings searchServiceSettings = searchServiceSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > SearchServiceSettings

Static Methods

create(SearchServiceStubSettings stub)

public static final SearchServiceSettings create(SearchServiceStubSettings stub)
Parameter
NameDescription
stubSearchServiceStubSettings
Returns
TypeDescription
SearchServiceSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static SearchServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
SearchServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static SearchServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
SearchServiceSettings.Builder

Constructors

SearchServiceSettings(SearchServiceSettings.Builder settingsBuilder)

protected SearchServiceSettings(SearchServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderSearchServiceSettings.Builder

Methods

searchSettings()

public PagedCallSettings<SearchRequest,SearchResponse,SearchServiceClient.SearchPagedResponse> searchSettings()

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

Returns
TypeDescription
PagedCallSettings<SearchRequest,SearchResponse,SearchPagedResponse>

toBuilder()

public SearchServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
SearchServiceSettings.Builder
Overrides