Class DbInstanceSummary

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

Contains a summary of a DB instance.

See Also:

  • Method Details

    • id

      public final String id()

      The service-generated unique identifier of the DB instance.

      Returns:
      The service-generated unique identifier of the DB instance.

    • name

      public final String name()

      This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.

      Returns:
      This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the DB instance.

      Returns:
      The Amazon Resource Name (ARN) of the DB instance.

    • status

      public final Status status()

      The status of the DB instance.

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

      Returns:
      The status of the DB instance.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the DB instance.

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

      Returns:
      The status of the DB instance.
      See Also:

    • endpoint

      public final String endpoint()

      The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

      Returns:
      The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

    • port

      public final Integer port()

      The port number on which InfluxDB accepts connections.

      Returns:
      The port number on which InfluxDB accepts connections.

    • networkType

      public final NetworkType networkType()

      Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

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

      Returns:
      Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
      See Also:

    • networkTypeAsString

      public final String networkTypeAsString()

      Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

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

      Returns:
      Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
      See Also:

    • dbInstanceType

      public final DbInstanceType dbInstanceType()

      The Timestream for InfluxDB instance type to run InfluxDB on.

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

      Returns:
      The Timestream for InfluxDB instance type to run InfluxDB on.
      See Also:

    • dbInstanceTypeAsString

      public final String dbInstanceTypeAsString()

      The Timestream for InfluxDB instance type to run InfluxDB on.

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

      Returns:
      The Timestream for InfluxDB instance type to run InfluxDB on.
      See Also:

    • dbStorageType

      public final DbStorageType dbStorageType()

      The storage type for your DB instance.

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

      Returns:
      The storage type for your DB instance.
      See Also:

    • dbStorageTypeAsString

      public final String dbStorageTypeAsString()

      The storage type for your DB instance.

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

      Returns:
      The storage type for your DB instance.
      See Also:

    • allocatedStorage

      public final Integer allocatedStorage()

      The amount of storage to allocate for your DbStorageType in GiB (gibibytes).

      Returns:
      The amount of storage to allocate for your DbStorageType in GiB (gibibytes).

    • deploymentType

      public final DeploymentType deploymentType()

      Single-Instance or with a MultiAZ Standby for High availability.

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

      Returns:
      Single-Instance or with a MultiAZ Standby for High availability.
      See Also:

    • deploymentTypeAsString

      public final String deploymentTypeAsString()

      Single-Instance or with a MultiAZ Standby for High availability.

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

      Returns:
      Single-Instance or with a MultiAZ Standby for High availability.
      See Also:

    • toBuilder

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

    • builder

      public static DbInstanceSummary.Builder builder()

    • serializableBuilderClass

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