Com::Vmware::Vapi::Std::Errors::ArgumentLocations Class Reference

Inheritance diagram for Com::Vmware::Vapi::Std::Errors::ArgumentLocations:

Avaliable Methods
public method	set_secondary ()
public method	get_secondary ()
public method	set_primary ()
public method	get_primary ()
public method	new ()

Detailed Description

The Com::Vmware::Vapi::Std::Errors::ArgumentLocations class describes which part(s) of the input to the method caused the error .

Some types of errors are caused by the value of one of the inputs to the method , possibly due to an interaction with other inputs to the method . This class is intended to be used as the payload to identify those inputs when the method reports errors like class Com::Vmware::Vapi::Std::Errors::InvalidArgument or class Com::Vmware::Vapi::Std::Errors::NotFound . See :attr:Com::Vmware::Vapi::Std::Errors::Error.data .

Member Function Documentation

public method Com::Vmware::Vapi::Std::Errors::ArgumentLocations::get_primary

(

)

Gets the value of 'primary' property.

Return values

primary

- The current value of the field. String describing the location of the input that triggered the error . String#

Code:

public method Com::Vmware::Vapi::Std::Errors::ArgumentLocations::get_secondary

(

)

Gets the value of 'secondary' property.

Return values

secondary

- The current value of the field. List* (possibly empty) of strings describing the locations of other inputs that caused the the primary input to trigger the error . List#

Code:

public method Com::Vmware::Vapi::Std::Errors::ArgumentLocations::new

(

)

Constructor to initialize the Com::Vmware::Vapi::Std::Errors::ArgumentLocations structure

Return values

Blessed

object

Code:

public method Com::Vmware::Vapi::Std::Errors::ArgumentLocations::set_primary

(

)

Sets the given value for 'primary' property.

Parameters

primary

- New value for the field. String describing the location of the input that triggered the error .

Code:

public method Com::Vmware::Vapi::Std::Errors::ArgumentLocations::set_secondary

(

)

Sets the given value for 'secondary' property.

Parameters

secondary

- New value for the field. List* (possibly empty) of strings describing the locations of other inputs that caused the the primary input to trigger the error .

Code:

---

The documentation for this class was generated from the following file:

• Com/Vmware/Vapi/Std/Errors/ArgumentLocations.pm