« blib/lib/Paws/KinesisVideo/ChannelInfo.pm
↑ Summary
blib/lib/Paws/KinesisVideo/CreateSignalingChannel.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::KinesisVideo::ChannelNameCondition; | ||
| 3 | use Moose; | ||
| 4 | has ComparisonOperator => (is => 'ro', isa => 'Str'); | ||
| 5 | has ComparisonValue => (is => 'ro', isa => 'Str'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::KinesisVideo::ChannelNameCondition | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::KinesisVideo::ChannelNameCondition object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { ComparisonOperator => $value, ..., ComparisonValue => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::KinesisVideo::ChannelNameCondition object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->ComparisonOperator | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | An optional input parameter for the C<ListSignalingChannels> API. When | ||
| 38 | this parameter is specified while invoking C<ListSignalingChannels>, | ||
| 39 | the API returns only the channels that satisfy a condition specified in | ||
| 40 | C<ChannelNameCondition>. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 ComparisonOperator => Str | ||
| 46 | |||
| 47 | A comparison operator. Currently, you can only specify the | ||
| 48 | C<BEGINS_WITH> operator, which finds signaling channels whose names | ||
| 49 | begin with a given prefix. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 ComparisonValue => Str | ||
| 53 | |||
| 54 | A value to compare. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head1 SEE ALSO | ||
| 59 | |||
| 60 | This class forms part of L<Paws>, describing an object used in L<Paws::KinesisVideo> | ||
| 61 | |||
| 62 | =head1 BUGS and CONTRIBUTIONS | ||
| 63 | |||
| 64 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 65 | |||
| 66 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 67 | |||
| 68 | =cut | ||
| 69 |