« blib/lib/Paws/CloudSearchDomain/SuggestionMatch.pm
↑ Summary
blib/lib/Paws/CloudSearchDomain/UploadDocumentsResponse.pm »
| 1 | |||
| 2 | package Paws::CloudSearchDomain::UploadDocuments; | ||
| 3 | use Moose; | ||
| 4 | has ContentType => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'Content-Type', required => 1); | ||
| 5 | has Documents => (is => 'ro', isa => 'Str', traits => ['ParamInBody'], required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | class_has _stream_param => (is => 'ro', default => 'Documents'); | ||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UploadDocuments'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/2013-01-01/documents/batch?format=sdk'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudSearchDomain::UploadDocumentsResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::CloudSearchDomain::UploadDocuments - Arguments for method UploadDocuments on L<Paws::CloudSearchDomain> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method UploadDocuments on the | ||
| 24 | L<Amazon CloudSearch Domain|Paws::CloudSearchDomain> service. Use the attributes of this class | ||
| 25 | as arguments to method UploadDocuments. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UploadDocuments. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $cloudsearchdomain = Paws->service('CloudSearchDomain'); | ||
| 32 | my $UploadDocumentsResponse = $cloudsearchdomain->UploadDocuments( | ||
| 33 | ContentType => 'application/json', | ||
| 34 | Documents => 'BlobBlob', | ||
| 35 | |||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $Adds = $UploadDocumentsResponse->Adds; | ||
| 40 | my $Deletes = $UploadDocumentsResponse->Deletes; | ||
| 41 | my $Status = $UploadDocumentsResponse->Status; | ||
| 42 | my $Warnings = $UploadDocumentsResponse->Warnings; | ||
| 43 | |||
| 44 | # Returns a L<Paws::CloudSearchDomain::UploadDocumentsResponse> object. | ||
| 45 | |||
| 46 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 47 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudsearchdomain/UploadDocuments> | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> ContentType => Str | ||
| 53 | |||
| 54 | The format of the batch you are uploading. Amazon CloudSearch supports | ||
| 55 | two document batch formats: | ||
| 56 | |||
| 57 | =over | ||
| 58 | |||
| 59 | =item * application/json | ||
| 60 | |||
| 61 | =item * application/xml | ||
| 62 | |||
| 63 | =back | ||
| 64 | |||
| 65 | |||
| 66 | Valid values are: C<"application/json">, C<"application/xml"> | ||
| 67 | |||
| 68 | =head2 B<REQUIRED> Documents => Str | ||
| 69 | |||
| 70 | A batch of documents formatted in JSON or HTML. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head1 SEE ALSO | ||
| 76 | |||
| 77 | This class forms part of L<Paws>, documenting arguments for method UploadDocuments in L<Paws::CloudSearchDomain> | ||
| 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 |