Class KxEnvironment

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

The details of a kdb environment.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the kdb environment.

      Returns:
      The name of the kdb environment.

    • environmentId

      public final String environmentId()

      A unique identifier for the kdb environment.

      Returns:
      A unique identifier for the kdb environment.

    • awsAccountId

      public final String awsAccountId()

      The unique identifier of the AWS account in which you create the kdb environment.

      Returns:
      The unique identifier of the AWS account in which you create the kdb environment.

    • status

      public final EnvironmentStatus status()

      The status of the environment creation.

      • CREATE_REQUESTED – Environment creation has been requested.

      • CREATING – Environment is in the process of being created.

      • FAILED_CREATION – Environment creation has failed.

      • CREATED – Environment is successfully created and is currently active.

      • DELETE REQUESTED – Environment deletion has been requested.

      • DELETING – Environment is in the process of being deleted.

      • RETRY_DELETION – Initial environment deletion failed, system is reattempting delete.

      • DELETED – Environment has been deleted.

      • FAILED_DELETION – Environment deletion has failed.

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

      Returns:
      The status of the environment creation.

      • CREATE_REQUESTED – Environment creation has been requested.

      • CREATING – Environment is in the process of being created.

      • FAILED_CREATION – Environment creation has failed.

      • CREATED – Environment is successfully created and is currently active.

      • DELETE REQUESTED – Environment deletion has been requested.

      • DELETING – Environment is in the process of being deleted.

      • RETRY_DELETION – Initial environment deletion failed, system is reattempting delete.

      • DELETED – Environment has been deleted.

      • FAILED_DELETION – Environment deletion has failed.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the environment creation.

      • CREATE_REQUESTED – Environment creation has been requested.

      • CREATING – Environment is in the process of being created.

      • FAILED_CREATION – Environment creation has failed.

      • CREATED – Environment is successfully created and is currently active.

      • DELETE REQUESTED – Environment deletion has been requested.

      • DELETING – Environment is in the process of being deleted.

      • RETRY_DELETION – Initial environment deletion failed, system is reattempting delete.

      • DELETED – Environment has been deleted.

      • FAILED_DELETION – Environment deletion has failed.

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

      Returns:
      The status of the environment creation.

      • CREATE_REQUESTED – Environment creation has been requested.

      • CREATING – Environment is in the process of being created.

      • FAILED_CREATION – Environment creation has failed.

      • CREATED – Environment is successfully created and is currently active.

      • DELETE REQUESTED – Environment deletion has been requested.

      • DELETING – Environment is in the process of being deleted.

      • RETRY_DELETION – Initial environment deletion failed, system is reattempting delete.

      • DELETED – Environment has been deleted.

      • FAILED_DELETION – Environment deletion has failed.

      See Also:

    • tgwStatus

      public final TgwStatus tgwStatus()

      The status of the network configuration.

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

      Returns:
      The status of the network configuration.
      See Also:

    • tgwStatusAsString

      public final String tgwStatusAsString()

      The status of the network configuration.

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

      Returns:
      The status of the network configuration.
      See Also:

    • dnsStatus

      public final DnsStatus dnsStatus()

      The status of DNS configuration.

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

      Returns:
      The status of DNS configuration.
      See Also:

    • dnsStatusAsString

      public final String dnsStatusAsString()

      The status of DNS configuration.

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

      Returns:
      The status of DNS configuration.
      See Also:

    • errorMessage

      public final String errorMessage()

      Specifies the error message that appears if a flow fails.

      Returns:
      Specifies the error message that appears if a flow fails.

    • description

      public final String description()

      A description of the kdb environment.

      Returns:
      A description of the kdb environment.

    • environmentArn

      public final String environmentArn()

      The Amazon Resource Name (ARN) of your kdb environment.

      Returns:
      The Amazon Resource Name (ARN) of your kdb environment.

    • kmsKeyId

      public final String kmsKeyId()

      The unique identifier of the KMS key.

      Returns:
      The unique identifier of the KMS key.

    • dedicatedServiceAccountId

      public final String dedicatedServiceAccountId()

      A unique identifier for the AWS environment infrastructure account.

      Returns:
      A unique identifier for the AWS environment infrastructure account.

    • transitGatewayConfiguration

      public final TransitGatewayConfiguration transitGatewayConfiguration()

      Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.

      Returns:
      Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.

    • hasCustomDNSConfiguration

      public final boolean hasCustomDNSConfiguration()
      For responses, this returns true if the service returned a value for the CustomDNSConfiguration 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.

    • customDNSConfiguration

      public final List<CustomDNSServer> customDNSConfiguration()

      A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.

      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 hasCustomDNSConfiguration() method.

      Returns:
      A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.

    • creationTimestamp

      public final Instant creationTimestamp()

      The timestamp at which the kdb environment was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      Returns:
      The timestamp at which the kdb environment was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

    • updateTimestamp

      public final Instant updateTimestamp()

      The timestamp at which the kdb environment was modified in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      Returns:
      The timestamp at which the kdb environment was modified in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

    • hasAvailabilityZoneIds

      public final boolean hasAvailabilityZoneIds()
      For responses, this returns true if the service returned a value for the AvailabilityZoneIds 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.

    • availabilityZoneIds

      public final List<String> availabilityZoneIds()

      The identifier of the availability zones where subnets for the environment are created.

      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 hasAvailabilityZoneIds() method.

      Returns:
      The identifier of the availability zones where subnets for the environment are created.

    • certificateAuthorityArn

      public final String certificateAuthorityArn()

      The Amazon Resource Name (ARN) of the certificate authority:

      Returns:
      The Amazon Resource Name (ARN) of the certificate authority:

    • toBuilder

      public KxEnvironment.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<KxEnvironment.Builder,KxEnvironment>
      Returns:
      a builder for type T

    • builder

      public static KxEnvironment.Builder builder()

    • serializableBuilderClass

      public static Class<? extends KxEnvironment.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.