software.amazon.awssdk.services.finspacedata.model

Class GetDataViewResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetDataViewResponse.Builder,GetDataViewResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetDataViewResponse
extends FinspaceDataResponse
implements ToCopyableBuilder<GetDataViewResponse.Builder,GetDataViewResponse>

Response from retrieving a dataview, which includes details on the target database and table name

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetDataViewResponse.Builder

Method Summary

Modifier and Type	Method and Description
Long	asOfTimestamp() Time range to use for the Dataview.
Boolean	autoUpdate() Flag to indicate Dataview should be updated automatically.
static GetDataViewResponse.Builder	builder()
Long	createTime() The timestamp at which the Dataview was created in FinSpace.
String	datasetId() The unique identifier for the Dataset used in the Dataview.
String	dataViewArn() The ARN identifier of the Dataview.
String	dataViewId() The unique identifier for the Dataview.
DataViewDestinationTypeParams	destinationTypeParams() Options that define the destination type for the Dataview.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
DataViewErrorInfo	errorInfo() Information about an error that occurred for the Dataview.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPartitionColumns() For responses, this returns true if the service returned a value for the PartitionColumns property.
boolean	hasSortColumns() For responses, this returns true if the service returned a value for the SortColumns property.
Long	lastModifiedTime() The last time that a Dataview was modified.
List<String>	partitionColumns() Ordered set of column names used to partition data.
List<SdkField<?>>	sdkFields()
static Class<? extends GetDataViewResponse.Builder>	serializableBuilderClass()
List<String>	sortColumns() Columns to be used for sorting the data.
DataViewStatus	status() The status of a Dataview creation.
String	statusAsString() The status of a Dataview creation.
GetDataViewResponse.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

autoUpdate

public final Boolean autoUpdate()

Flag to indicate Dataview should be updated automatically.

Returns:

Flag to indicate Dataview should be updated automatically.

hasPartitionColumns

public final boolean hasPartitionColumns()

For responses, this returns true if the service returned a value for the PartitionColumns 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.

partitionColumns

public final List<String> partitionColumns()

Ordered set of column names used to partition data.

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

Returns:

Ordered set of column names used to partition data.

datasetId

public final String datasetId()

The unique identifier for the Dataset used in the Dataview.

Returns:

The unique identifier for the Dataset used in the Dataview.

asOfTimestamp

public final Long asOfTimestamp()

Time range to use for the Dataview. 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:

Time range to use for the Dataview. 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.

errorInfo

public final DataViewErrorInfo errorInfo()

Information about an error that occurred for the Dataview.

Returns:

Information about an error that occurred for the Dataview.

lastModifiedTime

public final Long lastModifiedTime()

The last time that a Dataview 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 a Dataview 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.

createTime

public final Long createTime()

The timestamp at which the Dataview 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 Dataview 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.

hasSortColumns

public final boolean hasSortColumns()

For responses, this returns true if the service returned a value for the SortColumns 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.

sortColumns

public final List<String> sortColumns()

Columns to be used for sorting the data.

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

Returns:

Columns to be used for sorting the data.

dataViewId

public final String dataViewId()

The unique identifier for the Dataview.

Returns:

The unique identifier for the Dataview.

dataViewArn

public final String dataViewArn()

The ARN identifier of the Dataview.

Returns:

The ARN identifier of the Dataview.

destinationTypeParams

public final DataViewDestinationTypeParams destinationTypeParams()

Options that define the destination type for the Dataview.

Returns:

Options that define the destination type for the Dataview.

status

public final DataViewStatus status()

The status of a Dataview creation.

• RUNNING - Dataview creation is running.

• STARTING - Dataview creation is starting.

• FAILED - Dataview creation has failed.

• CANCELLED - Dataview creation has been cancelled.

• TIMEOUT - Dataview creation has timed out.

• SUCCESS - Dataview creation has succeeded.

• PENDING - Dataview creation is pending.

• FAILED_CLEANUP_FAILED - Dataview creation failed and resource cleanup failed.

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

Returns:

The status of a Dataview creation.

• RUNNING - Dataview creation is running.

• STARTING - Dataview creation is starting.

• FAILED - Dataview creation has failed.

• CANCELLED - Dataview creation has been cancelled.

• TIMEOUT - Dataview creation has timed out.

• SUCCESS - Dataview creation has succeeded.

• PENDING - Dataview creation is pending.

• FAILED_CLEANUP_FAILED - Dataview creation failed and resource cleanup failed.

See Also:

DataViewStatus

statusAsString

public final String statusAsString()

The status of a Dataview creation.

• RUNNING - Dataview creation is running.

• STARTING - Dataview creation is starting.

• FAILED - Dataview creation has failed.

• CANCELLED - Dataview creation has been cancelled.

• TIMEOUT - Dataview creation has timed out.

• SUCCESS - Dataview creation has succeeded.

• PENDING - Dataview creation is pending.

• FAILED_CLEANUP_FAILED - Dataview creation failed and resource cleanup failed.

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

Returns:

The status of a Dataview creation.

• RUNNING - Dataview creation is running.

• STARTING - Dataview creation is starting.

• FAILED - Dataview creation has failed.

• CANCELLED - Dataview creation has been cancelled.

• TIMEOUT - Dataview creation has timed out.

• SUCCESS - Dataview creation has succeeded.

• PENDING - Dataview creation is pending.

• FAILED_CLEANUP_FAILED - Dataview creation failed and resource cleanup failed.

See Also:

DataViewStatus

toBuilder

public GetDataViewResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetDataViewResponse.Builder,GetDataViewResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetDataViewResponse.Builder builder()

serializableBuilderClass

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