Class: Aws::MainframeModernization::Types::AlternateKey

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb

Overview

Note:

When making an API call, you may pass AlternateKey data as a hash:

{
  allow_duplicates: false,
  length: 1, # required
  name: "String",
  offset: 1, # required
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allow_duplicatesBoolean

Indicates whether the alternate key values are supposed to be unique for the given data set.

Returns:

  • (Boolean)


63
64
65
66
67
68
69
70
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 63

class AlternateKey < Struct.new(
  :allow_duplicates,
  :length,
  :name,
  :offset)
  SENSITIVE = []
  include Aws::Structure
end

#lengthInteger

A strictly positive integer value representing the length of the alternate key.

Returns:

  • (Integer)


63
64
65
66
67
68
69
70
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 63

class AlternateKey < Struct.new(
  :allow_duplicates,
  :length,
  :name,
  :offset)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the alternate key.

Returns:

  • (String)


63
64
65
66
67
68
69
70
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 63

class AlternateKey < Struct.new(
  :allow_duplicates,
  :length,
  :name,
  :offset)
  SENSITIVE = []
  include Aws::Structure
end

#offsetInteger

A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.

Returns:

  • (Integer)


63
64
65
66
67
68
69
70
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 63

class AlternateKey < Struct.new(
  :allow_duplicates,
  :length,
  :name,
  :offset)
  SENSITIVE = []
  include Aws::Structure
end