Class DbClusterSummary

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

Describes a summary of a Timestream for InfluxDB cluster.

See Also:

  • Method Details

    • id

      public final String id()

      Service-generated unique identifier of the DB cluster to retrieve.

      Returns:
      Service-generated unique identifier of the DB cluster to retrieve.

    • name

      public final String name()

      Customer supplied name of the Timestream for InfluxDB cluster.

      Returns:
      Customer supplied name of the Timestream for InfluxDB cluster.

    • arn

      public final String arn()

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

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

    • status

      public final ClusterStatus status()

      The status of the DB cluster.

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

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

    • statusAsString

      public final String statusAsString()

      The status of the DB cluster.

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

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

    • endpoint

      public final String endpoint()

      The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.

      Returns:
      The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.

    • readerEndpoint

      public final String readerEndpoint()

      The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.

      Returns:
      The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.

    • port

      public final Integer port()

      The port number on which InfluxDB accepts connections.

      Returns:
      The port number on which InfluxDB accepts connections.

    • deploymentType

      public final ClusterDeploymentType deploymentType()

      Deployment type of the DB cluster

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

      Returns:
      Deployment type of the DB cluster
      See Also:

    • deploymentTypeAsString

      public final String deploymentTypeAsString()

      Deployment type of the DB cluster

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

      Returns:
      Deployment type of the DB cluster
      See Also:

    • dbInstanceType

      public final DbInstanceType dbInstanceType()

      The Timestream for InfluxDB DB instance type that InfluxDB runs 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 DB instance type that InfluxDB runs on.
      See Also:

    • dbInstanceTypeAsString

      public final String dbInstanceTypeAsString()

      The Timestream for InfluxDB DB instance type that InfluxDB runs 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 DB instance type that InfluxDB runs on.
      See Also:

    • networkType

      public final NetworkType networkType()

      Specifies whether the network type of the Timestream for InfluxDB Cluster 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 network type of the Timestream for InfluxDB Cluster 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 network type of the Timestream for InfluxDB Cluster 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 network type of the Timestream for InfluxDB Cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
      See Also:

    • dbStorageType

      public final DbStorageType dbStorageType()

      The Timestream for InfluxDB DB storage type that InfluxDB stores data on.

      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 Timestream for InfluxDB DB storage type that InfluxDB stores data on.
      See Also:

    • dbStorageTypeAsString

      public final String dbStorageTypeAsString()

      The Timestream for InfluxDB DB storage type that InfluxDB stores data on.

      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 Timestream for InfluxDB DB storage type that InfluxDB stores data on.
      See Also:

    • allocatedStorage

      public final Integer allocatedStorage()

      The amount of storage allocated for your DB storage type (in gibibytes).

      Returns:
      The amount of storage allocated for your DB storage type (in gibibytes).

    • toBuilder

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

    • builder

      public static DbClusterSummary.Builder builder()

    • serializableBuilderClass

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