Class: BrickFTP::Types::History

Inherits:
Struct
  • Object
show all
Includes:
IgnoreUndefinedAttributes
Defined in:
lib/brick_ftp/types/history.rb

Overview

The notification object

ATTRIBUTE TYPE DESCRIPTION
id integer Globally unique identifier of each history entry.
when datetime Date of the history entry.
user_id integer ID of the user associated with the history entry.
username string Username of the user associated with the history entry.
action string Type of action that occurred. Will be one of the following:
create, read, update, destroy, move, login, failedlogin, copy, user_create, user_destroy, group_create, group_destroy, permission_create, permission_destroy.
failure_type string Type of failure that occurred, if any.
path string Path of the file or folder associated with the history entry.
source string Source path associated with the history entry.
destination string Destination path associated with the history entry.
targets object Object containing the target object(s) for user_create, user_destroy, group_create, group_destroy, permission_create, and permission_destroy actions.
A user target will include an id and username. A group target will include an id and name. A permission target will include an id, permission, and a recursive parameter.
ip string IP address associated with the history entry.
interface string Interface associated with the history entry. Will be one of the following: web, ftp, robot, jsapi, restapi, sftp, dav.

See Also:

Instance Attribute Summary collapse

Method Summary

Methods included from IgnoreUndefinedAttributes

#initialize

Instance Attribute Details

#action ⇒ Object

Returns the value of attribute action

Returns:

  • (Object) —

    the current value of action



26
27
28
 
# File 'lib/brick_ftp/types/history.rb', line 26

def action
  @action
end

#destination ⇒ Object

Returns the value of attribute destination

Returns:

  • (Object) —

    the current value of destination



26
27
28
 
# File 'lib/brick_ftp/types/history.rb', line 26

def destination
  @destination
end

#failure_type ⇒ Object

Returns the value of attribute failure_type

Returns:

  • (Object) —

    the current value of failure_type



26
27
28
 
# File 'lib/brick_ftp/types/history.rb', line 26

def failure_type
  @failure_type
end

#id ⇒ Object

Returns the value of attribute id

Returns:

  • (Object) —

    the current value of id



26
27
28
 
# File 'lib/brick_ftp/types/history.rb', line 26

def id
  @id
end

#interface ⇒ Object

Returns the value of attribute interface

Returns:

  • (Object) —

    the current value of interface



26
27
28
 
# File 'lib/brick_ftp/types/history.rb', line 26

def interface
  @interface
end

#ip ⇒ Object

Returns the value of attribute ip

Returns:

  • (Object) —

    the current value of ip



26
27
28
 
# File 'lib/brick_ftp/types/history.rb', line 26

def ip
  @ip
end

#path ⇒ Object

Returns the value of attribute path

Returns:

  • (Object) —

    the current value of path



26
27
28
 
# File 'lib/brick_ftp/types/history.rb', line 26

def path
  @path
end

#source ⇒ Object

Returns the value of attribute source

Returns:

  • (Object) —

    the current value of source



26
27
28
 
# File 'lib/brick_ftp/types/history.rb', line 26

def source
  @source
end

#targets ⇒ Object

Returns the value of attribute targets

Returns:

  • (Object) —

    the current value of targets



26
27
28
 
# File 'lib/brick_ftp/types/history.rb', line 26

def targets
  @targets
end

#user_id ⇒ Object

Returns the value of attribute user_id

Returns:

  • (Object) —

    the current value of user_id



26
27
28
 
# File 'lib/brick_ftp/types/history.rb', line 26

def user_id
  @user_id
end

#username ⇒ Object

Returns the value of attribute username

Returns:

  • (Object) —

    the current value of username



26
27
28
 
# File 'lib/brick_ftp/types/history.rb', line 26

def username
  @username
end

#when ⇒ Object

Returns the value of attribute when

Returns:

  • (Object) —

    the current value of when



26
27
28
 
# File 'lib/brick_ftp/types/history.rb', line 26

def when
  @when
end