Class GetStreamResponse

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

The output of a retrieved stream.

  • Method Details

    • clusterIdentifier

      public final String clusterIdentifier()

      The ID of the cluster for the retrieved stream.

      Returns:
      The ID of the cluster for the retrieved stream.

    • streamIdentifier

      public final String streamIdentifier()

      The ID of the retrieved stream.

      Returns:
      The ID of the retrieved stream.

    • arn

      public final String arn()

      The ARN of the retrieved stream.

      Returns:
      The ARN of the retrieved stream.

    • status

      public final StreamStatus status()

      The current status of the retrieved stream.

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

      Returns:
      The current status of the retrieved stream.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the retrieved stream.

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

      Returns:
      The current status of the retrieved stream.
      See Also:

    • creationTime

      public final Instant creationTime()

      The time when the stream was created.

      Returns:
      The time when the stream was created.

    • ordering

      public final StreamOrdering ordering()

      The ordering mode of the stream.

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

      Returns:
      The ordering mode of the stream.
      See Also:

    • orderingAsString

      public final String orderingAsString()

      The ordering mode of the stream.

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

      Returns:
      The ordering mode of the stream.
      See Also:

    • format

      public final StreamFormat format()

      The format of the stream records.

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

      Returns:
      The format of the stream records.
      See Also:

    • formatAsString

      public final String formatAsString()

      The format of the stream records.

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

      Returns:
      The format of the stream records.
      See Also:

    • targetDefinition

      public final TargetDefinition targetDefinition()

      The target definition for the stream destination.

      Returns:
      The target definition for the stream destination.

    • statusReason

      public final StatusReason statusReason()

      Stream status reason with error code and timestamp (if applicable).

      Returns:
      Stream status reason with error code and timestamp (if applicable).

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      A map of tags associated with the stream.

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

      Returns:
      A map of tags associated with the stream.

    • toBuilder

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

    • builder

      public static GetStreamResponse.Builder builder()

    • serializableBuilderClass

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