Class DbInstanceForClusterSummary

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

Contains a summary of a DB instance belonging to a DB cluster.

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()

      A service-generated name for the DB instance based on the customer-supplied name for the DB cluster.

      Returns:
      A service-generated name for the DB instance based on the customer-supplied name for the DB cluster.

    • 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 network type 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 network type 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 network type 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 network type 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 allocated for your DB storage type in GiB (gibibytes).

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

    • deploymentType

      public final DeploymentType deploymentType()

      Specifies the deployment type if applicable.

      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:
      Specifies the deployment type if applicable.
      See Also:

    • deploymentTypeAsString

      public final String deploymentTypeAsString()

      Specifies the deployment type if applicable.

      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:
      Specifies the deployment type if applicable.
      See Also:

    • instanceMode

      public final InstanceMode instanceMode()

      Specifies the DB instance's role in the cluster.

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

      Returns:
      Specifies the DB instance's role in the cluster.
      See Also:

    • instanceModeAsString

      public final String instanceModeAsString()

      Specifies the DB instance's role in the cluster.

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

      Returns:
      Specifies the DB instance's role in the cluster.
      See Also:

    • instanceModes

      public final List<InstanceMode> instanceModes()

      Specifies the DB instance's roles in the cluster.

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

      Returns:
      Specifies the DB instance's roles in the cluster.

    • hasInstanceModes

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

    • instanceModesAsStrings

      public final List<String> instanceModesAsStrings()

      Specifies the DB instance's roles in the cluster.

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

      Returns:
      Specifies the DB instance's roles in the cluster.

    • toBuilder

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

    • builder

      public static DbInstanceForClusterSummary.Builder builder()

    • serializableBuilderClass

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