Class OperationsStubSettings
- java.lang.Object
-
- com.google.api.gax.rpc.StubSettings<OperationsStubSettings>
-
- com.google.api.gax.httpjson.longrunning.stub.OperationsStubSettings
-
public class OperationsStubSettings extends StubSettings<OperationsStubSettings>
Settings class to configure an instance ofOperationsStub.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:
OperationsStubSettings.Builder operationsSettingsBuilder = OperationsStubSettings.newBuilder(); operationsSettingsBuilder .getOperationSettings() .setRetrySettings( operationsSettingsBuilder .getOperationSettings() .getRetrySettings() .toBuilder() .setTotalTimeout(Duration.ofSeconds(30)) .build()); OperationsStubSettings operationsSettings = operationsSettingsBuilder.build();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classOperationsStubSettings.BuilderBuilder for OperationsStubSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protectedOperationsStubSettings(OperationsStubSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description UnaryCallSettings<CancelOperationRequest,com.google.protobuf.Empty>cancelOperationSettings()Returns the object with the settings used for calls to cancel.OperationsStubcreateStub()static ApiClientHeaderProvider.BuilderdefaultApiClientHeaderProviderBuilder()static GoogleCredentialsProvider.BuilderdefaultCredentialsProviderBuilder()Returns a builder for the default credentials for this service.static InstantiatingExecutorProvider.BuilderdefaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service.static InstantiatingHttpJsonChannelProvider.BuilderdefaultHttpJsonTransportProviderBuilder()Returns a builder for the default ChannelProvider for this service.static TransportChannelProviderdefaultTransportChannelProvider()UnaryCallSettings<DeleteOperationRequest,com.google.protobuf.Empty>deleteOperationSettings()Returns the object with the settings used for calls to delete.static StringgetDefaultEndpoint()Returns the default service endpoint.static StringgetDefaultMtlsEndpoint()Returns the default mTLS service endpoint.static List<String>getDefaultServiceScopes()Returns the default service scopes.UnaryCallSettings<GetOperationRequest,Operation>getOperationSettings()Returns the object with the settings used for calls to get.PagedCallSettings<ListOperationsRequest,ListOperationsResponse,OperationsClient.ListOperationsPagedResponse>listOperationsSettings()Returns the object with the settings used for calls to listOperations.static OperationsStubSettings.BuildernewBuilder()Returns a new builder for this class.static OperationsStubSettings.BuildernewBuilder(ClientContext clientContext)Returns a new builder for this class.OperationsStubSettings.BuildertoBuilder()Returns a builder containing all the values of this settings class.-
Methods inherited from class com.google.api.gax.rpc.StubSettings
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, toString
-
-
-
-
Constructor Detail
-
OperationsStubSettings
protected OperationsStubSettings(OperationsStubSettings.Builder settingsBuilder) throws IOException
- Throws:
IOException
-
-
Method Detail
-
listOperationsSettings
public PagedCallSettings<ListOperationsRequest,ListOperationsResponse,OperationsClient.ListOperationsPagedResponse> listOperationsSettings()
Returns the object with the settings used for calls to listOperations.
-
getOperationSettings
public UnaryCallSettings<GetOperationRequest,Operation> 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.
-
createStub
public OperationsStub createStub() throws IOException
- Throws:
IOException
-
defaultExecutorProviderBuilder
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.
-
getDefaultEndpoint
public static String getDefaultEndpoint()
Returns the default service endpoint.
-
getDefaultMtlsEndpoint
public static String getDefaultMtlsEndpoint()
Returns the default mTLS service endpoint.
-
getDefaultServiceScopes
public static List<String> getDefaultServiceScopes()
Returns the default service scopes.
-
defaultCredentialsProviderBuilder
public static GoogleCredentialsProvider.Builder 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
public static TransportChannelProvider defaultTransportChannelProvider()
-
defaultApiClientHeaderProviderBuilder
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
-
newBuilder
public static OperationsStubSettings.Builder newBuilder()
Returns a new builder for this class.
-
newBuilder
public static OperationsStubSettings.Builder newBuilder(ClientContext clientContext)
Returns a new builder for this class.
-
toBuilder
public OperationsStubSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classStubSettings<OperationsStubSettings>
-
-