Class: IControl::ARX::FileChangeResponse

Inherits:
Base::Struct
  • Object
show all
Defined in:
lib/icontrol/arx.rb,
lib/icontrol/arx.rb

Overview

A structure that contains the details of a file change response.

Instance Attribute Summary collapse

Method Summary

Methods inherited from Base::Struct

from_soap, icontrol_attribute, #to_soap

Instance Attribute Details

#change_idxString

The change index is used as a placeholder while retrieving batches of file changes. This value is provided to get_notifications in order to get the next set of file changes.

Returns:

  • (String)

    the current value of change_idx



122
123
124
# File 'lib/icontrol/arx.rb', line 122

def change_idx
  @change_idx
end

#changesIControl::ARX::FileChangeDefinitionSequence

A list of file change details.

Returns:



122
123
124
# File 'lib/icontrol/arx.rb', line 122

def changes
  @changes
end

#countNumeric

Number of file changes returned from FileChangeResponse ::getChanges.

Returns:

  • (Numeric)

    the current value of count



122
123
124
# File 'lib/icontrol/arx.rb', line 122

def count
  @count
end

#dst_rootString

Parent directory path of all file destinations returned in this response. This field is empty if it is the same as FileChangeResponse ::src_root. In this case, the caller must use the source root to reconstruct the file destination's full path.

Returns:

  • (String)

    the current value of dst_root



122
123
124
# File 'lib/icontrol/arx.rb', line 122

def dst_root
  @dst_root
end

#error_codeNumeric

Reserved for future development. Errors will be handled through the SOAP fault mechanism.

Returns:

  • (Numeric)

    the current value of error_code



122
123
124
# File 'lib/icontrol/arx.rb', line 122

def error_code
  @error_code
end

#moreObject

This is set to true when there are more file changes left to retrieve for this session and false when there are no more changes left to retrieve for the session. When this is true, the user should call get_notifications to retrieve the next batch of file changes.

Returns:

  • (Object)

    the current value of more



122
123
124
# File 'lib/icontrol/arx.rb', line 122

def more
  @more
end

#src_rootString

Parent directory path of all file sources returned in this response.

Returns:

  • (String)

    the current value of src_root



122
123
124
# File 'lib/icontrol/arx.rb', line 122

def src_root
  @src_root
end