« blib/lib/Paws/FinspaceData/ChangesetInfo.pm
↑ Summary
blib/lib/Paws/FinspaceData/CreateChangesetResponse.pm »
| 1 | |||
| 2 | package Paws::FinspaceData::CreateChangeset; | ||
| 3 | use Moose; | ||
| 4 | has ChangeType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'changeType', required => 1); | ||
| 5 | has DatasetId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'datasetId', required => 1); | ||
| 6 | has FormatParams => (is => 'ro', isa => 'Paws::FinspaceData::StringMap', traits => ['NameInRequest'], request_name => 'formatParams'); | ||
| 7 | has FormatType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'formatType'); | ||
| 8 | has SourceParams => (is => 'ro', isa => 'Paws::FinspaceData::StringMap', traits => ['NameInRequest'], request_name => 'sourceParams', required => 1); | ||
| 9 | has SourceType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'sourceType', required => 1); | ||
| 10 | has Tags => (is => 'ro', isa => 'Paws::FinspaceData::StringMap', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateChangeset'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/datasets/{datasetId}/changesets'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::FinspaceData::CreateChangesetResponse'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::FinspaceData::CreateChangeset - Arguments for method CreateChangeset on L<Paws::FinspaceData> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method CreateChangeset on the | ||
| 29 | L<FinSpace Public API|Paws::FinspaceData> service. Use the attributes of this class | ||
| 30 | as arguments to method CreateChangeset. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateChangeset. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $finspace-api = Paws->service('FinspaceData'); | ||
| 37 | my $CreateChangesetResponse = $finspace -api->CreateChangeset( | ||
| 38 | ChangeType => 'REPLACE', | ||
| 39 | DatasetId => 'MyIdType', | ||
| 40 | SourceParams => { 'MystringMapKey' => 'MystringMapValue', }, | ||
| 41 | SourceType => 'S3', | ||
| 42 | FormatParams => { 'MystringMapKey' => 'MystringMapValue', }, # OPTIONAL | ||
| 43 | FormatType => 'CSV', # OPTIONAL | ||
| 44 | Tags => { 'MystringMapKey' => 'MystringMapValue', }, # OPTIONAL | ||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $Changeset = $CreateChangesetResponse->Changeset; | ||
| 49 | |||
| 50 | # Returns a L<Paws::FinspaceData::CreateChangesetResponse> object. | ||
| 51 | |||
| 52 | 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. | ||
| 53 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/finspace-api/CreateChangeset> | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> ChangeType => Str | ||
| 59 | |||
| 60 | Option to indicate how a changeset will be applied to a dataset. | ||
| 61 | |||
| 62 | =over | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | C<REPLACE> - Changeset will be considered as a replacement to all prior | ||
| 67 | loaded changesets. | ||
| 68 | |||
| 69 | =item * | ||
| 70 | |||
| 71 | C<APPEND> - Changeset will be considered as an addition to the end of | ||
| 72 | all prior loaded changesets. | ||
| 73 | |||
| 74 | =back | ||
| 75 | |||
| 76 | |||
| 77 | Valid values are: C<"REPLACE">, C<"APPEND">, C<"MODIFY"> | ||
| 78 | |||
| 79 | =head2 B<REQUIRED> DatasetId => Str | ||
| 80 | |||
| 81 | The unique identifier for the FinSpace dataset in which the changeset | ||
| 82 | will be created. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 FormatParams => L<Paws::FinspaceData::StringMap> | ||
| 87 | |||
| 88 | Options that define the structure of the source file(s). | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 FormatType => Str | ||
| 93 | |||
| 94 | Format type of the input files being loaded into the changeset. | ||
| 95 | |||
| 96 | Valid values are: C<"CSV">, C<"JSON">, C<"PARQUET">, C<"XML"> | ||
| 97 | |||
| 98 | =head2 B<REQUIRED> SourceParams => L<Paws::FinspaceData::StringMap> | ||
| 99 | |||
| 100 | Source path from which the files to create the changeset will be | ||
| 101 | sourced. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 B<REQUIRED> SourceType => Str | ||
| 106 | |||
| 107 | Type of the data source from which the files to create the changeset | ||
| 108 | will be sourced. | ||
| 109 | |||
| 110 | =over | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | C<S3> - Amazon S3. | ||
| 115 | |||
| 116 | =back | ||
| 117 | |||
| 118 | |||
| 119 | Valid values are: C<"S3"> | ||
| 120 | |||
| 121 | =head2 Tags => L<Paws::FinspaceData::StringMap> | ||
| 122 | |||
| 123 | Metadata tags to apply to this changeset. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head1 SEE ALSO | ||
| 129 | |||
| 130 | This class forms part of L<Paws>, documenting arguments for method CreateChangeset in L<Paws::FinspaceData> | ||
| 131 | |||
| 132 | =head1 BUGS and CONTRIBUTIONS | ||
| 133 | |||
| 134 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 135 | |||
| 136 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 137 | |||
| 138 | =cut | ||
| 139 |