« blib/lib/Paws/IoTSiteWise/ExpressionVariable.pm
↑ Summary
blib/lib/Paws/IoTSiteWise/GatewayPlatform.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IoTSiteWise::GatewayCapabilitySummary; | ||
| 3 | use Moose; | ||
| 4 | has CapabilityNamespace => (is => 'ro', isa => 'Str', request_name => 'capabilityNamespace', traits => ['NameInRequest'], required => 1); | ||
| 5 | has CapabilitySyncStatus => (is => 'ro', isa => 'Str', request_name => 'capabilitySyncStatus', traits => ['NameInRequest'], required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::IoTSiteWise::GatewayCapabilitySummary | ||
| 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::IoTSiteWise::GatewayCapabilitySummary object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { CapabilityNamespace => $value, ..., CapabilitySyncStatus => $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::IoTSiteWise::GatewayCapabilitySummary object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->CapabilityNamespace | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Contains a summary of a gateway capability configuration. | ||
| 38 | |||
| 39 | =head1 ATTRIBUTES | ||
| 40 | |||
| 41 | |||
| 42 | =head2 B<REQUIRED> CapabilityNamespace => Str | ||
| 43 | |||
| 44 | The namespace of the capability configuration. For example, if you | ||
| 45 | configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA | ||
| 46 | capability configuration has the namespace | ||
| 47 | C<iotsitewise:opcuacollector:version>, where C<version> is a number | ||
| 48 | such as C<1>. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> CapabilitySyncStatus => Str | ||
| 52 | |||
| 53 | The synchronization status of the capability configuration. The sync | ||
| 54 | status can be one of the following: | ||
| 55 | |||
| 56 | =over | ||
| 57 | |||
| 58 | =item * | ||
| 59 | |||
| 60 | C<IN_SYNC> E<ndash> The gateway is running the capability | ||
| 61 | configuration. | ||
| 62 | |||
| 63 | =item * | ||
| 64 | |||
| 65 | C<OUT_OF_SYNC> E<ndash> The gateway hasn't received the capability | ||
| 66 | configuration. | ||
| 67 | |||
| 68 | =item * | ||
| 69 | |||
| 70 | C<SYNC_FAILED> E<ndash> The gateway rejected the capability | ||
| 71 | configuration. | ||
| 72 | |||
| 73 | =back | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head1 SEE ALSO | ||
| 79 | |||
| 80 | This class forms part of L<Paws>, describing an object used in L<Paws::IoTSiteWise> | ||
| 81 | |||
| 82 | =head1 BUGS and CONTRIBUTIONS | ||
| 83 | |||
| 84 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 85 | |||
| 86 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 87 | |||
| 88 | =cut | ||
| 89 |