| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::TreatmentResource; | ||
| 3 | use Moose; | ||
| 4 | has CustomDeliveryConfiguration => (is => 'ro', isa => 'Paws::Pinpoint::CustomDeliveryConfiguration'); | ||
| 5 | has Id => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has MessageConfiguration => (is => 'ro', isa => 'Paws::Pinpoint::MessageConfiguration'); | ||
| 7 | has Schedule => (is => 'ro', isa => 'Paws::Pinpoint::Schedule'); | ||
| 8 | has SizePercent => (is => 'ro', isa => 'Int', required => 1); | ||
| 9 | has State => (is => 'ro', isa => 'Paws::Pinpoint::CampaignState'); | ||
| 10 | has TemplateConfiguration => (is => 'ro', isa => 'Paws::Pinpoint::TemplateConfiguration'); | ||
| 11 | has TreatmentDescription => (is => 'ro', isa => 'Str'); | ||
| 12 | has TreatmentName => (is => 'ro', isa => 'Str'); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Pinpoint::TreatmentResource | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::Pinpoint::TreatmentResource object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { CustomDeliveryConfiguration => $value, ..., TreatmentName => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::TreatmentResource object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->CustomDeliveryConfiguration | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Specifies the settings for a campaign treatment. A I<treatment> is a | ||
| 45 | variation of a campaign that's used for A/B testing of a campaign. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 CustomDeliveryConfiguration => L<Paws::Pinpoint::CustomDeliveryConfiguration> | ||
| 51 | |||
| 52 | The delivery configuration settings for sending the treatment through a | ||
| 53 | custom channel. This object is required if the MessageConfiguration | ||
| 54 | object for the treatment specifies a CustomMessage object. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> Id => Str | ||
| 58 | |||
| 59 | The unique identifier for the treatment. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 MessageConfiguration => L<Paws::Pinpoint::MessageConfiguration> | ||
| 63 | |||
| 64 | The message configuration settings for the treatment. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 Schedule => L<Paws::Pinpoint::Schedule> | ||
| 68 | |||
| 69 | The schedule settings for the treatment. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> SizePercent => Int | ||
| 73 | |||
| 74 | The allocated percentage of users (segment members) that the treatment | ||
| 75 | is sent to. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 State => L<Paws::Pinpoint::CampaignState> | ||
| 79 | |||
| 80 | The current status of the treatment. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 TemplateConfiguration => L<Paws::Pinpoint::TemplateConfiguration> | ||
| 84 | |||
| 85 | The message template to use for the treatment. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 TreatmentDescription => Str | ||
| 89 | |||
| 90 | The custom description of the treatment. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 TreatmentName => Str | ||
| 94 | |||
| 95 | The custom name of the treatment. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head1 SEE ALSO | ||
| 100 | |||
| 101 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 102 | |||
| 103 | =head1 BUGS and CONTRIBUTIONS | ||
| 104 | |||
| 105 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 106 | |||
| 107 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 108 | |||
| 109 | =cut | ||
| 110 |