Package software.amazon.awssdk.services.m2.model

Class VsamDetailAttributes

java.lang.Object

software.amazon.awssdk.services.m2.model.VsamDetailAttributes

All Implemented Interfaces:

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

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

The attributes of a VSAM type data set.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VsamDetailAttributes.Builder

Method Summary

Modifier and Type	Method	Description
List<AlternateKey>	alternateKeys()	The alternate key definitions, if any.
static VsamDetailAttributes.Builder	builder()
Boolean	cacheAtStartup()	If set to True, enforces loading the data set into cache before it’s used by the application.
Boolean	compressed()	Indicates whether indexes for this dataset are stored as compressed values.
String	encoding()	The character set used by the data set.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAlternateKeys()	For responses, this returns true if the service returned a value for the AlternateKeys property.
int	hashCode()
PrimaryKey	primaryKey()	The primary key of the data set.
String	recordFormat()	The record format of the data set.
List<SdkField<?>>	sdkFields()
static Class<? extends VsamDetailAttributes.Builder>	serializableBuilderClass()
VsamDetailAttributes.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

hasAlternateKeys

public final boolean hasAlternateKeys()

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

alternateKeys

public final List<AlternateKey> alternateKeys()

The alternate key definitions, if any. A legacy dataset might not have any alternate key defined, but if those alternate keys definitions exist, provide them as some applications will make use of them.

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

Returns:

The alternate key definitions, if any. A legacy dataset might not have any alternate key defined, but if those alternate keys definitions exist, provide them as some applications will make use of them.

cacheAtStartup

public final Boolean cacheAtStartup()

If set to True, enforces loading the data set into cache before it’s used by the application.

Returns:

If set to True, enforces loading the data set into cache before it’s used by the application.

compressed

public final Boolean compressed()

Indicates whether indexes for this dataset are stored as compressed values. If you have a large data set (typically > 100 Mb), consider setting this flag to True.

Returns:

Indicates whether indexes for this dataset are stored as compressed values. If you have a large data set (typically > 100 Mb), consider setting this flag to True.

encoding

public final String encoding()

The character set used by the data set. Can be ASCII, EBCDIC, or unknown.

Returns:

The character set used by the data set. Can be ASCII, EBCDIC, or unknown.

primaryKey

public final PrimaryKey primaryKey()

The primary key of the data set.

Returns:

The primary key of the data set.

recordFormat

public final String recordFormat()

The record format of the data set.

Returns:

The record format of the data set.

toBuilder

public VsamDetailAttributes.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VsamDetailAttributes.Builder,VsamDetailAttributes>

builder

public static VsamDetailAttributes.Builder builder()

serializableBuilderClass

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