Package software.amazon.awssdk.services.finspacedata.model

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetDatasetResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	alias()	The unique resource identifier for a Dataset.
static GetDatasetResponse.Builder	builder()
Long	createTime()	The timestamp at which the Dataset was created in FinSpace.
String	datasetArn()	The ARN identifier of the Dataset.
String	datasetDescription()	A description of the Dataset.
String	datasetId()	The unique identifier for a Dataset.
String	datasetTitle()	Display title for a Dataset.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
DatasetKind	kind()	The format in which Dataset data is structured.
String	kindAsString()	The format in which Dataset data is structured.
Long	lastModifiedTime()	The last time that the Dataset was modified.
SchemaUnion	schemaDefinition()	Definition for a schema on a tabular Dataset.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetDatasetResponse.Builder>	serializableBuilderClass()
DatasetStatus	status()	Status of the Dataset creation.
String	statusAsString()	Status of the Dataset creation.
GetDatasetResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.finspacedata.model.FinspaceDataResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

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:

DatasetKind

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:

DatasetKind

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:

DatasetStatus

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:

DatasetStatus

toBuilder

public GetDatasetResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetDatasetResponse.Builder,GetDatasetResponse>

Specified by:

toBuilder in class AwsResponse

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)

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)

Overrides:

getValueForField in class SdkResponse

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