Class OperationsSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<OperationsSettings>
com.google.api.gax.httpjson.longrunning.OperationsSettings
Settings class to configure an instance of
OperationsClient.
The default instance has everything set to sensible defaults:
- The default service address (longrunning.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 getOperation to 30 seconds:
OperationsSettings.Builder operationsSettingsBuilder = OperationsSettings.newBuilder();
operationsSettingsBuilder
.getOperationSettings()
.setRetrySettings(
operationsSettingsBuilder
.getOperationSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
OperationsSettings operationsSettings = operationsSettingsBuilder.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for OperationsSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedOperationsSettings(OperationsSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionUnaryCallSettings<CancelOperationRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to cancel.static final OperationsSettingscreate(OperationsStubSettings stub) Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default ChannelProvider for this service.static TransportChannelProviderUnaryCallSettings<DeleteOperationRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to delete.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to get.PagedCallSettings<ListOperationsRequest,ListOperationsResponse, OperationsClient.ListOperationsPagedResponse> Returns the object with the settings used for calls to listOperations.static OperationsSettings.BuilderReturns a new builder for this class.static OperationsSettings.BuildernewBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a builder containing all the values of this settings class.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
OperationsSettings
- Throws:
IOException
-
-
Method Details
-
listOperationsSettings
public PagedCallSettings<ListOperationsRequest,ListOperationsResponse, listOperationsSettings()OperationsClient.ListOperationsPagedResponse> Returns the object with the settings used for calls to listOperations. -
getOperationSettings
Returns the object with the settings used for calls to get. -
deleteOperationSettings
public UnaryCallSettings<DeleteOperationRequest,com.google.protobuf.Empty> deleteOperationSettings()Returns the object with the settings used for calls to delete. -
cancelOperationSettings
public UnaryCallSettings<CancelOperationRequest,com.google.protobuf.Empty> cancelOperationSettings()Returns the object with the settings used for calls to cancel. -
create
- Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultHttpJsonTransportProviderBuilder
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<OperationsSettings>
-