Class: AWSCDK::QBusiness::CfnIndex::DocumentAttributeConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
q_business/cfn_index.rb

Overview

Configuration information for document attributes.

Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

For more information, see Understanding document attributes .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name: nil, search: nil, type: nil) ⇒ DocumentAttributeConfigurationProperty

Returns a new instance of DocumentAttributeConfigurationProperty.

Parameters:

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

    The name of the document attribute.

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

    Information about whether the document attribute can be used by an end user to search for information on their web experience.

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

    The type of document attribute.



646
647
648
649
650
651
652
653
 
# File 'q_business/cfn_index.rb', line 646

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

Instance Attribute Details

#name ⇒ String? (readonly)

The name of the document attribute.

Returns:

  • (String, nil)

See Also:



659
660
661
 
# File 'q_business/cfn_index.rb', line 659

def name
  @name
end

#search ⇒ String? (readonly)

Information about whether the document attribute can be used by an end user to search for information on their web experience.

Returns:

  • (String, nil)

See Also:



664
665
666
 
# File 'q_business/cfn_index.rb', line 664

def search
  @search
end

#type ⇒ String? (readonly)

The type of document attribute.

Returns:

  • (String, nil)

See Also:



669
670
671
 
# File 'q_business/cfn_index.rb', line 669

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



671
672
673
674
675
676
677
 
# File 'q_business/cfn_index.rb', line 671

def self.jsii_properties
  {
    :name => "name",
    :search => "search",
    :type => "type",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



679
680
681
682
683
684
685
686
687
 
# File 'q_business/cfn_index.rb', line 679

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