Package software.amazon.awssdk.services.databrew.model

Class ViewFrame

java.lang.Object

software.amazon.awssdk.services.databrew.model.ViewFrame

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ViewFrame.Builder,ViewFrame>

@Generated("software.amazon.awssdk:codegen")
public final class ViewFrame
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ViewFrame.Builder,ViewFrame>

Represents the data being transformed during an action.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ViewFrame.Builder

Method Summary

Modifier and Type	Method	Description
AnalyticsMode	analytics()	Controls if analytics computation is enabled or disabled.
String	analyticsAsString()	Controls if analytics computation is enabled or disabled.
static ViewFrame.Builder	builder()
Integer	columnRange()	The number of columns to include in the view frame, beginning with the StartColumnIndex value and ignoring any columns in the HiddenColumns list.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasHiddenColumns()	For responses, this returns true if the service returned a value for the HiddenColumns property.
List<String>	hiddenColumns()	A list of columns to hide in the view frame.
Integer	rowRange()	The number of rows to include in the view frame, beginning with the StartRowIndex value.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ViewFrame.Builder>	serializableBuilderClass()
Integer	startColumnIndex()	The starting index for the range of columns to return in the view frame.
Integer	startRowIndex()	The starting index for the range of rows to return in the view frame.
ViewFrame.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

startColumnIndex

public final Integer startColumnIndex()

The starting index for the range of columns to return in the view frame.

Returns:

The starting index for the range of columns to return in the view frame.

columnRange

public final Integer columnRange()

The number of columns to include in the view frame, beginning with the StartColumnIndex value and ignoring any columns in the HiddenColumns list.

Returns:

The number of columns to include in the view frame, beginning with the StartColumnIndex value and ignoring any columns in the HiddenColumns list.

hasHiddenColumns

public final boolean hasHiddenColumns()

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

hiddenColumns

public final List<String> hiddenColumns()

A list of columns to hide in the view frame.

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

Returns:

A list of columns to hide in the view frame.

startRowIndex

public final Integer startRowIndex()

The starting index for the range of rows to return in the view frame.

Returns:

The starting index for the range of rows to return in the view frame.

rowRange

public final Integer rowRange()

The number of rows to include in the view frame, beginning with the StartRowIndex value.

Returns:

The number of rows to include in the view frame, beginning with the StartRowIndex value.

analytics

public final AnalyticsMode analytics()

Controls if analytics computation is enabled or disabled. Enabled by default.

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

Returns:

Controls if analytics computation is enabled or disabled. Enabled by default.

See Also:

AnalyticsMode

analyticsAsString

public final String analyticsAsString()

Controls if analytics computation is enabled or disabled. Enabled by default.

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

Returns:

Controls if analytics computation is enabled or disabled. Enabled by default.

See Also:

AnalyticsMode

toBuilder

public ViewFrame.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ViewFrame.Builder,ViewFrame>

builder

public static ViewFrame.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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