Class: StarkInfra::PixRequest::Log

Inherits:
Utils::Resource show all
Defined in:
lib/pixrequest/log.rb

Overview

# PixRequest::Log object

Every time a PixRequest entity is modified, a corresponding PixRequest::Log is generated for the entity. This log is never generated by the user.

## Attributes:

  • id [string]: unique id returned when the log is created. ex: ‘5656565656565656’

  • created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)

  • type [string]: type of the PixRequest event which triggered the log creation. ex: ‘processing’ or ‘success’

  • errors [list of strings]: list of errors linked to this PixRequest event.

  • request [PixRequest]: PixRequest entity to which the log refers to.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Utils::SubResource

#inspect, #to_s

Constructor Details

#initialize(id:, created:, type:, errors:, request:) ⇒ Log

Returns a new instance of Log.

[View source]

24
25
26
27
28
29
30
 
# File 'lib/pixrequest/log.rb', line 24

def initialize(id:, created:, type:, errors:, request:)
  super(id)
  @created = StarkInfra::Utils::Checks.check_datetime(created)
  @type = type
  @errors = errors
  @request = request
end

Instance Attribute Details

#created ⇒ Object (readonly)

Returns the value of attribute created.


23
24
25
 
# File 'lib/pixrequest/log.rb', line 23

def created
  @created
end

#errors ⇒ Object (readonly)

Returns the value of attribute errors.


23
24
25
 
# File 'lib/pixrequest/log.rb', line 23

def errors
  @errors
end

#id ⇒ Object (readonly)

Returns the value of attribute id.


23
24
25
 
# File 'lib/pixrequest/log.rb', line 23

def id
  @id
end

#request ⇒ Object (readonly)

Returns the value of attribute request.


23
24
25
 
# File 'lib/pixrequest/log.rb', line 23

def request
  @request
end

#type ⇒ Object (readonly)

Returns the value of attribute type.


23
24
25
 
# File 'lib/pixrequest/log.rb', line 23

def type
  @type
end

Class Method Details

.get(id, user: nil) ⇒ Object

# Retrieve a specific Log

Receive a single Log object previously created by the Stark Infra API by passing its id

## Parameters (required):

  • id [string]: object unique id. ex: ‘5656565656565656’

## Parameters (optional):

  • user [Organization/Project object]: Organization or Project object. Not necessary if StarkInfra.user was set before function call

## Return:

  • Log object with updated attributes

[View source]

44
45
46
 
# File 'lib/pixrequest/log.rb', line 44

def self.get(id, user: nil)
  StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
end

.page(cursor: nil, limit: nil, after: nil, before: nil, types: nil, request_ids: nil, user: nil) ⇒ Object

# Retrieve paged Logs

Receive a list of up to 100 Log objects previously created in the Stark Infra API and the cursor to the next page. Use this function instead of query if you want to manually page your requests.

## Parameters (optional):

  • cursor [string, default nil]: cursor returned on the previous page function call

  • limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35

  • after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)

  • before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)

  • types [list of strings, default nil]: filter retrieved objects by types. ex: ‘success’ or ‘failed’

  • request_ids [list of strings, default nil]: list of PixRequest ids to filter retrieved objects. ex: [‘5656565656565656’, ‘4545454545454545’]

  • user [Organization/Project object]: Organization or Project object. Not necessary if StarkInfra.user was set before function call

## Return:

  • list of Log objects with updated attributes

  • Cursor to retrieve the next page of Log objects

[View source]

93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/pixrequest/log.rb', line 93

def self.page(cursor: nil, limit: nil, after: nil, before: nil, types: nil, request_ids: nil, user: nil)
  after = StarkInfra::Utils::Checks.check_date(after)
  before = StarkInfra::Utils::Checks.check_date(before)
  return StarkInfra::Utils::Rest.get_page(
    cursor: cursor,
    limit: limit,
    after: after,
    before: before,
    types: types,
    request_ids: request_ids,
    user: user,
    **resource
  )
end

.query(limit: nil, after: nil, before: nil, types: nil, request_ids: nil, user: nil) ⇒ Object

# Retrieve Logs

Receive a generator of Log objects previously created in the Stark Infra API

## Parameters (optional):

  • limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35

  • after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)

  • before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)

  • types [list of strings, default nil]: filter retrieved objects by types. ex: ‘success’ or ‘failed’

  • request_ids [list of strings, default nil]: list of PixRequest ids to filter retrieved objects. ex: [‘5656565656565656’, ‘4545454545454545’]

  • user [Organization/Project object]: Organization or Project object. Not necessary if StarkInfra.user was set before function call

## Return:

  • list of Log objects with updated attributes

[View source]

62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/pixrequest/log.rb', line 62

def self.query(limit: nil, after: nil, before: nil, types: nil, request_ids: nil, user: nil)
  after = StarkInfra::Utils::Checks.check_date(after)
  before = StarkInfra::Utils::Checks.check_date(before)
  StarkInfra::Utils::Rest.get_stream(
    limit: limit,
    after: after,
    before: before,
    types: types,
    request_ids: request_ids,
    user: user,
    **resource
  )
end

.resource ⇒ Object

[View source]

108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/pixrequest/log.rb', line 108

def self.resource
  request_maker = StarkInfra::PixRequest.resource[:resource_maker]
  {
    resource_name: 'PixRequestLog',
    resource_maker: proc { |json|
      Log.new(
        id: json['id'],
        created: json['created'],
        type: json['type'],
        errors: json['errors'],
        request: StarkInfra::Utils::API.from_api_json(request_maker, json['request'])
      )
    }
  }
end