Infoblox::Notification::REST::TemplateParameter - A REST API template parameter.

• NAME
• DESCRIPTION
• CONSTRUCTOR
• SESSION METHODS
• MODULE METHODS
• Infoblox::Notification::REST::TemplateInstance->parameters( )
• METHODS
• default_value( )
• name( )
• syntax( )
• value( )
• AUTHOR
• SEE ALSO
• COPYRIGHT

NAME

Infoblox::Notification::REST::TemplateParameter - A REST API template parameter.

DESCRIPTION

The REST API template parameter is used to configure REST API template instance variables.

CONSTRUCTOR

 my $templ_parameter = Infoblox::Notification::REST::TemplateParameter->new(
     name          => $string,                # Required
     syntax        => 'STR' | 'INT' | 'BOOL', # Required
     value         => $string,                # Optional / Default is undefined
 );

SESSION METHODS

The object does not have any session methods.

MODULE METHODS

This section describes all the functions that you can apply to REST API template parameter object.

Infoblox::Notification::REST::TemplateInstance->parameters( )

Use this method to set or retrieve the list of REST API template parameters. See Infoblox::Notification::REST::TemplateInstance->parameters() for parameters and return values.

Example

 #Get parameters value
 my $parameters = $object->parameters();

 #Modify parameters value
 $object->parameters([[$param1, $param2]);

METHODS

This section describes all the methods that you can use to configure and retrieve the attribute values of a REST API template parameter object.

default_value( )

Use this method to retrieve the template parameter default value. This is a read-only attribute.

Omit the parameter to retrieve the attribute value.

Parameter

None

Returns

The method returns the attribute value.

Example

 #Get default_value value
 my $default_value = $object->default_value();

name( )

Use this method to set or retrieve the template parameter name.

Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.

Parameter

The valid value is desired name in string format.

Returns

If you have specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.

If you did not specify a parameter, the method returns the attribute value.

Example

 #Get name value
 my $name = $object->name();

 #Modify name value
 $object->name('param1');

syntax( )

Use this method to set or retrieve the template parameter syntax.

Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.

Parameter

The valid values are 'BOOL', 'STR' and 'INT'.

Returns

If you have specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.

If you did not specify a parameter, the method returns the attribute value.

Example

 #Get syntax value
 my $syntax = $object->syntax();

 #Modify syntax value
 $object->syntax('INT');

value( )

Use this method to set or retrieve the template parameter value.

Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.

Parameter

The desired value in string format.

Returns

If you have specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.

If you did not specify a parameter, the method returns the attribute value.

Example

 #Get value value
 my $value = $object->value();

 #Modify value value
 $object->value('val');

AUTHOR

Infoblox Inc. http://www.infoblox.com/

SEE ALSO

Infoblox::Notification::REST::TemplateInstance, Infoblox::Notification::REST::TemplateInstance->parameters()

COPYRIGHT

Copyright (c) 2017 Infoblox Inc.