Package io.camunda.zeebe.backup.s3

Record Class S3BackupConfig

java.lang.Object
java.lang.Record
io.camunda.zeebe.backup.s3.S3BackupConfig
Record Components:
bucketName - Name of the bucket that will be used for storing backups.
endpoint - URL for the S3 endpoint to connect to.
region - Name of the S3 region to use, will be parsed by Region.of(String). If no value is provided, the AWS SDK will try to discover an appropriate value from the environment.
credentials - If no value is provided, the AWS SDK will try to discover appropriate values from the environment.
apiCallTimeout - Used as the overall api call timeout for the AWS SDK. API calls that exceed the timeout may fail and result in failed backups.
forcePathStyleAccess - Forces the AWS SDK to always use paths for accessing the bucket. Off by default, which allows the AWS SDK to choose virtual-hosted-style bucket access.
compressionAlgorithm - Algorithm to use (if any) for compressing backup contents.
basePath - Prefix to use for all objects in this bucket. Must be non-empty and not start or end with '/'.
public record S3BackupConfig(String bucketName, Optional<String> endpoint, Optional<String> region, Optional<io.camunda.zeebe.backup.s3.S3BackupConfig.Credentials> credentials, Optional<Duration> apiCallTimeout, boolean forcePathStyleAccess, Optional<String> compressionAlgorithm, Optional<String> basePath) extends Record
Holds configuration for the S3 Backup Store.
See Also:

  • Constructor Details

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • bucketName

      public String bucketName()
      Returns the value of the bucketName record component.
      Returns:
      the value of the bucketName record component

    • endpoint

      public Optional<String> endpoint()
      Returns the value of the endpoint record component.
      Returns:
      the value of the endpoint record component

    • region

      public Optional<String> region()
      Returns the value of the region record component.
      Returns:
      the value of the region record component

    • credentials

      public Optional<io.camunda.zeebe.backup.s3.S3BackupConfig.Credentials> credentials()
      Returns the value of the credentials record component.
      Returns:
      the value of the credentials record component

    • apiCallTimeout

      public Optional<Duration> apiCallTimeout()
      Returns the value of the apiCallTimeout record component.
      Returns:
      the value of the apiCallTimeout record component

    • forcePathStyleAccess

      public boolean forcePathStyleAccess()
      Returns the value of the forcePathStyleAccess record component.
      Returns:
      the value of the forcePathStyleAccess record component

    • compressionAlgorithm

      public Optional<String> compressionAlgorithm()
      Returns the value of the compressionAlgorithm record component.
      Returns:
      the value of the compressionAlgorithm record component

    • basePath

      public Optional<String> basePath()
      Returns the value of the basePath record component.
      Returns:
      the value of the basePath record component