Class CompletionServiceStubSettings (2.4.0)

public class CompletionServiceStubSettings extends StubSettings<CompletionServiceStubSettings>

Settings class to configure an instance of CompletionServiceStub.

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 completeQuery to 30 seconds:


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

Inheritance

java.lang.Object > StubSettings > CompletionServiceStubSettings

Static Methods

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

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST 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

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static CompletionServiceStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
CompletionServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static CompletionServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
CompletionServiceStubSettings.Builder

newHttpJsonBuilder()

public static CompletionServiceStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
CompletionServiceStubSettings.Builder

Constructors

CompletionServiceStubSettings(CompletionServiceStubSettings.Builder settingsBuilder)

protected CompletionServiceStubSettings(CompletionServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderCompletionServiceStubSettings.Builder

Methods

completeQuerySettings()

public UnaryCallSettings<CompleteQueryRequest,CompleteQueryResponse> completeQuerySettings()

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

Returns
TypeDescription
UnaryCallSettings<CompleteQueryRequest,CompleteQueryResponse>

createStub()

public CompletionServiceStub createStub()
Returns
TypeDescription
CompletionServiceStub
Exceptions
TypeDescription
IOException

importCompletionDataOperationSettings()

public OperationCallSettings<ImportCompletionDataRequest,ImportCompletionDataResponse,ImportMetadata> importCompletionDataOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<ImportCompletionDataRequest,ImportCompletionDataResponse,ImportMetadata>

importCompletionDataSettings()

public UnaryCallSettings<ImportCompletionDataRequest,Operation> importCompletionDataSettings()

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

Returns
TypeDescription
UnaryCallSettings<ImportCompletionDataRequest,Operation>

toBuilder()

public CompletionServiceStubSettings.Builder toBuilder()

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

Returns
TypeDescription
CompletionServiceStubSettings.Builder
Overrides