Class: Files::UserSftpClientUse

Inherits:
Object
  • Object
show all
Defined in:
lib/files.com/models/user_sftp_client_use.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}, options = {}) ⇒ UserSftpClientUse

Returns a new instance of UserSftpClientUse.



7
8
9
10
 
# File 'lib/files.com/models/user_sftp_client_use.rb', line 7

def initialize(attributes = {}, options = {})
  @attributes = attributes || {}
  @options = options || {}
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



5
6
7
 
# File 'lib/files.com/models/user_sftp_client_use.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



5
6
7
 
# File 'lib/files.com/models/user_sftp_client_use.rb', line 5

def options
  @options
end

Class Method Details

.all(params = {}, options = {}) ⇒ Object 



51
52
53
 
# File 'lib/files.com/models/user_sftp_client_use.rb', line 51

def self.all(params = {}, options = {})
  list(params, options)
end

.list(params = {}, options = {}) ⇒ Object

Parameters:

user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).

Raises:



41
42
43
44
45
46
47
48
49
 
# File 'lib/files.com/models/user_sftp_client_use.rb', line 41

def self.list(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)

  List.new(UserSftpClientUse, params) do
    Api.send_request("/user_sftp_client_uses", :get, params, options)
  end
end

Instance Method Details

#created_at ⇒ Object

date-time - The earliest recorded use of this SFTP client (for this user)



23
24
25
 
# File 'lib/files.com/models/user_sftp_client_use.rb', line 23

def created_at
  @attributes[:created_at]
end

#id ⇒ Object

int64 - UserSftpClientUse ID



13
14
15
 
# File 'lib/files.com/models/user_sftp_client_use.rb', line 13

def id
  @attributes[:id]
end

#sftp_client ⇒ Object

string - The SFTP client used



18
19
20
 
# File 'lib/files.com/models/user_sftp_client_use.rb', line 18

def sftp_client
  @attributes[:sftp_client]
end

#updated_at ⇒ Object

date-time - The most recent use of this SFTP client (for this user)



28
29
30
 
# File 'lib/files.com/models/user_sftp_client_use.rb', line 28

def updated_at
  @attributes[:updated_at]
end

#user_id ⇒ Object

int64 - ID of the user who performed this access



33
34
35
 
# File 'lib/files.com/models/user_sftp_client_use.rb', line 33

def user_id
  @attributes[:user_id]
end