Package com.google.api.gax.httpjson.longrunning

Class OperationsSettings

  • @BetaApi
public class OperationsSettings
extends com.google.api.gax.rpc.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();

    • Method Detail

      • listOperationsSettings

        public com.google.api.gax.rpc.PagedCallSettings<com.google.longrunning.ListOperationsRequest,​com.google.longrunning.ListOperationsResponse,​OperationsClient.ListOperationsPagedResponse> listOperationsSettings()
        Returns the object with the settings used for calls to listOperations.

      • getOperationSettings

        public com.google.api.gax.rpc.UnaryCallSettings<com.google.longrunning.GetOperationRequest,​com.google.longrunning.Operation> getOperationSettings()
        Returns the object with the settings used for calls to get.

      • deleteOperationSettings

        public com.google.api.gax.rpc.UnaryCallSettings<com.google.longrunning.DeleteOperationRequest,​com.google.protobuf.Empty> deleteOperationSettings()
        Returns the object with the settings used for calls to delete.

      • cancelOperationSettings

        public com.google.api.gax.rpc.UnaryCallSettings<com.google.longrunning.CancelOperationRequest,​com.google.protobuf.Empty> cancelOperationSettings()
        Returns the object with the settings used for calls to cancel.

      • defaultExecutorProviderBuilder

        public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
        Returns a builder for the default ExecutorProvider for this service.

      • getDefaultEndpoint

        public static String getDefaultEndpoint()
        Returns the default service endpoint.

      • getDefaultServiceScopes

        public static List<String> getDefaultServiceScopes()
        Returns the default service scopes.

      • defaultCredentialsProviderBuilder

        public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
        Returns a builder for the default credentials for this service.

      • defaultTransportChannelProvider

        public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

      • defaultApiClientHeaderProviderBuilder

        public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

      • newBuilder

        public static OperationsSettings.Builder newBuilder​(com.google.api.gax.rpc.ClientContext clientContext)
        Returns a new builder for this class.

      • toBuilder

        public OperationsSettings.Builder toBuilder()
        Returns a builder containing all the values of this settings class.
        Specified by:
        toBuilder in class com.google.api.gax.rpc.ClientSettings<OperationsSettings>