Class CompletionStubSettings

public class CompletionStubSettings extends StubSettings<CompletionStubSettings>

Settings class to configure an instance of CompletionStub.

The default instance has everything set to sensible defaults:

  • The default service address (jobs.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:


 CompletionStubSettings.Builder completionSettingsBuilder = CompletionStubSettings.newBuilder();
 completionSettingsBuilder
     .completeQuerySettings()
     .setRetrySettings(
         completionSettingsBuilder
             .completeQuerySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CompletionStubSettings completionSettings = completionSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > CompletionStubSettings

Constructors

CompletionStubSettings(CompletionStubSettings.Builder settingsBuilder)

protected CompletionStubSettings(CompletionStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderCompletionStubSettings.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 CompletionStub createStub()
Returns
TypeDescription
CompletionStub
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

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 CompletionStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
CompletionStubSettings.Builder

newBuilder(ClientContext clientContext)

public static CompletionStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
CompletionStubSettings.Builder

toBuilder()

public CompletionStubSettings.Builder toBuilder()

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

Returns
TypeDescription
CompletionStubSettings.Builder
Overrides