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, client_ip: nil, completed_at: nil, duration: nil, egress_node_id: nil, encrypted: nil, id: nil, identity_alias_username: 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.



8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
 
# File 'lib/models/porcelain.rb', line 8235

def initialize(
  account_email: nil,
  account_first_name: nil,
  account_id: nil,
  account_last_name: nil,
  account_tags: nil,
  capture: nil,
  client_ip: nil,
  completed_at: nil,
  duration: nil,
  egress_node_id: nil,
  encrypted: nil,
  id: nil,
  identity_alias_username: 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
  @client_ip = client_ip == nil ? "" : client_ip
  @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
  @identity_alias_username = identity_alias_username == nil ? "" : identity_alias_username
  @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.



8172
8173
8174
 
# File 'lib/models/porcelain.rb', line 8172

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.



8175
8176
8177
 
# File 'lib/models/porcelain.rb', line 8175

def 
  @account_first_name
end

#account_id ⇒ Object

Unique identifier of the Account that performed the Query.



8177
8178
8179
 
# File 'lib/models/porcelain.rb', line 8177

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.



8180
8181
8182
 
# File 'lib/models/porcelain.rb', line 8180

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.



8183
8184
8185
 
# File 'lib/models/porcelain.rb', line 8183

def 
  @account_tags
end

#capture ⇒ Object

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



8186
8187
8188
 
# File 'lib/models/porcelain.rb', line 8186

def capture
  @capture
end

#client_ip ⇒ Object

The IP address the Query was performed from, as detected at the StrongDM control plane.



8188
8189
8190
 
# File 'lib/models/porcelain.rb', line 8188

def client_ip
  @client_ip
end

#completed_at ⇒ Object

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



8191
8192
8193
 
# File 'lib/models/porcelain.rb', line 8191

def completed_at
  @completed_at
end

#duration ⇒ Object

The duration of the Query.



8193
8194
8195
 
# File 'lib/models/porcelain.rb', line 8193

def duration
  @duration
end

#egress_node_id ⇒ Object

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



8195
8196
8197
 
# File 'lib/models/porcelain.rb', line 8195

def egress_node_id
  @egress_node_id
end

#encrypted ⇒ Object

Indicates that the body of the Query is encrypted.



8197
8198
8199
 
# File 'lib/models/porcelain.rb', line 8197

def encrypted
  @encrypted
end

#id ⇒ Object

Unique identifier of the Query.



8199
8200
8201
 
# File 'lib/models/porcelain.rb', line 8199

def id
  @id
end

#identity_alias_username ⇒ Object

The username of the IdentityAlias used to access the Resource.



8201
8202
8203
 
# File 'lib/models/porcelain.rb', line 8201

def identity_alias_username
  @identity_alias_username
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.



8204
8205
8206
 
# File 'lib/models/porcelain.rb', line 8204

def query_body
  @query_body
end

#query_category ⇒ Object

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



8206
8207
8208
 
# File 'lib/models/porcelain.rb', line 8206

def query_category
  @query_category
end

#query_hash ⇒ Object

The hash of the body of the Query.



8208
8209
8210
 
# File 'lib/models/porcelain.rb', line 8208

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.



8213
8214
8215
 
# File 'lib/models/porcelain.rb', line 8213

def query_key
  @query_key
end

#record_count ⇒ Object

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



8215
8216
8217
 
# File 'lib/models/porcelain.rb', line 8215

def record_count
  @record_count
end

#remote_identity_username ⇒ Object

The username of the RemoteIdentity used to access the Resource.



8217
8218
8219
 
# File 'lib/models/porcelain.rb', line 8217

def remote_identity_username
  @remote_identity_username
end

#replayable ⇒ Object

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



8219
8220
8221
 
# File 'lib/models/porcelain.rb', line 8219

def replayable
  @replayable
end

#resource_id ⇒ Object

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



8221
8222
8223
 
# File 'lib/models/porcelain.rb', line 8221

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.



8224
8225
8226
 
# File 'lib/models/porcelain.rb', line 8224

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.



8227
8228
8229
 
# File 'lib/models/porcelain.rb', line 8227

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".



8229
8230
8231
 
# File 'lib/models/porcelain.rb', line 8229

def resource_type
  @resource_type
end

#source_ip ⇒ Object

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



8231
8232
8233
 
# File 'lib/models/porcelain.rb', line 8231

def source_ip
  @source_ip
end

#timestamp ⇒ Object

The time at which the Query was started.



8233
8234
8235
 
# File 'lib/models/porcelain.rb', line 8233

def timestamp
  @timestamp
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



8291
8292
8293
8294
8295
8296
8297
 
# File 'lib/models/porcelain.rb', line 8291

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