Graham Ollis > Clustericious-Client > Clustericious::Client::Meta::Route

Download:
Clustericious-Client-0.85.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.85   Source  

NAME ^

Clustericious::Client::Meta::Route - metadata about a route'

VERSION ^

version 0.85

SYNOPSIS ^

    my $meta = Clustericious::Client::Meta::Route->new(
            client_class => 'Yars::Client',
            route_name => 'bucket_map,
        );
    $meta->get('auto_failover');

set

Set a route attribute.

  $meta->set(auto_failover => 1);

get

Get a route attribute.

 $meta->get('auto_failover');

doc

Get documentation for this route.

set_doc

Set the documentation for a route.

client_class

The class of the client associated with this object.

route_name

The name of the route to which this object refers.

process_args

Process an array of arguments sent to this route.

This will look at the the route_arg specification that has been set up for this route, and use it to turn an array of parameters into hash for use by the method.

If any of the args have a 'preprocess' (list, yamldoc, datetime), then those transformations are applied.

If any required parameters are missing, an exception is thrown.

If any parameters have an 'alt' entry or are abbreviated, the full name is used instead.

Returns a hash of arguments, dies on failure.

See route_arg for a complete description of how arguments will be processed. Note that modifies_url entries are not processed here; that occurs just before the request is made.

DESCRIPTION ^

Keep track of metadata about a particular route. This includes documentation and attributes.

SEE ALSO ^

Clustericious::Client::Meta

AUTHOR ^

original author: Curt Tilmes

current maintainer: Graham Ollis <plicease@cpan.org>

contributors:

Brian Duggan

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2013 by NASA GSFC.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: