« blib/lib/Paws/StorageGateway/PoolInfo.pm
↑ Summary
blib/lib/Paws/StorageGateway/RefreshCacheOutput.pm »
| 1 | |||
| 2 | package Paws::StorageGateway::RefreshCache; | ||
| 3 | use Moose; | ||
| 4 | has FileShareARN => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has FolderList => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | has Recursive => (is => 'ro', isa => 'Bool'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'RefreshCache'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::StorageGateway::RefreshCacheOutput'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::StorageGateway::RefreshCache - Arguments for method RefreshCache on L<Paws::StorageGateway> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method RefreshCache on the | ||
| 24 | L<AWS Storage Gateway|Paws::StorageGateway> service. Use the attributes of this class | ||
| 25 | as arguments to method RefreshCache. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RefreshCache. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $storagegateway = Paws->service('StorageGateway'); | ||
| 32 | my $RefreshCacheOutput = $storagegateway->RefreshCache( | ||
| 33 | FileShareARN => 'MyFileShareARN', | ||
| 34 | FolderList => [ | ||
| 35 | 'MyFolder', ... # min: 1, max: 1024 | ||
| 36 | ], # OPTIONAL | ||
| 37 | Recursive => 1, # OPTIONAL | ||
| 38 | ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $FileShareARN = $RefreshCacheOutput->FileShareARN; | ||
| 42 | my $NotificationId = $RefreshCacheOutput->NotificationId; | ||
| 43 | |||
| 44 | # Returns a L<Paws::StorageGateway::RefreshCacheOutput> 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/storagegateway/RefreshCache> | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> FileShareARN => Str | ||
| 53 | |||
| 54 | The Amazon Resource Name (ARN) of the file share you want to refresh. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 FolderList => ArrayRef[Str|Undef] | ||
| 59 | |||
| 60 | A comma-separated list of the paths of folders to refresh in the cache. | ||
| 61 | The default is [C<"/">]. The default refreshes objects and folders at | ||
| 62 | the root of the Amazon S3 bucket. If C<Recursive> is set to C<true>, | ||
| 63 | the entire S3 bucket that the file share has access to is refreshed. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 Recursive => Bool | ||
| 68 | |||
| 69 | A value that specifies whether to recursively refresh folders in the | ||
| 70 | cache. The refresh includes folders that were in the cache the last | ||
| 71 | time the gateway listed the folder's contents. If this value set to | ||
| 72 | C<true>, each folder that is listed in C<FolderList> is recursively | ||
| 73 | updated. Otherwise, subfolders listed in C<FolderList> are not | ||
| 74 | refreshed. Only objects that are in folders listed directly under | ||
| 75 | C<FolderList> are found and used for the update. The default is | ||
| 76 | C<true>. | ||
| 77 | |||
| 78 | Valid Values: C<true> | C<false> | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head1 SEE ALSO | ||
| 84 | |||
| 85 | This class forms part of L<Paws>, documenting arguments for method RefreshCache in L<Paws::StorageGateway> | ||
| 86 | |||
| 87 | =head1 BUGS and CONTRIBUTIONS | ||
| 88 | |||
| 89 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 90 | |||
| 91 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 92 | |||
| 93 | =cut | ||
| 94 |