Class: Line::Bot::V2::ManageAudience::AudienceGroupJob

Inherits:
Object
  • Object
show all
Defined in:
lib/line/bot/v2/manage_audience/model/audience_group_job.rb

Overview

Audience group job

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(audience_group_job_id: nil, audience_group_id: nil, description: nil, type: nil, job_status: nil, failed_type: nil, audience_count: nil, created: nil, **dynamic_attributes) ⇒ AudienceGroupJob

Returns a new instance of AudienceGroupJob.

Parameters:

  • audience_group_job_id (Integer, nil) (defaults to: nil) —

    A job ID.

  • audience_group_id (Integer, nil) (defaults to: nil) —

    An audience ID.

  • description (String, nil) (defaults to: nil) —

    The job’s description.

  • type (String, nil) (defaults to: nil) —

    (‘DIFF_ADD’)

  • job_status (String, nil) (defaults to: nil) —

    (‘QUEUED’|‘WORKING’|‘FINISHED’|‘FAILED’)

  • failed_type (String, nil) (defaults to: nil) —

    (‘INTERNAL_ERROR’|‘AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT’)

  • audience_count (Integer, nil) (defaults to: nil) —

    The number of accounts (recipients) that were added or removed.

  • created (Integer, nil) (defaults to: nil) —

    When the job was created (in UNIX time).



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/line/bot/v2/manage_audience/model/audience_group_job.rb', line 50

def initialize(
  audience_group_job_id: nil,
  audience_group_id: nil,
  description: nil,
  type: nil,
  job_status: nil,
  failed_type: nil,
  audience_count: nil,
  created: nil,
  **dynamic_attributes
)
  
  @audience_group_job_id = audience_group_job_id
  @audience_group_id = audience_group_id
  @description = description
  @type = type
  @job_status = job_status
  @failed_type = failed_type
  @audience_count = audience_count
  @created = created

  dynamic_attributes.each do |key, value|
    self.class.attr_accessor key

    if value.is_a?(Hash)
      struct_klass = Struct.new(*value.keys.map(&:to_sym))
      struct_values = value.map { |_k, v| v.is_a?(Hash) ? Line::Bot::V2::Utils.hash_to_struct(v) : v }
      instance_variable_set("@#{key}", struct_klass.new(*struct_values))
    else
      instance_variable_set("@#{key}", value)
    end
  end
end

Instance Attribute Details

#audience_count ⇒ Integer?

Returns The number of accounts (recipients) that were added or removed.

Returns:

  • (Integer, nil) —

    The number of accounts (recipients) that were added or removed.



37
38
39
 
# File 'lib/line/bot/v2/manage_audience/model/audience_group_job.rb', line 37

def audience_count
  @audience_count
end

#audience_group_id ⇒ Integer?

Returns An audience ID.

Returns:

  • (Integer, nil) —

    An audience ID.



22
23
24
 
# File 'lib/line/bot/v2/manage_audience/model/audience_group_job.rb', line 22

def audience_group_id
  @audience_group_id
end

#audience_group_job_id ⇒ Integer?

Returns A job ID.

Returns:

  • (Integer, nil) —

    A job ID.



19
20
21
 
# File 'lib/line/bot/v2/manage_audience/model/audience_group_job.rb', line 19

def audience_group_job_id
  @audience_group_job_id
end

#created ⇒ Integer?

Returns When the job was created (in UNIX time).

Returns:

  • (Integer, nil) —

    When the job was created (in UNIX time).



40
41
42
 
# File 'lib/line/bot/v2/manage_audience/model/audience_group_job.rb', line 40

def created
  @created
end

#description ⇒ String?

Returns The job’s description.

Returns:

  • (String, nil) —

    The job’s description.



25
26
27
 
# File 'lib/line/bot/v2/manage_audience/model/audience_group_job.rb', line 25

def description
  @description
end

#failed_type ⇒ String?

Returns (‘INTERNAL_ERROR’|‘AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT’).

Returns:

  • (String, nil) —

    (‘INTERNAL_ERROR’|‘AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT’)



34
35
36
 
# File 'lib/line/bot/v2/manage_audience/model/audience_group_job.rb', line 34

def failed_type
  @failed_type
end

#job_status ⇒ String?

Returns (‘QUEUED’|‘WORKING’|‘FINISHED’|‘FAILED’).

Returns:

  • (String, nil) —

    (‘QUEUED’|‘WORKING’|‘FINISHED’|‘FAILED’)



31
32
33
 
# File 'lib/line/bot/v2/manage_audience/model/audience_group_job.rb', line 31

def job_status
  @job_status
end

#type ⇒ String?

Returns (‘DIFF_ADD’).

Returns:

  • (String, nil) —

    (‘DIFF_ADD’)



28
29
30
 
# File 'lib/line/bot/v2/manage_audience/model/audience_group_job.rb', line 28

def type
  @type
end

Class Method Details

.create(args) ⇒ Line::Bot::V2::ManageAudience::AudienceGroupJob

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



87
88
89
90
 
# File 'lib/line/bot/v2/manage_audience/model/audience_group_job.rb', line 87

def self.create(args) # steep:ignore
  symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
  return new(**symbolized_args) # steep:ignore
end

Instance Method Details

#==(other) ⇒ Boolean

Returns true if the objects are equal, false otherwise.

Parameters:

  • other (Object) —

    Object to compare

Returns:

  • (Boolean) —

    true if the objects are equal, false otherwise



94
95
96
97
98
99
100
 
# File 'lib/line/bot/v2/manage_audience/model/audience_group_job.rb', line 94

def ==(other)
  return false unless self.class == other.class

  instance_variables.all? do |var|
      instance_variable_get(var) == other.instance_variable_get(var)
  end
end

#hash ⇒ Integer

Returns Hash code of the object.

Returns:

  • (Integer) —

    Hash code of the object



103
104
105
 
# File 'lib/line/bot/v2/manage_audience/model/audience_group_job.rb', line 103

def hash
  [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash
end