public class OperationsStubSettings extends StubSettings<OperationsStubSettings>Settings class to configure an instance of OperationsStub.
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();
Static Methods
defaultApiClientHeaderProviderBuilder()
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()| Returns | |
|---|---|
| Type | Description |
ApiClientHeaderProvider.Builder | |
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()Returns a builder for the default credentials for this service.
| Returns | |
|---|---|
| Type | Description |
GoogleCredentialsProvider.Builder | |
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service.
| Returns | |
|---|---|
| Type | Description |
InstantiatingExecutorProvider.Builder | |
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default ChannelProvider for this service.
| Returns | |
|---|---|
| Type | Description |
InstantiatingHttpJsonChannelProvider.Builder | |
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()| Returns | |
|---|---|
| Type | Description |
TransportChannelProvider | |
getDefaultEndpoint()
public static String getDefaultEndpoint()Returns the default service endpoint.
| Returns | |
|---|---|
| Type | Description |
String | |
getDefaultMtlsEndpoint()
public static String getDefaultMtlsEndpoint()Returns the default mTLS service endpoint.
| Returns | |
|---|---|
| Type | Description |
String | |
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()Returns the default service scopes.
| Returns | |
|---|---|
| Type | Description |
List<String> | |
newBuilder()
public static OperationsStubSettings.Builder newBuilder()Returns a new builder for this class.
| Returns | |
|---|---|
| Type | Description |
OperationsStubSettings.Builder | |
newBuilder(ClientContext clientContext)
public static OperationsStubSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext | ClientContext |
| Returns | |
|---|---|
| Type | Description |
OperationsStubSettings.Builder | |
Constructors
OperationsStubSettings(OperationsStubSettings.Builder settingsBuilder)
protected OperationsStubSettings(OperationsStubSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder | OperationsStubSettings.Builder |
Methods
cancelOperationSettings()
public UnaryCallSettings<CancelOperationRequest,Empty> cancelOperationSettings()Returns the object with the settings used for calls to cancel.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CancelOperationRequest,Empty> | |
createStub()
public OperationsStub createStub()| Returns | |
|---|---|
| Type | Description |
OperationsStub | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
deleteOperationSettings()
public UnaryCallSettings<DeleteOperationRequest,Empty> deleteOperationSettings()Returns the object with the settings used for calls to delete.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteOperationRequest,Empty> | |
getOperationSettings()
public UnaryCallSettings<GetOperationRequest,Operation> getOperationSettings()Returns the object with the settings used for calls to get.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetOperationRequest,Operation> | |
listOperationsSettings()
public PagedCallSettings<ListOperationsRequest,ListOperationsResponse,OperationsClient.ListOperationsPagedResponse> listOperationsSettings()Returns the object with the settings used for calls to listOperations.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListOperationsRequest,ListOperationsResponse,ListOperationsPagedResponse> | |
toBuilder()
public OperationsStubSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
OperationsStubSettings.Builder | |