« blib/lib/Paws/CloudSearch/IntArrayOptions.pm
↑ Summary
blib/lib/Paws/CloudSearch/LatLonOptions.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudSearch::IntOptions; | ||
| 3 | use Moose; | ||
| 4 | has DefaultValue => (is => 'ro', isa => 'Int'); | ||
| 5 | has FacetEnabled => (is => 'ro', isa => 'Bool'); | ||
| 6 | has ReturnEnabled => (is => 'ro', isa => 'Bool'); | ||
| 7 | has SearchEnabled => (is => 'ro', isa => 'Bool'); | ||
| 8 | has SortEnabled => (is => 'ro', isa => 'Bool'); | ||
| 9 | has SourceField => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::CloudSearch::IntOptions | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::CloudSearch::IntOptions object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { DefaultValue => $value, ..., SourceField => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudSearch::IntOptions object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->DefaultValue | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Options for a 64-bit signed integer field. Present if C<IndexFieldType> | ||
| 42 | specifies the field is of type C<int>. All options are enabled by | ||
| 43 | default. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 DefaultValue => Int | ||
| 49 | |||
| 50 | A value to use for the field if the field isn't specified for a | ||
| 51 | document. This can be important if you are using the field in an | ||
| 52 | expression and that field is not present in every document. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 FacetEnabled => Bool | ||
| 56 | |||
| 57 | Whether facet information can be returned for the field. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 ReturnEnabled => Bool | ||
| 61 | |||
| 62 | Whether the contents of the field can be returned in the search | ||
| 63 | results. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 SearchEnabled => Bool | ||
| 67 | |||
| 68 | Whether the contents of the field are searchable. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 SortEnabled => Bool | ||
| 72 | |||
| 73 | Whether the field can be used to sort the search results. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 SourceField => Str | ||
| 77 | |||
| 78 | The name of the source field to map to the field. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head1 SEE ALSO | ||
| 83 | |||
| 84 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudSearch> | ||
| 85 | |||
| 86 | =head1 BUGS and CONTRIBUTIONS | ||
| 87 | |||
| 88 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 89 | |||
| 90 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 91 | |||
| 92 | =cut | ||
| 93 |