Package software.amazon.awssdk.services.timestreaminfluxdb.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DbInstanceSummary.Builder

Method Summary

Modifier and Type	Method	Description
Integer	allocatedStorage()	The amount of storage to allocate for your DbStorageType in GiB (gibibytes).
String	arn()	The Amazon Resource Name (ARN) of the DB instance.
static DbInstanceSummary.Builder	builder()
DbInstanceType	dbInstanceType()	The Timestream for InfluxDB instance type to run InfluxDB on.
String	dbInstanceTypeAsString()	The Timestream for InfluxDB instance type to run InfluxDB on.
DbStorageType	dbStorageType()	The storage type for your DB instance.
String	dbStorageTypeAsString()	The storage type for your DB instance.
DeploymentType	deploymentType()	Single-Instance or with a MultiAZ Standby for High availability.
String	deploymentTypeAsString()	Single-Instance or with a MultiAZ Standby for High availability.
String	endpoint()	The endpoint used to connect to InfluxDB.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The service-generated unique identifier of the DB instance.
String	name()	This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands.
List<SdkField<?>>	sdkFields()
static Class<? extends DbInstanceSummary.Builder>	serializableBuilderClass()
Status	status()	The status of the DB instance.
String	statusAsString()	The status of the DB instance.
DbInstanceSummary.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()

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 AWS CLI commands.

Returns:

This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS 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:

Status

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:

Status

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.

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:

DbInstanceType

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:

DbInstanceType

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:

DbStorageType

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:

DbStorageType

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:

DeploymentType

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:

DeploymentType

toBuilder

public DbInstanceSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DbInstanceSummary.Builder,DbInstanceSummary>

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)

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