Class OperationsSettings (2.23.2)

public class OperationsSettings extends ClientSettings<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();

Inheritance

java.lang.Object > ClientSettings > OperationsSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(OperationsStubSettings stub)

public static final OperationsSettings create(OperationsStubSettings stub)

Parameter

Name	Description
`stub`	`OperationsStubSettings`

Returns

Type	Description
`OperationsSettings`

Exceptions

Type	Description
`IOException`

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`

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns

Type	Description
`List<String>`

newBuilder()

public static OperationsSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
`OperationsSettings.Builder`

newBuilder(ClientContext clientContext)

public static OperationsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
`clientContext`	`ClientContext`

Returns

Type	Description
`OperationsSettings.Builder`

Constructors

OperationsSettings(OperationsSettings.Builder settingsBuilder)

protected OperationsSettings(OperationsSettings.Builder settingsBuilder)

Parameter

Name	Description
`settingsBuilder`	`OperationsSettings.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>`

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 OperationsSettings.Builder toBuilder()

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

Returns

Type	Description
`OperationsSettings.Builder`

Overrides

ClientSettings<SettingsT>.<B>toBuilder()