Infoblox::Notification::REST::TemplateInstance - A REST API template instance.

NAME
DESCRIPTION
CONSTRUCTOR
SESSION METHODS
MODULE METHODS

Infoblox::Notification::Rule->template_instance( )
Infoblox::Notification::REST::Endpoint->template_instance( )

METHODS

template( )
parameters( )

AUTHOR
SEE ALSO
COPYRIGHT

NAME

Infoblox::Notification::REST::TemplateInstance - A REST API template instance.

DESCRIPTION

The REST API template instance is used to configure REST API template setting for notification rule and REST API endpoint.

CONSTRUCTOR

 my $templ_instance = Infoblox::Notification::REST::TemplateInstance->new(
     template   => $string,                 #Required
     parameters => [$param1, $param2, ...], #Optional / Default is empty list
 );

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 instance object.

Infoblox::Notification::Rule->template_instance( )

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

Example

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

 #Modify template_instance value
 $object->template_instance($instance);

Infoblox::Notification::REST::Endpoint->template_instance( )

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

Example

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

 #Modify template_instance value
 $object->template_instance($instance);

METHODS

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

template( )

Use this method to set or retrieve the REST API template name.

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

Parameter

The valid value is an Infoblox::Notification::REST::Template object name.

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 template value
 my $template = $object->template();

 #Modify template value
 $object->template('template1');

parameters( )

Use this method to set or retrieve the list of template parameters.

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

Parameter

The valid value is array of Infoblox::Notification::REST::TemplateParameter objects.

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 parameters value
 my $parameters = $object->parameters();

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

AUTHOR

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