Class: AWSCDK::CustomerProfiles::CfnSegmentDefinition::SortAttributeProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::CustomerProfiles::CfnSegmentDefinition::SortAttributeProperty

Defined in:

customer_profiles/cfn_segment_definition.rb

Overview

Defines the characteristics and rules for sorting by a specific attribute.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-sortattribute.html

Instance Attribute Summary

• #data_type ⇒ String^? readonly

  The data type of the sort attribute (e.g., string, number, date).

• #name ⇒ String readonly

  The name of the attribute to sort by.

• #order ⇒ String readonly

  The sort order for the attribute (ascending or descending).

• #type ⇒ String^? readonly

  The type of attribute (e.g., profile, calculated).

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(name:, order:, data_type: nil, type: nil) ⇒ SortAttributeProperty constructor

  A new instance of SortAttributeProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(name:, order:, data_type: nil, type: nil) ⇒ SortAttributeProperty

Returns a new instance of SortAttributeProperty.

Parameters:

• name (String) —

  The name of the attribute to sort by.

• order (String) —

  The sort order for the attribute (ascending or descending).

• data_type (String, nil) (defaults to: nil) —

  The data type of the sort attribute (e.g., string, number, date).

• type (String, nil) (defaults to: nil) —

  The type of attribute (e.g., profile, calculated).

# File 'customer_profiles/cfn_segment_definition.rb', line 1493

def initialize(name:, order:, data_type: nil, type: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @order = order
  Jsii::Type.check_type(@order, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "order")
  @data_type = data_type
  Jsii::Type.check_type(@data_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataType") unless @data_type.nil?
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless @type.nil?
end

Instance Attribute Details

#data_type ⇒ String^? (readonly)

The data type of the sort attribute (e.g., string, number, date).

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-sortattribute.html#cfn-customerprofiles-segmentdefinition-sortattribute-datatype

# File 'customer_profiles/cfn_segment_definition.rb', line 1518

def data_type
  @data_type
end

#name ⇒ String (readonly)

The name of the attribute to sort by.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-sortattribute.html#cfn-customerprofiles-segmentdefinition-sortattribute-name

# File 'customer_profiles/cfn_segment_definition.rb', line 1508

def name
  @name
end

#order ⇒ String (readonly)

The sort order for the attribute (ascending or descending).

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-sortattribute.html#cfn-customerprofiles-segmentdefinition-sortattribute-order

# File 'customer_profiles/cfn_segment_definition.rb', line 1513

def order
  @order
end

#type ⇒ String^? (readonly)

The type of attribute (e.g., profile, calculated).

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-sortattribute.html#cfn-customerprofiles-segmentdefinition-sortattribute-type

# File 'customer_profiles/cfn_segment_definition.rb', line 1523

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object

# File 'customer_profiles/cfn_segment_definition.rb', line 1525

def self.jsii_properties
  {
    :name => "name",
    :order => "order",
    :data_type => "dataType",
    :type => "type",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'customer_profiles/cfn_segment_definition.rb', line 1534

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "order" => @order,
    "dataType" => @data_type,
    "type" => @type,
  })
  result.compact
end