AlternateKey (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.mainframemodernization.model.AlternateKey

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AlternateKey
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Defines an alternate key. This value is optional. A legacy data set might not have any alternate key defined but if those alternate keys definitions exist, provide them, as some applications will make use of them.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AlternateKey()

Constructors
Constructor and Description
`AlternateKey()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AlternateKey`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getAllowDuplicates()` Indicates whether the alternate key values are supposed to be unique for the given data set.
`Integer`	`getLength()` A strictly positive integer value representing the length of the alternate key.
`String`	`getName()` The name of the alternate key.
`Integer`	`getOffset()` A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.
`int`	`hashCode()`
`Boolean`	`isAllowDuplicates()` Indicates whether the alternate key values are supposed to be unique for the given data set.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAllowDuplicates(Boolean allowDuplicates)` Indicates whether the alternate key values are supposed to be unique for the given data set.
`void`	`setLength(Integer length)` A strictly positive integer value representing the length of the alternate key.
`void`	`setName(String name)` The name of the alternate key.
`void`	`setOffset(Integer offset)` A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.
`String`	`toString()` Returns a string representation of this object.
`AlternateKey`	`withAllowDuplicates(Boolean allowDuplicates)` Indicates whether the alternate key values are supposed to be unique for the given data set.
`AlternateKey`	`withLength(Integer length)` A strictly positive integer value representing the length of the alternate key.
`AlternateKey`	`withName(String name)` The name of the alternate key.
`AlternateKey`	`withOffset(Integer offset)` A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AlternateKey
```
public AlternateKey()
```
- Method Detail
  - setAllowDuplicates
```
public void setAllowDuplicates(Boolean allowDuplicates)
```
    Indicates whether the alternate key values are supposed to be unique for the given data set.
    
    Parameters:
    
    allowDuplicates - Indicates whether the alternate key values are supposed to be unique for the given data set.
  - getAllowDuplicates
```
public Boolean getAllowDuplicates()
```
    Indicates whether the alternate key values are supposed to be unique for the given data set.
    
    Returns:
    
    Indicates whether the alternate key values are supposed to be unique for the given data set.
  - withAllowDuplicates
```
public AlternateKey withAllowDuplicates(Boolean allowDuplicates)
```
    Indicates whether the alternate key values are supposed to be unique for the given data set.
    
    Parameters:
    
    allowDuplicates - Indicates whether the alternate key values are supposed to be unique for the given data set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAllowDuplicates
```
public Boolean isAllowDuplicates()
```
    Indicates whether the alternate key values are supposed to be unique for the given data set.
    
    Returns:
    
    Indicates whether the alternate key values are supposed to be unique for the given data set.
  - setLength
```
public void setLength(Integer length)
```
    A strictly positive integer value representing the length of the alternate key.
    
    Parameters:
    
    length - A strictly positive integer value representing the length of the alternate key.
  - getLength
```
public Integer getLength()
```
    A strictly positive integer value representing the length of the alternate key.
    
    Returns:
    
    A strictly positive integer value representing the length of the alternate key.
  - withLength
```
public AlternateKey withLength(Integer length)
```
    A strictly positive integer value representing the length of the alternate key.
    
    Parameters:
    
    length - A strictly positive integer value representing the length of the alternate key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the alternate key.
    
    Parameters:
    
    name - The name of the alternate key.
  - getName
```
public String getName()
```
    The name of the alternate key.
    
    Returns:
    
    The name of the alternate key.
  - withName
```
public AlternateKey withName(String name)
```
    The name of the alternate key.
    
    Parameters:
    
    name - The name of the alternate key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOffset
```
public void setOffset(Integer offset)
```
    A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.
    
    Parameters:
    
    offset - A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.
  - getOffset
```
public Integer getOffset()
```
    A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.
    
    Returns:
    
    A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.
  - withOffset
```
public AlternateKey withOffset(Integer offset)
```
    A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.
    
    Parameters:
    
    offset - A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AlternateKey clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class AlternateKey

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AlternateKey

Method Detail

setAllowDuplicates

getAllowDuplicates

withAllowDuplicates

isAllowDuplicates

setLength

getLength

withLength

setName

getName

withName

setOffset

getOffset

withOffset

toString

equals

hashCode

clone

marshall