Class ViewFrame
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ViewFrame.Builder,
ViewFrame>
Represents the data being transformed during an action.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AnalyticsMode
Controls if analytics computation is enabled or disabled.final String
Controls if analytics computation is enabled or disabled.static ViewFrame.Builder
builder()
final Integer
The number of columns to include in the view frame, beginning with theStartColumnIndex
value and ignoring any columns in theHiddenColumns
list.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the HiddenColumns property.A list of columns to hide in the view frame.final Integer
rowRange()
The number of rows to include in the view frame, beginning with theStartRowIndex
value.static Class
<? extends ViewFrame.Builder> final Integer
The starting index for the range of columns to return in the view frame.final Integer
The starting index for the range of rows to return in the view frame.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The number of columns to include in the view frame, beginning with the
StartColumnIndex
value and ignoring any columns in theHiddenColumns
list.- Returns:
- The number of columns to include in the view frame, beginning with the
StartColumnIndex
value and ignoring any columns in theHiddenColumns
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 theisEmpty()
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. -
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
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
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 returnAnalyticsMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromanalyticsAsString()
.- Returns:
- Controls if analytics computation is enabled or disabled. Enabled by default.
- See Also:
-
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 returnAnalyticsMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromanalyticsAsString()
.- Returns:
- Controls if analytics computation is enabled or disabled. Enabled by default.
- See Also:
-
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 interfaceToCopyableBuilder<ViewFrame.Builder,
ViewFrame> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-