Package software.amazon.awssdk.services.redshiftserverless.model

Class Namespace

java.lang.Object
software.amazon.awssdk.services.redshiftserverless.model.Namespace
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Namespace.Builder,Namespace>
@Generated("software.amazon.awssdk:codegen") public final class Namespace extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Namespace.Builder,Namespace>

A collection of database objects and users.

See Also:

  • Method Details

    • adminPasswordSecretArn

      public final String adminPasswordSecretArn()

      The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.

      Returns:
      The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.

    • adminPasswordSecretKmsKeyId

      public final String adminPasswordSecretKmsKeyId()

      The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.

      Returns:
      The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.

    • adminUsername

      public final String adminUsername()

      The username of the administrator for the first database created in the namespace.

      Returns:
      The username of the administrator for the first database created in the namespace.

    • creationDate

      public final Instant creationDate()

      The date of when the namespace was created.

      Returns:
      The date of when the namespace was created.

    • dbName

      public final String dbName()

      The name of the first database created in the namespace.

      Returns:
      The name of the first database created in the namespace.

    • defaultIamRoleArn

      public final String defaultIamRoleArn()

      The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

    • hasIamRoles

      public final boolean hasIamRoles()
      For responses, this returns true if the service returned a value for the IamRoles property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • iamRoles

      public final List<String> iamRoles()

      A list of IAM roles to associate with the namespace.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIamRoles() method.

      Returns:
      A list of IAM roles to associate with the namespace.

    • kmsKeyId

      public final String kmsKeyId()

      The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

      Returns:
      The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

    • logExports

      public final List<LogExport> logExports()

      The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLogExports() method.

      Returns:
      The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.

    • hasLogExports

      public final boolean hasLogExports()
      For responses, this returns true if the service returned a value for the LogExports property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • logExportsAsStrings

      public final List<String> logExportsAsStrings()

      The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLogExports() method.

      Returns:
      The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.

    • namespaceArn

      public final String namespaceArn()

      The Amazon Resource Name (ARN) associated with a namespace.

      Returns:
      The Amazon Resource Name (ARN) associated with a namespace.

    • namespaceId

      public final String namespaceId()

      The unique identifier of a namespace.

      Returns:
      The unique identifier of a namespace.

    • namespaceName

      public final String namespaceName()

      The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

      Returns:
      The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

    • status

      public final NamespaceStatus status()

      The status of the namespace.

      If the service returns an enum value that is not available in the current SDK version, status will return NamespaceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the namespace.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the namespace.

      If the service returns an enum value that is not available in the current SDK version, status will return NamespaceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the namespace.
      See Also:

    • toBuilder

      public Namespace.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Namespace.Builder,Namespace>
      Returns:
      a builder for type T

    • builder

      public static Namespace.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Namespace.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.