« blib/lib/Paws/Pinpoint/SegmentDimensions.pm
↑ Summary
blib/lib/Paws/Pinpoint/SegmentGroupList.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::SegmentGroup; | ||
| 3 | use Moose; | ||
| 4 | has Dimensions => (is => 'ro', isa => 'ArrayRef[Paws::Pinpoint::SegmentDimensions]'); | ||
| 5 | has SourceSegments => (is => 'ro', isa => 'ArrayRef[Paws::Pinpoint::SegmentReference]'); | ||
| 6 | has SourceType => (is => 'ro', isa => 'Str'); | ||
| 7 | has Type => (is => 'ro', isa => 'Str'); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::Pinpoint::SegmentGroup | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::Pinpoint::SegmentGroup object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { Dimensions => $value, ..., Type => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::SegmentGroup object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->Dimensions | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Specifies the base segments and dimensions for a segment, and the | ||
| 40 | relationships between these base segments and dimensions. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 Dimensions => ArrayRef[L<Paws::Pinpoint::SegmentDimensions>] | ||
| 46 | |||
| 47 | An array that defines the dimensions for the segment. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 SourceSegments => ArrayRef[L<Paws::Pinpoint::SegmentReference>] | ||
| 51 | |||
| 52 | The base segment to build the segment on. A base segment, also referred | ||
| 53 | to as a I<source segment>, defines the initial population of endpoints | ||
| 54 | for a segment. When you add dimensions to a segment, Amazon Pinpoint | ||
| 55 | filters the base segment by using the dimensions that you specify. | ||
| 56 | |||
| 57 | You can specify more than one dimensional segment or only one imported | ||
| 58 | segment. If you specify an imported segment, the Amazon Pinpoint | ||
| 59 | console displays a segment size estimate that indicates the size of the | ||
| 60 | imported segment without any filters applied to it. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 SourceType => Str | ||
| 64 | |||
| 65 | Specifies how to handle multiple base segments for the segment. For | ||
| 66 | example, if you specify three base segments for the segment, whether | ||
| 67 | the resulting segment is based on all, any, or none of the base | ||
| 68 | segments. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 Type => Str | ||
| 72 | |||
| 73 | Specifies how to handle multiple dimensions for the segment. For | ||
| 74 | example, if you specify three dimensions for the segment, whether the | ||
| 75 | resulting segment includes endpoints that match all, any, or none of | ||
| 76 | the dimensions. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head1 SEE ALSO | ||
| 81 | |||
| 82 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 83 | |||
| 84 | =head1 BUGS and CONTRIBUTIONS | ||
| 85 | |||
| 86 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 87 | |||
| 88 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 89 | |||
| 90 | =cut | ||
| 91 |