Class: Verifalia::EmailValidations::Overview

Inherits:
Object
  • Object
show all
Defined in:
lib/verifalia/email_validation/overview.rb

Overview

Overview information for an email validation job.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, submitted_on, completed_on, priority, name, owner, client_ip, created_on, quality, retention, deduplication, status, no_of_entries, progress) ⇒ Overview

Returns a new instance of Overview.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/verifalia/email_validation/overview.rb', line 89

def initialize(id, submitted_on, completed_on, priority, name, owner, client_ip, created_on, quality, retention,
               deduplication, status, no_of_entries, progress)
  @id = id
  @status = status
  @submitted_on = submitted_on
  @completed_on = completed_on
  @priority = priority
  @name = name
  @owner = owner
  @client_ip = client_ip
  @created_on = created_on
  @quality = quality
  @retention = retention
  @deduplication = deduplication
  @no_of_entries = no_of_entries
  @progress = progress
end

Instance Attribute Details

#client_ip ⇒ Object (readonly)

The IP address of the client which submitted the validation job.



65
66
67
 
# File 'lib/verifalia/email_validation/overview.rb', line 65

def client_ip
  @client_ip
end

#completed_on ⇒ Object (readonly)

The date and time this validation job has been eventually completed.



47
48
49
 
# File 'lib/verifalia/email_validation/overview.rb', line 47

def completed_on
  @completed_on
end

#created_on ⇒ Object (readonly)

The date and time the validation job was created.



68
69
70
 
# File 'lib/verifalia/email_validation/overview.rb', line 68

def created_on
  @created_on
end

#deduplication ⇒ Object (readonly)

A deduplication mode option which affected the way Verifalia eventually marked entries as duplicates upon processing.



81
82
83
 
# File 'lib/verifalia/email_validation/overview.rb', line 81

def deduplication
  @deduplication
end

#id ⇒ Object (readonly)

The unique identifier for the validation job.



37
38
39
 
# File 'lib/verifalia/email_validation/overview.rb', line 37

def id
  @id
end

#name ⇒ Object (readonly)

An optional user-defined name for the validation job, for your own reference.



59
60
61
 
# File 'lib/verifalia/email_validation/overview.rb', line 59

def name
  @name
end

#no_of_entries ⇒ Object (readonly)

The number of entries the validation job contains.



84
85
86
 
# File 'lib/verifalia/email_validation/overview.rb', line 84

def no_of_entries
  @no_of_entries
end

#owner ⇒ Object (readonly)

The unique ID of the Verifalia user who submitted the validation job.



62
63
64
 
# File 'lib/verifalia/email_validation/overview.rb', line 62

def owner
  @owner
end

#priority ⇒ Object (readonly)

The eventual priority (speed) of the validation job, relative to the parent Verifalia account. In the event of an account with many concurrent validation jobs, this value allows to increase the processing speed of a job with respect to the others.

The allowed range of values spans from 0 - lowest priority, to 255 - highest priority, where the midway value 127 means normal priority; if not specified, Verifalia processes all the concurrent validation jobs for an account using the same priority.



56
57
58
 
# File 'lib/verifalia/email_validation/overview.rb', line 56

def priority
  @priority
end

#progress ⇒ Object (readonly)

The eventual completion progress for the validation job.



87
88
89
 
# File 'lib/verifalia/email_validation/overview.rb', line 87

def progress
  @progress
end

#quality ⇒ Object (readonly)

A reference to the results quality level this job was validated against.



71
72
73
 
# File 'lib/verifalia/email_validation/overview.rb', line 71

def quality
  @quality
end

#retention ⇒ Object (readonly)

The maximum data retention period Verifalia observes for this verification job, after which the job will be automatically deleted.

A verification job can be deleted anytime prior to its retention period through the delete() method.



77
78
79
 
# File 'lib/verifalia/email_validation/overview.rb', line 77

def retention
  @retention
end

#status ⇒ Object (readonly)

The processing status for the validation job. See JobStatus for a list of the values supported at the time this SDK has been released.



41
42
43
 
# File 'lib/verifalia/email_validation/overview.rb', line 41

def status
  @status
end

#submitted_on ⇒ Object (readonly)

The date and time this validation job has been submitted to Verifalia.



44
45
46
 
# File 'lib/verifalia/email_validation/overview.rb', line 44

def submitted_on
  @submitted_on
end