NAME

Paws::CloudSearch::DefineIndexField - Arguments for method DefineIndexField on Paws::CloudSearch

DESCRIPTION

This class represents the parameters used for calling the method DefineIndexField on the Amazon CloudSearch service. Use the attributes of this class as arguments to method DefineIndexField.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DefineIndexField.

SYNOPSIS

    my $cloudsearch = Paws->service('CloudSearch');
    my $DefineIndexFieldResponse = $cloudsearch->DefineIndexField(
      DomainName => 'MyDomainName',
      IndexField => {
        IndexFieldName => 'MyDynamicFieldName',    # min: 1, max: 64
        IndexFieldType => 'int'
        , # values: int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array
        DateArrayOptions => {
          DefaultValue  => 'MyFieldValue',            # max: 1024; OPTIONAL
          FacetEnabled  => 1,                         # OPTIONAL
          ReturnEnabled => 1,                         # OPTIONAL
          SearchEnabled => 1,                         # OPTIONAL
          SourceFields  => 'MyFieldNameCommaList',    # OPTIONAL
        },    # OPTIONAL
        DateOptions => {
          DefaultValue  => 'MyFieldValue',    # max: 1024; OPTIONAL
          FacetEnabled  => 1,                 # OPTIONAL
          ReturnEnabled => 1,                 # OPTIONAL
          SearchEnabled => 1,                 # OPTIONAL
          SortEnabled   => 1,                 # OPTIONAL
          SourceField   => 'MyFieldName',     # min: 1, max: 64; OPTIONAL
        },    # OPTIONAL
        DoubleArrayOptions => {
          DefaultValue  => 1,                         # OPTIONAL
          FacetEnabled  => 1,                         # OPTIONAL
          ReturnEnabled => 1,                         # OPTIONAL
          SearchEnabled => 1,                         # OPTIONAL
          SourceFields  => 'MyFieldNameCommaList',    # OPTIONAL
        },    # OPTIONAL
        DoubleOptions => {
          DefaultValue  => 1,                # OPTIONAL
          FacetEnabled  => 1,                # OPTIONAL
          ReturnEnabled => 1,                # OPTIONAL
          SearchEnabled => 1,                # OPTIONAL
          SortEnabled   => 1,                # OPTIONAL
          SourceField   => 'MyFieldName',    # min: 1, max: 64; OPTIONAL
        },    # OPTIONAL
        IntArrayOptions => {
          DefaultValue  => 1,                         # OPTIONAL
          FacetEnabled  => 1,                         # OPTIONAL
          ReturnEnabled => 1,                         # OPTIONAL
          SearchEnabled => 1,                         # OPTIONAL
          SourceFields  => 'MyFieldNameCommaList',    # OPTIONAL
        },    # OPTIONAL
        IntOptions => {
          DefaultValue  => 1,                # OPTIONAL
          FacetEnabled  => 1,                # OPTIONAL
          ReturnEnabled => 1,                # OPTIONAL
          SearchEnabled => 1,                # OPTIONAL
          SortEnabled   => 1,                # OPTIONAL
          SourceField   => 'MyFieldName',    # min: 1, max: 64; OPTIONAL
        },    # OPTIONAL
        LatLonOptions => {
          DefaultValue  => 'MyFieldValue',    # max: 1024; OPTIONAL
          FacetEnabled  => 1,                 # OPTIONAL
          ReturnEnabled => 1,                 # OPTIONAL
          SearchEnabled => 1,                 # OPTIONAL
          SortEnabled   => 1,                 # OPTIONAL
          SourceField   => 'MyFieldName',     # min: 1, max: 64; OPTIONAL
        },    # OPTIONAL
        LiteralArrayOptions => {
          DefaultValue  => 'MyFieldValue',            # max: 1024; OPTIONAL
          FacetEnabled  => 1,                         # OPTIONAL
          ReturnEnabled => 1,                         # OPTIONAL
          SearchEnabled => 1,                         # OPTIONAL
          SourceFields  => 'MyFieldNameCommaList',    # OPTIONAL
        },    # OPTIONAL
        LiteralOptions => {
          DefaultValue  => 'MyFieldValue',    # max: 1024; OPTIONAL
          FacetEnabled  => 1,                 # OPTIONAL
          ReturnEnabled => 1,                 # OPTIONAL
          SearchEnabled => 1,                 # OPTIONAL
          SortEnabled   => 1,                 # OPTIONAL
          SourceField   => 'MyFieldName',     # min: 1, max: 64; OPTIONAL
        },    # OPTIONAL
        TextArrayOptions => {
          AnalysisScheme   => 'MyWord',                  # OPTIONAL
          DefaultValue     => 'MyFieldValue',            # max: 1024; OPTIONAL
          HighlightEnabled => 1,                         # OPTIONAL
          ReturnEnabled    => 1,                         # OPTIONAL
          SourceFields     => 'MyFieldNameCommaList',    # OPTIONAL
        },    # OPTIONAL
        TextOptions => {
          AnalysisScheme   => 'MyWord',          # OPTIONAL
          DefaultValue     => 'MyFieldValue',    # max: 1024; OPTIONAL
          HighlightEnabled => 1,                 # OPTIONAL
          ReturnEnabled    => 1,                 # OPTIONAL
          SortEnabled      => 1,                 # OPTIONAL
          SourceField      => 'MyFieldName',     # min: 1, max: 64; OPTIONAL
        },    # OPTIONAL
      },

    );

    # Results:
    my $IndexField = $DefineIndexFieldResponse->IndexField;

    # Returns a L<Paws::CloudSearch::DefineIndexFieldResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/cloudsearch/DefineIndexField

ATTRIBUTES

REQUIRED DomainName => Str

REQUIRED IndexField => Paws::CloudSearch::IndexField

The index field and field options you want to configure.

SEE ALSO

This class forms part of Paws, documenting arguments for method DefineIndexField in Paws::CloudSearch

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues