Class: OCI::Devops::Models::PullRequestComment

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/devops/models/pull_request_comment.rb

Overview

User comments created by reviewers during the pull request review.

Constant Summary collapse

FILE_TYPE_ENUM = 
[
  FILE_TYPE_SOURCE = 'SOURCE'.freeze,
  FILE_TYPE_DESTINATION = 'DESTINATION'.freeze,
  FILE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_ACTIVE = 'ACTIVE'.freeze,
  STATUS_OUTDATED = 'OUTDATED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
CONTEXT_STATUS_ENUM = 
[
  CONTEXT_STATUS_PROCESSED = 'PROCESSED'.freeze,
  CONTEXT_STATUS_NEEDS_PROCESSING = 'NEEDS_PROCESSING'.freeze,
  CONTEXT_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PullRequestComment

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 162

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.pull_request_id = attributes[:'pullRequestId'] if attributes[:'pullRequestId']

  raise 'You cannot provide both :pullRequestId and :pull_request_id' if attributes.key?(:'pullRequestId') && attributes.key?(:'pull_request_id')

  self.pull_request_id = attributes[:'pull_request_id'] if attributes[:'pull_request_id']

  self.data = attributes[:'data'] if attributes[:'data']

  self.parent_id = attributes[:'parentId'] if attributes[:'parentId']

  raise 'You cannot provide both :parentId and :parent_id' if attributes.key?(:'parentId') && attributes.key?(:'parent_id')

  self.parent_id = attributes[:'parent_id'] if attributes[:'parent_id']

  self.file_path = attributes[:'filePath'] if attributes[:'filePath']

  raise 'You cannot provide both :filePath and :file_path' if attributes.key?(:'filePath') && attributes.key?(:'file_path')

  self.file_path = attributes[:'file_path'] if attributes[:'file_path']

  self.commit_id = attributes[:'commitId'] if attributes[:'commitId']

  raise 'You cannot provide both :commitId and :commit_id' if attributes.key?(:'commitId') && attributes.key?(:'commit_id')

  self.commit_id = attributes[:'commit_id'] if attributes[:'commit_id']

  self.file_type = attributes[:'fileType'] if attributes[:'fileType']

  raise 'You cannot provide both :fileType and :file_type' if attributes.key?(:'fileType') && attributes.key?(:'file_type')

  self.file_type = attributes[:'file_type'] if attributes[:'file_type']

  self.line_number = attributes[:'lineNumber'] if attributes[:'lineNumber']

  raise 'You cannot provide both :lineNumber and :line_number' if attributes.key?(:'lineNumber') && attributes.key?(:'line_number')

  self.line_number = attributes[:'line_number'] if attributes[:'line_number']

  self.likes = attributes[:'likes'] if attributes[:'likes']

  self.status = attributes[:'status'] if attributes[:'status']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.created_by = attributes[:'createdBy'] if attributes[:'createdBy']

  raise 'You cannot provide both :createdBy and :created_by' if attributes.key?(:'createdBy') && attributes.key?(:'created_by')

  self.created_by = attributes[:'created_by'] if attributes[:'created_by']

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

  raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated')

  self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated']

  self.updated_by = attributes[:'updatedBy'] if attributes[:'updatedBy']

  raise 'You cannot provide both :updatedBy and :updated_by' if attributes.key?(:'updatedBy') && attributes.key?(:'updated_by')

  self.updated_by = attributes[:'updated_by'] if attributes[:'updated_by']

  self.context_status = attributes[:'contextStatus'] if attributes[:'contextStatus']

  raise 'You cannot provide both :contextStatus and :context_status' if attributes.key?(:'contextStatus') && attributes.key?(:'context_status')

  self.context_status = attributes[:'context_status'] if attributes[:'context_status']

  self.comment_context = attributes[:'commentContext'] if attributes[:'commentContext']

  raise 'You cannot provide both :commentContext and :comment_context' if attributes.key?(:'commentContext') && attributes.key?(:'comment_context')

  self.comment_context = attributes[:'comment_context'] if attributes[:'comment_context']
end

Instance Attribute Details

#comment_context ⇒ Array<OCI::Devops::Models::DiffLineDetails>

4 line snippet to be displayed as context for inline comments

Returns:



90
91
92
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 90

def comment_context
  @comment_context
end

#commit_id ⇒ String

Commit SHA

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 52

def commit_id
  @commit_id
end

#context_status ⇒ String

Shows the status of an inline comments context

Returns:

  • (String) 


86
87
88
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 86

def context_status
  @context_status
end

#created_by ⇒ OCI::Devops::Models::PrincipalDetails

This attribute is required.

Returns:



75
76
77
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 75

def created_by
  @created_by
end

#data ⇒ String

[Required] Content of the Comment.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 40

def data
  @data
end

#file_path ⇒ String

File path in the commit

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 48

def file_path
  @file_path
end

#file_type ⇒ String

File path in the target commit

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 56

def file_type
  @file_type
end

#id ⇒ String

[Required] Unique identifier that is immutable on creation

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 32

def id
  @id
end

#likes ⇒ OCI::Devops::Models::PullRequestCommentLikeCollection

Returns:



63
64
65
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 63

def likes
  @likes
end

#line_number ⇒ Integer

Line number in the file

Returns:

  • (Integer) 


60
61
62
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 60

def line_number
  @line_number
end

#parent_id ⇒ String

ID of parent Comment

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 44

def parent_id
  @parent_id
end

#pull_request_id ⇒ String

[Required] OCID of the pull request that this comment belongs to

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 36

def pull_request_id
  @pull_request_id
end

#status ⇒ String

[Required] Status of the Comment

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 67

def status
  @status
end

#time_created ⇒ DateTime

[Required] Creation timestamp. Format defined by RFC3339.

Returns:

  • (DateTime) 


71
72
73
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 71

def time_created
  @time_created
end

#time_updated ⇒ DateTime

Latest update timestamp. Format defined by RFC3339.

Returns:

  • (DateTime) 


79
80
81
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 79

def time_updated
  @time_updated
end

#updated_by ⇒ OCI::Devops::Models::PrincipalDetails

Returns:



82
83
84
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 82

def updated_by
  @updated_by
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 93

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'pull_request_id': :'pullRequestId',
    'data': :'data',
    'parent_id': :'parentId',
    'file_path': :'filePath',
    'commit_id': :'commitId',
    'file_type': :'fileType',
    'line_number': :'lineNumber',
    'likes': :'likes',
    'status': :'status',
    'time_created': :'timeCreated',
    'created_by': :'createdBy',
    'time_updated': :'timeUpdated',
    'updated_by': :'updatedBy',
    'context_status': :'contextStatus',
    'comment_context': :'commentContext'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 117

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'pull_request_id': :'String',
    'data': :'String',
    'parent_id': :'String',
    'file_path': :'String',
    'commit_id': :'String',
    'file_type': :'String',
    'line_number': :'Integer',
    'likes': :'OCI::Devops::Models::PullRequestCommentLikeCollection',
    'status': :'String',
    'time_created': :'DateTime',
    'created_by': :'OCI::Devops::Models::PrincipalDetails',
    'time_updated': :'DateTime',
    'updated_by': :'OCI::Devops::Models::PrincipalDetails',
    'context_status': :'String',
    'comment_context': :'Array<OCI::Devops::Models::DiffLineDetails>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 295

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    pull_request_id == other.pull_request_id &&
    data == other.data &&
    parent_id == other.parent_id &&
    file_path == other.file_path &&
    commit_id == other.commit_id &&
    file_type == other.file_type &&
    line_number == other.line_number &&
    likes == other.likes &&
    status == other.status &&
    time_created == other.time_created &&
    created_by == other.created_by &&
    time_updated == other.time_updated &&
    updated_by == other.updated_by &&
    context_status == other.context_status &&
    comment_context == other.comment_context
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 340

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


320
321
322
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 320

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



329
330
331
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 329

def hash
  [id, pull_request_id, data, parent_id, file_path, commit_id, file_type, line_number, likes, status, time_created, created_by, time_updated, updated_by, context_status, comment_context].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



373
374
375
376
377
378
379
380
381
382
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 373

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



367
368
369
 
# File 'lib/oci/devops/models/pull_request_comment.rb', line 367

def to_s
  to_hash.to_s
end