Package akka.javasdk.testkit

Interface ObjectStorageBucketConfig

public interface ObjectStorageBucketConfig

Configuration for a named object-storage bucket used in integration tests / dev mode.

Use the static factory methods to create configurations for the different backend types:

• filesystem(String) / filesystem(String, String) — local filesystem, always available without any cloud credentials.
• s3(String, String, String, S3Credentials) — Amazon S3 or an S3-compatible service (e.g. MinIO started via Testcontainers).
• gcs(String, String, GcsCredentials) — Google Cloud Storage.

Pass instances to TestKit.Settings.withObjectStorageBucket(ObjectStorageBucketConfig).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ObjectStorageBucketConfig.GcsCredentials	Credentials for a GCS-backed bucket.
static final class	ObjectStorageBucketConfig.GcsServiceAccountKeyCredentials	GCS service-account key file credentials.
static enum	ObjectStorageBucketConfig.GcsWorkloadIdentity	GCP Application Default Credentials (workload identity / ADC).
static final class	ObjectStorageBucketConfig.Impl	Not part of the public API.
static interface	ObjectStorageBucketConfig.S3Credentials	Credentials for an S3-backed bucket.
static final class	ObjectStorageBucketConfig.S3ProfileCredentials	AWS named-profile credentials (reads from ~/.aws/credentials).
static final class	ObjectStorageBucketConfig.S3StaticCredentials	Static AWS credentials (access key + secret).
static enum	ObjectStorageBucketConfig.S3WorkloadIdentity	AWS workload-identity / instance-profile credentials.

Method Summary

Modifier and Type	Method	Description
static ObjectStorageBucketConfig	filesystem(String name)	Filesystem-backed bucket.
static ObjectStorageBucketConfig	filesystem(String name, String directory)	Filesystem-backed bucket with an explicit storage directory.
static ObjectStorageBucketConfig	gcs(String name, String bucket, ObjectStorageBucketConfig.GcsCredentials credentials)	GCS-backed bucket (Google Cloud Storage).
String	name()	The logical bucket name as used in SDK calls.
static ObjectStorageBucketConfig	s3(String name, String bucket, String region, ObjectStorageBucketConfig.S3Credentials credentials)	S3-backed bucket (Amazon S3 or S3-compatible, e.g.

Method Details

name

String name()

The logical bucket name as used in SDK calls.

filesystem

static ObjectStorageBucketConfig filesystem(String name)

Filesystem-backed bucket. Objects are stored under <dev-base-directory>/<name>.

Parameters:

name - logical bucket name

filesystem

static ObjectStorageBucketConfig filesystem(String name,
 String directory)

Filesystem-backed bucket with an explicit storage directory.

Parameters:

name - logical bucket name

directory - absolute path to the directory where objects are stored

s3

static ObjectStorageBucketConfig s3(String name,
 String bucket,
 String region,
 ObjectStorageBucketConfig.S3Credentials credentials)

S3-backed bucket (Amazon S3 or S3-compatible, e.g. MinIO).

Parameters:

name - logical bucket name

bucket - actual S3 bucket name in the cloud / local service

region - AWS region, e.g. "us-east-1"

credentials - credentials to authenticate with S3

gcs

static ObjectStorageBucketConfig gcs(String name,
 String bucket,
 ObjectStorageBucketConfig.GcsCredentials credentials)

GCS-backed bucket (Google Cloud Storage).

Parameters:

name - logical bucket name

bucket - actual GCS bucket name

credentials - credentials to authenticate with GCS