Class GetDbClusterResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.timestreaminfluxdb.model.TimestreamInfluxDbResponse
software.amazon.awssdk.services.timestreaminfluxdb.model.GetDbClusterResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetDbClusterResponse.Builder,GetDbClusterResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetDbClusterResponse extends TimestreamInfluxDbResponse implements ToCopyableBuilder<GetDbClusterResponse.Builder,GetDbClusterResponse>

  • 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 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 instance type that InfluxDB runs on.
      See Also:

    • dbInstanceTypeAsString

      public final String dbInstanceTypeAsString()

      The Timestream for InfluxDB 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 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).

    • publiclyAccessible

      public final Boolean publiclyAccessible()

      Indicates if the DB cluster has a public IP to facilitate access from outside the VPC.

      Returns:
      Indicates if the DB cluster has a public IP to facilitate access from outside the VPC.

    • dbParameterGroupIdentifier

      public final String dbParameterGroupIdentifier()

      The ID of the DB parameter group assigned to your DB cluster.

      Returns:
      The ID of the DB parameter group assigned to your DB cluster.

    • logDeliveryConfiguration

      public final LogDeliveryConfiguration logDeliveryConfiguration()

      Configuration for sending InfluxDB engine logs to send to specified S3 bucket.

      Returns:
      Configuration for sending InfluxDB engine logs to send to specified S3 bucket.

    • influxAuthParametersSecretArn

      public final String influxAuthParametersSecretArn()

      The Amazon Resource Name (ARN) of the Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.

      Returns:
      The Amazon Resource Name (ARN) of the Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.

    • hasVpcSubnetIds

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

    • vpcSubnetIds

      public final List<String> vpcSubnetIds()

      A list of VPC subnet IDs associated with the DB 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 hasVpcSubnetIds() method.

      Returns:
      A list of VPC subnet IDs associated with the DB cluster.

    • hasVpcSecurityGroupIds

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

    • vpcSecurityGroupIds

      public final List<String> vpcSecurityGroupIds()

      A list of VPC security group IDs associated with the DB 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 hasVpcSecurityGroupIds() method.

      Returns:
      A list of VPC security group IDs associated with the DB cluster.

    • failoverMode

      public final FailoverMode failoverMode()

      The configured failover mode for the DB cluster.

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

      Returns:
      The configured failover mode for the DB cluster.
      See Also:

    • failoverModeAsString

      public final String failoverModeAsString()

      The configured failover mode for the DB cluster.

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

      Returns:
      The configured failover mode for the DB cluster.
      See Also:

    • toBuilder

      public GetDbClusterResponse.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<GetDbClusterResponse.Builder,GetDbClusterResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetDbClusterResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetDbClusterResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.