ClientOverrideConfiguration (AWS SDK for Java

ClientOverrideConfiguration (AWS SDK for Java - 2.25.21)java.lang.Object

software.amazon.awssdk.core.client.config.ClientOverrideConfiguration

All Implemented Interfaces:
ToCopyableBuilder<ClientOverrideConfiguration.Builder,ClientOverrideConfiguration>

Configuration values for which the client already provides sensible defaults. All values are optional, and not specifying them will use optimal values defined by the service itself.

Use builder() to create a set of options.

  • Nested Class Summary

    Nested Classes

    static interface 

  • Method Summary

    Load the optional requested advanced option that was configured on the client builder.

    The amount of time to wait for the http request to complete before giving up and timing out.

    The amount of time to allow the client to complete the execution of an API call.

    The compression configuration object, which includes options to enable/disable compression and set the minimum compression threshold.

    The profile file that should be used by default for all profile-based configuration in the SDK client.

    The profile file supplier that should be used by default for all profile-based configuration in the SDK client.

    The profile name that should be used by default for all profile-based configuration in the SDK client.

    Returns the additional execution attributes to be added for this client.

    An immutable collection of ExecutionInterceptors that should be hooked into the execution of each request, in the order that they should be applied.

    An unmodifiable representation of the set of HTTP headers that should be sent with every request.

    The metric publishers to use to publisher metrics collected for this client.

    The optional retry policy that should be used when handling failure cases.

    The optional scheduled executor service that should be used for scheduling tasks such as async retry attempts and timeout task.

    Take this object and create a builder that contains all of the current property values of this object.

  • Method Details

    • toBuilder

      Take this object and create a builder that contains all of the current property values of this object.

      Specified by:
      toBuilder in interface ToCopyableBuilder<ClientOverrideConfiguration.Builder,ClientOverrideConfiguration>
      Returns:
      a builder for type T
    • builder

    • retryPolicy

      The optional retry policy that should be used when handling failure cases.

      See Also:
    • advancedOption

      Load the optional requested advanced option that was configured on the client builder.

      See Also:
    • executionInterceptors

      An immutable collection of ExecutionInterceptors that should be hooked into the execution of each request, in the order that they should be applied.
    • scheduledExecutorService

      The optional scheduled executor service that should be used for scheduling tasks such as async retry attempts and timeout task.

      The SDK will not automatically close the executor when the client is closed. It is the responsibility of the user to manually close the executor once all clients utilizing it have been closed.

    • apiCallTimeout

      The amount of time to allow the client to complete the execution of an API call. This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. This value should always be positive, if present.

      The api call timeout feature doesn't have strict guarantees on how quickly a request is aborted when the timeout is breached. The typical case aborts the request within a few milliseconds but there may occasionally be requests that don't get aborted until several seconds after the timer has been breached. Because of this, the client execution timeout feature should not be used when absolute precision is needed.

      This may be used together with apiCallAttemptTimeout() to enforce both a timeout on each individual HTTP request (i.e. each retry) and the total time spent on all requests across retries (i.e. the 'api call' time).

      See Also:
    • apiCallAttemptTimeout

      The amount of time to wait for the http request to complete before giving up and timing out. This value should always be positive, if present.

      The request timeout feature doesn't have strict guarantees on how quickly a request is aborted when the timeout is breached. The typical case aborts the request within a few milliseconds but there may occasionally be requests that don't get aborted until several seconds after the timer has been breached. Because of this, the request timeout feature should not be used when absolute precision is needed.

      This may be used together with apiCallTimeout() to enforce both a timeout on each individual HTTP request (i.e. each retry) and the total time spent on all requests across retries (i.e. the 'api call' time).

      See Also:
    • defaultProfileFileSupplier

      The profile file supplier that should be used by default for all profile-based configuration in the SDK client.

      See Also:
    • defaultProfileFile

      The profile file that should be used by default for all profile-based configuration in the SDK client.

      See Also:
    • defaultProfileName

      The profile name that should be used by default for all profile-based configuration in the SDK client.

      See Also:
    • metricPublishers

      The metric publishers to use to publisher metrics collected for this client.

      Returns:
      The metric publisher.
    • executionAttributes

      Returns the additional execution attributes to be added for this client.

    • compressionConfiguration

      The compression configuration object, which includes options to enable/disable compression and set the minimum compression threshold.

      See Also:
    • toString

      Overrides:
      toString in class Object

You Might Also Like