« blib/lib/Paws/Appflow/ConnectorConfigurationsMap.pm
↑ Summary
blib/lib/Paws/Appflow/ConnectorEntityField.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Appflow::ConnectorEntity; | ||
| 3 | use Moose; | ||
| 4 | has HasNestedEntities => (is => 'ro', isa => 'Bool', request_name => 'hasNestedEntities', traits => ['NameInRequest']); | ||
| 5 | has Label => (is => 'ro', isa => 'Str', request_name => 'label', traits => ['NameInRequest']); | ||
| 6 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest'], required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::Appflow::ConnectorEntity | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::Appflow::ConnectorEntity object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { HasNestedEntities => $value, ..., Name => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::Appflow::ConnectorEntity object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->HasNestedEntities | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | The high-level entity that can be queried in Amazon AppFlow. For | ||
| 39 | example, a Salesforce entity might be an I<Account> or I<Opportunity>, | ||
| 40 | whereas a ServiceNow entity might be an I<Incident>. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 HasNestedEntities => Bool | ||
| 46 | |||
| 47 | Specifies whether the connector entity is a parent or a category and | ||
| 48 | has more entities nested underneath it. If another call is made with | ||
| 49 | C<entitiesPath = | ||
| 50 | "the_current_entity_name_with_hasNestedEntities_true">, then it returns | ||
| 51 | the nested entities underneath it. This provides a way to retrieve all | ||
| 52 | supported entities in a recursive fashion. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 Label => Str | ||
| 56 | |||
| 57 | The label applied to the connector entity. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> Name => Str | ||
| 61 | |||
| 62 | The name of the connector entity. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head1 SEE ALSO | ||
| 67 | |||
| 68 | This class forms part of L<Paws>, describing an object used in L<Paws::Appflow> | ||
| 69 | |||
| 70 | =head1 BUGS and CONTRIBUTIONS | ||
| 71 | |||
| 72 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 73 | |||
| 74 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 75 | |||
| 76 | =cut | ||
| 77 |