Class GetDatasetResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.finspacedata.model.FinspaceDataResponse
software.amazon.awssdk.services.finspacedata.model.GetDatasetResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetDatasetResponse.Builder,GetDatasetResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetDatasetResponse extends FinspaceDataResponse implements ToCopyableBuilder<GetDatasetResponse.Builder,GetDatasetResponse>
Response for the GetDataset operation

  • Method Details

    • datasetId

      public final String datasetId()

      The unique identifier for a Dataset.

      Returns:
      The unique identifier for a Dataset.

    • datasetArn

      public final String datasetArn()

      The ARN identifier of the Dataset.

      Returns:
      The ARN identifier of the Dataset.

    • datasetTitle

      public final String datasetTitle()

      Display title for a Dataset.

      Returns:
      Display title for a Dataset.

    • kind

      public final DatasetKind kind()

      The format in which Dataset data is structured.

      • TABULAR – Data is structured in a tabular format.

      • NON_TABULAR – Data is structured in a non-tabular format.

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

      Returns:
      The format in which Dataset data is structured.

      • TABULAR – Data is structured in a tabular format.

      • NON_TABULAR – Data is structured in a non-tabular format.

      See Also:

    • kindAsString

      public final String kindAsString()

      The format in which Dataset data is structured.

      • TABULAR – Data is structured in a tabular format.

      • NON_TABULAR – Data is structured in a non-tabular format.

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

      Returns:
      The format in which Dataset data is structured.

      • TABULAR – Data is structured in a tabular format.

      • NON_TABULAR – Data is structured in a non-tabular format.

      See Also:

    • datasetDescription

      public final String datasetDescription()

      A description of the Dataset.

      Returns:
      A description of the Dataset.

    • createTime

      public final Long createTime()

      The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      Returns:
      The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

    • lastModifiedTime

      public final Long lastModifiedTime()

      The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      Returns:
      The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

    • schemaDefinition

      public final SchemaUnion schemaDefinition()

      Definition for a schema on a tabular Dataset.

      Returns:
      Definition for a schema on a tabular Dataset.

    • alias

      public final String alias()

      The unique resource identifier for a Dataset.

      Returns:
      The unique resource identifier for a Dataset.

    • status

      public final DatasetStatus status()

      Status of the Dataset creation.

      • PENDING – Dataset is pending creation.

      • FAILED – Dataset creation has failed.

      • SUCCESS – Dataset creation has succeeded.

      • RUNNING – Dataset creation is running.

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

      Returns:
      Status of the Dataset creation.

      • PENDING – Dataset is pending creation.

      • FAILED – Dataset creation has failed.

      • SUCCESS – Dataset creation has succeeded.

      • RUNNING – Dataset creation is running.

      See Also:

    • statusAsString

      public final String statusAsString()

      Status of the Dataset creation.

      • PENDING – Dataset is pending creation.

      • FAILED – Dataset creation has failed.

      • SUCCESS – Dataset creation has succeeded.

      • RUNNING – Dataset creation is running.

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

      Returns:
      Status of the Dataset creation.

      • PENDING – Dataset is pending creation.

      • FAILED – Dataset creation has failed.

      • SUCCESS – Dataset creation has succeeded.

      • RUNNING – Dataset creation is running.

      See Also:

    • toBuilder

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

    • builder

      public static GetDatasetResponse.Builder builder()

    • serializableBuilderClass

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