Package 

Class BucketName

  • All Implemented Interfaces:
    @JvmInline() 
public final class BucketName

    Validating bucket name wrapper.

    Wraps a bucket name value and enforces the following validity rules:

    • Bucket names must be between 3 (min) and 63 (max) characters.

    • Bucket names must consist of only lowercase letters, numbers, dots (.), and hyphens (-).

    • Bucket names must begin and end with a letter or number.

    • Bucket names must not be formatted as an IP address (for example, 192.168.5.4).

    • Bucket names must not start with the prefix "xn--".

    • Bucket names must not end with the suffix "-s3alias".

    If any of the above are true, then the creation of this type will fail with an IllegalArgumentException.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public class BucketName.Companion

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private final String name

    • Constructor Summary

      Constructors 
      Constructor Description
      BucketName(String name) Tests the input string and creates a new BucketName instance.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final String getName()
      String toString()

      • Methods inherited from class java.lang.Object

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