« blib/lib/Paws/ApiGatewayV2/LimitExceededException.pm
↑ Summary
blib/lib/Paws/ApiGatewayV2/Models.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ApiGatewayV2::Model; | ||
| 3 | use Moose; | ||
| 4 | has ContentType => (is => 'ro', isa => 'Str', request_name => 'contentType', traits => ['NameInRequest']); | ||
| 5 | has Description => (is => 'ro', isa => 'Str', request_name => 'description', traits => ['NameInRequest']); | ||
| 6 | has ModelId => (is => 'ro', isa => 'Str', request_name => 'modelId', traits => ['NameInRequest']); | ||
| 7 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest'], required => 1); | ||
| 8 | has Schema => (is => 'ro', isa => 'Str', request_name => 'schema', traits => ['NameInRequest']); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::ApiGatewayV2::Model | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::ApiGatewayV2::Model object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { ContentType => $value, ..., Schema => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::ApiGatewayV2::Model object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->ContentType | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Represents a data model for an API. Supported only for WebSocket APIs. | ||
| 41 | See Create Models and Mapping Templates for Request and Response | ||
| 42 | Mappings | ||
| 43 | (https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html). | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 ContentType => Str | ||
| 49 | |||
| 50 | The content-type for the model, for example, "application/json". | ||
| 51 | |||
| 52 | |||
| 53 | =head2 Description => Str | ||
| 54 | |||
| 55 | The description of the model. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 ModelId => Str | ||
| 59 | |||
| 60 | The model identifier. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> Name => Str | ||
| 64 | |||
| 65 | The name of the model. Must be alphanumeric. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 Schema => Str | ||
| 69 | |||
| 70 | The schema for the model. For application/json models, this should be | ||
| 71 | JSON schema draft 4 model. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head1 SEE ALSO | ||
| 76 | |||
| 77 | This class forms part of L<Paws>, describing an object used in L<Paws::ApiGatewayV2> | ||
| 78 | |||
| 79 | =head1 BUGS and CONTRIBUTIONS | ||
| 80 | |||
| 81 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 82 | |||
| 83 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 84 | |||
| 85 | =cut | ||
| 86 |