Class: Dynamoid::CDK::Schema::Index

Inherits:
Data
  • Object
show all
Defined in:
lib/dynamoid/cdk/schema/descriptor.rb

Overview

A secondary index. For a GSI partition_key is set; for an LSI it is nil (an LSI shares the table's partition key). projection_type is :all, :keys_only or :include; non_key_attributes is the projected list when :include, otherwise nil.

Instance Attribute Summary collapse

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name

Returns:

  • (Object) —

    the current value of name



14
15
16
 
# File 'lib/dynamoid/cdk/schema/descriptor.rb', line 14

def name
  @name
end

#non_key_attributes ⇒ Object (readonly)

Returns the value of attribute non_key_attributes

Returns:

  • (Object) —

    the current value of non_key_attributes



14
15
16
 
# File 'lib/dynamoid/cdk/schema/descriptor.rb', line 14

def non_key_attributes
  @non_key_attributes
end

#partition_key ⇒ Object (readonly)

Returns the value of attribute partition_key

Returns:

  • (Object) —

    the current value of partition_key



14
15
16
 
# File 'lib/dynamoid/cdk/schema/descriptor.rb', line 14

def partition_key
  @partition_key
end

#projection_type ⇒ Object (readonly)

Returns the value of attribute projection_type

Returns:

  • (Object) —

    the current value of projection_type



14
15
16
 
# File 'lib/dynamoid/cdk/schema/descriptor.rb', line 14

def projection_type
  @projection_type
end

#sort_key ⇒ Object (readonly)

Returns the value of attribute sort_key

Returns:

  • (Object) —

    the current value of sort_key



14
15
16
 
# File 'lib/dynamoid/cdk/schema/descriptor.rb', line 14

def sort_key
  @sort_key
end