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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DbClusterSummary.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Integer`	`allocatedStorage()`	The amount of storage allocated for your DB storage type (in gibibytes).
`String`	`arn()`	The Amazon Resource Name (ARN) of the DB cluster.
`static DbClusterSummary.Builder`	`builder()`
`DbInstanceType`	`dbInstanceType()`	The Timestream for InfluxDB DB instance type that InfluxDB runs on.
`String`	`dbInstanceTypeAsString()`	The Timestream for InfluxDB DB instance type that InfluxDB runs on.
`DbStorageType`	`dbStorageType()`	The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
`String`	`dbStorageTypeAsString()`	The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
`ClusterDeploymentType`	`deploymentType()`	Deployment type of the DB cluster
`String`	`deploymentTypeAsString()`	Deployment type of the DB cluster
`String`	`endpoint()`	The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`id()`	Service-generated unique identifier of the DB cluster to retrieve.
`String`	`name()`	Customer supplied name of the Timestream for InfluxDB cluster.
`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.
`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.
`Integer`	`port()`	The port number on which InfluxDB accepts connections.
`String`	`readerEndpoint()`	The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DbClusterSummary.Builder>`	`serializableBuilderClass()`
`ClusterStatus`	`status()`	The status of the DB cluster.
`String`	`statusAsString()`	The status of the DB cluster.
`DbClusterSummary.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    ClusterStatus
  - 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:
    
    ClusterStatus
  - 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:
    
    ClusterDeploymentType
  - 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:
    
    ClusterDeploymentType
  - 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:
    
    DbInstanceType
  - 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:
    
    DbInstanceType
  - 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:
    
    NetworkType
  - 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:
    
    NetworkType
  - 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:
    
    DbStorageType
  - 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:
    
    DbStorageType
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DbClusterSummary.Builder,DbClusterSummary>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class DbClusterSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

id

name

arn

status

statusAsString

endpoint

readerEndpoint

port

deploymentType

deploymentTypeAsString

dbInstanceType

dbInstanceTypeAsString

networkType

networkTypeAsString

dbStorageType

dbStorageTypeAsString

allocatedStorage

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField