Class VsamAttributes

java.lang.Object
software.amazon.awssdk.services.m2.model.VsamAttributes
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<VsamAttributes.Builder,VsamAttributes>
@Generated("software.amazon.awssdk:codegen") public final class VsamAttributes extends Object implements SdkPojo, Serializable, ToCopyableBuilder<VsamAttributes.Builder,VsamAttributes>

The attributes of a VSAM type data set.

See Also:

  • Method Details

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

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

    • format

      public final String format()

      The record format of the data set.

      Returns:
      The record format of the data set.

    • primaryKey

      public final PrimaryKey primaryKey()

      The primary key of the data set.

      Returns:
      The primary key of the data set.

    • toBuilder

      public VsamAttributes.Builder 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 interface ToCopyableBuilder<VsamAttributes.Builder,VsamAttributes>
      Returns:
      a builder for type T

    • builder

      public static VsamAttributes.Builder builder()

    • serializableBuilderClass

      public static Class<? extends VsamAttributes.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.