org.apache.beam.sdk.io.aws2.common

Class ClientConfiguration

java.lang.Object

org.apache.beam.sdk.io.aws2.common.ClientConfiguration

All Implemented Interfaces:

java.io.Serializable

public abstract class ClientConfiguration
extends java.lang.Object
implements java.io.Serializable

AWS client configuration.

AWS clients for all AWS IOs can be configured using AwsOptions, which provides reasonable defaults based on default providers of the AWS SDK.

ClientConfiguration is meant to override defaults for a specific IO, including RetryConfiguration. Retries are handled by the AWS SDK unless there's partial success. The SDK uses a backoff strategy with equal jitter for computing the delay before the next retry.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientConfiguration.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static ClientConfiguration	EMPTY

Constructor Summary

Constructors

Constructor and Description
ClientConfiguration()

Method Summary

Modifier and Type	Method and Description
static ClientConfiguration.Builder	builder()
static ClientConfiguration	create(AwsCredentialsProvider credentials, Region region, java.net.URI endpoint)
AwsCredentialsProvider	credentialsProvider() Optional AwsCredentialsProvider.
abstract java.net.URI	endpoint() Optional service endpoint to use AWS compatible services instead, e.g.
Region	region() Optional Region.
abstract RetryConfiguration	retry() Optional RetryConfiguration for AWS clients.
abstract ClientConfiguration.Builder	toBuilder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY

public static final ClientConfiguration EMPTY

Constructor Detail

ClientConfiguration

public ClientConfiguration()

Method Detail

credentialsProvider

@Memoized
 @Nullable
 @Pure
public AwsCredentialsProvider credentialsProvider()

Optional AwsCredentialsProvider. If set, this overwrites the default in AwsOptions.getAwsCredentialsProvider().

region

@Memoized
 @Nullable
 @Pure
public Region region()

Optional Region. If set, this overwrites the default in AwsOptions.getAwsRegion().

endpoint

@Nullable
 @Pure
public abstract java.net.URI endpoint()

Optional service endpoint to use AWS compatible services instead, e.g. for testing. If set, this overwrites the default in AwsOptions.getEndpoint().

retry

@Nullable
 @Pure
public abstract RetryConfiguration retry()

Optional RetryConfiguration for AWS clients. If unset, retry behavior will be unchanged and use SDK defaults.

toBuilder

public abstract ClientConfiguration.Builder toBuilder()

builder

public static ClientConfiguration.Builder builder()

create

public static ClientConfiguration create(AwsCredentialsProvider credentials,
                                         Region region,
                                         @Nullable
                                         java.net.URI endpoint)