Class: SDM::Query

Inherits:
Object
  • Object
show all
Defined in:
lib/models/porcelain.rb

Overview

A Query is a record of a single client request to a resource, such as a SQL query. Longer-running queries including long-running SSH commands and SSH, RDP, or Kubernetes interactive sessions will return two Query records with the same identifier, one record at the start of the query and a second record upon the completion of the query with additional detail.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(account_email: nil, account_first_name: nil, account_id: nil, account_last_name: nil, account_tags: nil, capture: nil, completed_at: nil, duration: nil, egress_node_id: nil, encrypted: nil, id: nil, query_body: nil, query_category: nil, query_hash: nil, query_key: nil, record_count: nil, remote_identity_username: nil, replayable: nil, resource_id: nil, resource_name: nil, resource_tags: nil, resource_type: nil, source_ip: nil, timestamp: nil) ⇒ Query

Returns a new instance of Query.



7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
 
# File 'lib/models/porcelain.rb', line 7004

def initialize(
  account_email: nil,
  account_first_name: nil,
  account_id: nil,
  account_last_name: nil,
  account_tags: nil,
  capture: nil,
  completed_at: nil,
  duration: nil,
  egress_node_id: nil,
  encrypted: nil,
  id: nil,
  query_body: nil,
  query_category: nil,
  query_hash: nil,
  query_key: nil,
  record_count: nil,
  remote_identity_username: nil,
  replayable: nil,
  resource_id: nil,
  resource_name: nil,
  resource_tags: nil,
  resource_type: nil,
  source_ip: nil,
  timestamp: nil
)
  @account_email =  == nil ? "" : 
  @account_first_name =  == nil ? "" : 
  @account_id =  == nil ? "" : 
  @account_last_name =  == nil ? "" : 
  @account_tags =  == nil ? SDM::_porcelain_zero_value_tags() : 
  @capture = capture == nil ? nil : capture
  @completed_at = completed_at == nil ? nil : completed_at
  @duration = duration == nil ? nil : duration
  @egress_node_id = egress_node_id == nil ? "" : egress_node_id
  @encrypted = encrypted == nil ? false : encrypted
  @id = id == nil ? "" : id
  @query_body = query_body == nil ? "" : query_body
  @query_category = query_category == nil ? "" : query_category
  @query_hash = query_hash == nil ? "" : query_hash
  @query_key = query_key == nil ? "" : query_key
  @record_count = record_count == nil ? 0 : record_count
  @remote_identity_username = remote_identity_username == nil ? "" : remote_identity_username
  @replayable = replayable == nil ? false : replayable
  @resource_id = resource_id == nil ? "" : resource_id
  @resource_name = resource_name == nil ? "" : resource_name
  @resource_tags = resource_tags == nil ? SDM::_porcelain_zero_value_tags() : resource_tags
  @resource_type = resource_type == nil ? "" : resource_type
  @source_ip = source_ip == nil ? "" : source_ip
  @timestamp = timestamp == nil ? nil : timestamp
end

Instance Attribute Details

#account_email ⇒ Object

The email of the account performing this query, at the time the query was executed. If the account email is later changed, that change will not be reflected via this field.



6945
6946
6947
 
# File 'lib/models/porcelain.rb', line 6945

def 
  @account_email
end

#account_first_name ⇒ Object

The given name of the account performing this query, at the time the query was executed. If the account is later renamed, that change will not be reflected via this field.



6948
6949
6950
 
# File 'lib/models/porcelain.rb', line 6948

def 
  @account_first_name
end

#account_id ⇒ Object

Unique identifier of the Account that performed the Query.



6950
6951
6952
 
# File 'lib/models/porcelain.rb', line 6950

def 
  @account_id
end

#account_last_name ⇒ Object

The family name of the account performing this query, at the time the query was executed. If the account is later renamed, that change will not be reflected via this field.



6953
6954
6955
 
# File 'lib/models/porcelain.rb', line 6953

def 
  @account_last_name
end

#account_tags ⇒ Object

The tags of the account accessed, at the time the query was executed. If the account tags are later changed, that change will not be reflected via this field.



6956
6957
6958
 
# File 'lib/models/porcelain.rb', line 6956

def 
  @account_tags
end

#capture ⇒ Object

For queries against SSH, Kubernetes, and RDP resources, this contains additional information about the captured query.



6959
6960
6961
 
# File 'lib/models/porcelain.rb', line 6959

def capture
  @capture
end

#completed_at ⇒ Object

The time at which the Query was completed. Empty if this record indicates the start of a long-running query.



6962
6963
6964
 
# File 'lib/models/porcelain.rb', line 6962

def completed_at
  @completed_at
end

#duration ⇒ Object

The duration of the Query.



6964
6965
6966
 
# File 'lib/models/porcelain.rb', line 6964

def duration
  @duration
end

#egress_node_id ⇒ Object

The unique ID of the node through which the Resource was accessed.



6966
6967
6968
 
# File 'lib/models/porcelain.rb', line 6966

def egress_node_id
  @egress_node_id
end

#encrypted ⇒ Object

Indicates that the body of the Query is encrypted.



6968
6969
6970
 
# File 'lib/models/porcelain.rb', line 6968

def encrypted
  @encrypted
end

#id ⇒ Object

Unique identifier of the Query.



6970
6971
6972
 
# File 'lib/models/porcelain.rb', line 6970

def id
  @id
end

#query_body ⇒ Object

The captured content of the Query. For queries against SSH, Kubernetes, and RDP resources, this contains a JSON representation of the QueryCapture.



6973
6974
6975
 
# File 'lib/models/porcelain.rb', line 6973

def query_body
  @query_body
end

#query_category ⇒ Object

The general category of Resource against which Query was performed, e.g. "web" or "cloud".



6975
6976
6977
 
# File 'lib/models/porcelain.rb', line 6975

def query_category
  @query_category
end

#query_hash ⇒ Object

The hash of the body of the Query.



6977
6978
6979
 
# File 'lib/models/porcelain.rb', line 6977

def query_hash
  @query_hash
end

#query_key ⇒ Object

The symmetric key used to encrypt the body of this Query and its replay if replayable. If the Query is encrypted, this field contains an encrypted symmetric key in base64 encoding. This key must be decrypted with the organization's private key to obtain the symmetric key needed to decrypt the body. If the Query is not encrypted, this field is empty.



6982
6983
6984
 
# File 'lib/models/porcelain.rb', line 6982

def query_key
  @query_key
end

#record_count ⇒ Object

The number of records returned by the Query, for a database Resource.



6984
6985
6986
 
# File 'lib/models/porcelain.rb', line 6984

def record_count
  @record_count
end

#remote_identity_username ⇒ Object

The username of the RemoteIdentity used to access the Resource.



6986
6987
6988
 
# File 'lib/models/porcelain.rb', line 6986

def remote_identity_username
  @remote_identity_username
end

#replayable ⇒ Object

Indicates that the Query is replayable, e.g. for some SSH or K8s sessions.



6988
6989
6990
 
# File 'lib/models/porcelain.rb', line 6988

def replayable
  @replayable
end

#resource_id ⇒ Object

Unique identifier of the Resource against which the Query was performed.



6990
6991
6992
 
# File 'lib/models/porcelain.rb', line 6990

def resource_id
  @resource_id
end

#resource_name ⇒ Object

The name of the resource accessed, at the time the query was executed. If the resource is later renamed, that change will not be reflected via this field.



6993
6994
6995
 
# File 'lib/models/porcelain.rb', line 6993

def resource_name
  @resource_name
end

#resource_tags ⇒ Object

The tags of the resource accessed, at the time the query was executed. If the resource tags are later changed, that change will not be reflected via this field.



6996
6997
6998
 
# File 'lib/models/porcelain.rb', line 6996

def resource_tags
  @resource_tags
end

#resource_type ⇒ Object

The specific type of Resource against which the Query was performed, e.g. "ssh" or "postgres".



6998
6999
7000
 
# File 'lib/models/porcelain.rb', line 6998

def resource_type
  @resource_type
end

#source_ip ⇒ Object

The IP address the Query was performed from, as detected at the ingress gateway.



7000
7001
7002
 
# File 'lib/models/porcelain.rb', line 7000

def source_ip
  @source_ip
end

#timestamp ⇒ Object

The time at which the Query was started.



7002
7003
7004
 
# File 'lib/models/porcelain.rb', line 7002

def timestamp
  @timestamp
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



7056
7057
7058
7059
7060
7061
7062
 
# File 'lib/models/porcelain.rb', line 7056

def to_json(options = {})
  hash = {}
  self.instance_variables.each do |var|
    hash[var.id2name.delete_prefix("@")] = self.instance_variable_get var
  end
  hash.to_json
end