Class: OCI::Devops::Models::Repository

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

Overview

Repositories containing the source code to build and deploy.

Constant Summary collapse

REPOSITORY_TYPE_ENUM =
[
  REPOSITORY_TYPE_MIRRORED = 'MIRRORED'.freeze,
  REPOSITORY_TYPE_HOSTED = 'HOSTED'.freeze,
  REPOSITORY_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
TRIGGER_BUILD_EVENTS_ENUM =
[
  TRIGGER_BUILD_EVENTS_PUSH = 'PUSH'.freeze,
  TRIGGER_BUILD_EVENTS_PULL_REQUEST_CREATED = 'PULL_REQUEST_CREATED'.freeze,
  TRIGGER_BUILD_EVENTS_PULL_REQUEST_UPDATED = 'PULL_REQUEST_UPDATED'.freeze,
  TRIGGER_BUILD_EVENTS_COMMIT_UPDATES = 'COMMIT_UPDATES'.freeze,
  TRIGGER_BUILD_EVENTS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Repository

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String)

    The value to assign to the #id property

  • :name (String)

    The value to assign to the #name property

  • :compartment_id (String)

    The value to assign to the #compartment_id property

  • :namespace (String)

    The value to assign to the #namespace property

  • :project_id (String)

    The value to assign to the #project_id property

  • :project_name (String)

    The value to assign to the #project_name property

  • :ssh_url (String)

    The value to assign to the #ssh_url property

  • :http_url (String)

    The value to assign to the #http_url property

  • :description (String)

    The value to assign to the #description property

  • :default_branch (String)

    The value to assign to the #default_branch property

  • :repository_type (String)

    The value to assign to the #repository_type property

  • :mirror_repository_config (OCI::Devops::Models::MirrorRepositoryConfig)

    The value to assign to the #mirror_repository_config property

  • :time_created (DateTime)

    The value to assign to the #time_created property

  • :time_updated (DateTime)

    The value to assign to the #time_updated property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :lifecyle_details (String)

    The value to assign to the #lifecyle_details property

  • :branch_count (Integer)

    The value to assign to the #branch_count property

  • :commit_count (Integer)

    The value to assign to the #commit_count property

  • :size_in_bytes (Integer)

    The value to assign to the #size_in_bytes property

  • :trigger_build_events (Array<String>)

    The value to assign to the #trigger_build_events property

  • :freeform_tags (Hash<String, String>)

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>)

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>)

    The value to assign to the #system_tags property



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
# File 'lib/oci/devops/models/repository.rb', line 224

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.name = attributes[:'name'] if attributes[:'name']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

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

  self.project_id = attributes[:'projectId'] if attributes[:'projectId']

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

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

  self.project_name = attributes[:'projectName'] if attributes[:'projectName']

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

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

  self.ssh_url = attributes[:'sshUrl'] if attributes[:'sshUrl']

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

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

  self.http_url = attributes[:'httpUrl'] if attributes[:'httpUrl']

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

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

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

  self.default_branch = attributes[:'defaultBranch'] if attributes[:'defaultBranch']
  self.default_branch = "main" if default_branch.nil? && !attributes.key?(:'defaultBranch') # rubocop:disable Style/StringLiterals

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

  self.default_branch = attributes[:'default_branch'] if attributes[:'default_branch']
  self.default_branch = "main" if default_branch.nil? && !attributes.key?(:'defaultBranch') && !attributes.key?(:'default_branch') # rubocop:disable Style/StringLiterals

  self.repository_type = attributes[:'repositoryType'] if attributes[:'repositoryType']
  self.repository_type = "HOSTED" if repository_type.nil? && !attributes.key?(:'repositoryType') # rubocop:disable Style/StringLiterals

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

  self.repository_type = attributes[:'repository_type'] if attributes[:'repository_type']
  self.repository_type = "HOSTED" if repository_type.nil? && !attributes.key?(:'repositoryType') && !attributes.key?(:'repository_type') # rubocop:disable Style/StringLiterals

  self.mirror_repository_config = attributes[:'mirrorRepositoryConfig'] if attributes[:'mirrorRepositoryConfig']

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

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

  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.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.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecyle_details = attributes[:'lifecyleDetails'] if attributes[:'lifecyleDetails']

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

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

  self.branch_count = attributes[:'branchCount'] if attributes[:'branchCount']

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

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

  self.commit_count = attributes[:'commitCount'] if attributes[:'commitCount']

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

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

  self.size_in_bytes = attributes[:'sizeInBytes'] if attributes[:'sizeInBytes']

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

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

  self.trigger_build_events = attributes[:'triggerBuildEvents'] if attributes[:'triggerBuildEvents']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#branch_countInteger

The count of the branches present in the repository.

Returns:

  • (Integer)


102
103
104
# File 'lib/oci/devops/models/repository.rb', line 102

def branch_count
  @branch_count
end

#commit_countInteger

The count of the commits present in the repository.

Returns:

  • (Integer)


106
107
108
# File 'lib/oci/devops/models/repository.rb', line 106

def commit_count
  @commit_count
end

#compartment_idString

[Required] The OCID of the repository's compartment.

Returns:

  • (String)


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

def compartment_id
  @compartment_id
end

#default_branchString

The default branch of the repository.

Returns:

  • (String)


72
73
74
# File 'lib/oci/devops/models/repository.rb', line 72

def default_branch
  @default_branch
end

#defined_tagsHash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>)


127
128
129
# File 'lib/oci/devops/models/repository.rb', line 127

def defined_tags
  @defined_tags
end

#descriptionString

Details of the repository. Avoid entering confidential information.

Returns:

  • (String)


68
69
70
# File 'lib/oci/devops/models/repository.rb', line 68

def description
  @description
end

#freeform_tagsHash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>)


123
124
125
# File 'lib/oci/devops/models/repository.rb', line 123

def freeform_tags
  @freeform_tags
end

#http_urlString

HTTP URL that you use to git clone, pull and push.

Returns:

  • (String)


64
65
66
# File 'lib/oci/devops/models/repository.rb', line 64

def http_url
  @http_url
end

#idString

[Required] The OCID of the repository. This value is unique and immutable.

Returns:

  • (String)


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

def id
  @id
end

#lifecycle_stateString

The current state of the repository.

Returns:

  • (String)


94
95
96
# File 'lib/oci/devops/models/repository.rb', line 94

def lifecycle_state
  @lifecycle_state
end

#lifecyle_detailsString

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:

  • (String)


98
99
100
# File 'lib/oci/devops/models/repository.rb', line 98

def lifecyle_details
  @lifecyle_details
end

#mirror_repository_configOCI::Devops::Models::MirrorRepositoryConfig



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

def mirror_repository_config
  @mirror_repository_config
end

#nameString

Name of the repository. Should be unique within the project. This value is mutable.

Returns:

  • (String)


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

def name
  @name
end

#namespaceString

Tenancy unique namespace.

Returns:

  • (String)


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

def namespace
  @namespace
end

#project_idString

[Required] The OCID of the DevOps project containing the repository.

Returns:

  • (String)


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

def project_id
  @project_id
end

#project_nameString

Unique project name in a namespace.

Returns:

  • (String)


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

def project_name
  @project_name
end

#repository_typeString

Type of repository: MIRRORED - Repository created by mirroring an existing repository. HOSTED - Repository created and hosted using OCI DevOps code repository.

Returns:

  • (String)


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

def repository_type
  @repository_type
end

#size_in_bytesInteger

The size of the repository in bytes.

Returns:

  • (Integer)


110
111
112
# File 'lib/oci/devops/models/repository.rb', line 110

def size_in_bytes
  @size_in_bytes
end

#ssh_urlString

SSH URL that you use to git clone, pull and push.

Returns:

  • (String)


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

def ssh_url
  @ssh_url
end

#system_tagsHash<String, Hash<String, Object>>

Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>)


131
132
133
# File 'lib/oci/devops/models/repository.rb', line 131

def system_tags
  @system_tags
end

#time_createdDateTime

The time the repository was created. Format defined by RFC3339.

Returns:

  • (DateTime)


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

def time_created
  @time_created
end

#time_updatedDateTime

The time the repository was updated. Format defined by RFC3339.

Returns:

  • (DateTime)


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

def time_updated
  @time_updated
end

#trigger_build_eventsArray<String>

Trigger build events supported for this repository: PUSH - Build is triggered when a push event occurs. PULL_REQUEST_CREATED - Build is triggered when a pull request is created in the repository. PULL_REQUEST_UPDATED - Build is triggered when a push is made to a branch with an open pull request. COMMIT_UPDATES - Build is triggered when new commits are mirrored into a repository.

Returns:

  • (Array<String>)


119
120
121
# File 'lib/oci/devops/models/repository.rb', line 119

def trigger_build_events
  @trigger_build_events
end

Class Method Details

.attribute_mapObject

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



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/oci/devops/models/repository.rb', line 134

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'compartment_id': :'compartmentId',
    'namespace': :'namespace',
    'project_id': :'projectId',
    'project_name': :'projectName',
    'ssh_url': :'sshUrl',
    'http_url': :'httpUrl',
    'description': :'description',
    'default_branch': :'defaultBranch',
    'repository_type': :'repositoryType',
    'mirror_repository_config': :'mirrorRepositoryConfig',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecyle_details': :'lifecyleDetails',
    'branch_count': :'branchCount',
    'commit_count': :'commitCount',
    'size_in_bytes': :'sizeInBytes',
    'trigger_build_events': :'triggerBuildEvents',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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
# File 'lib/oci/devops/models/repository.rb', line 165

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'compartment_id': :'String',
    'namespace': :'String',
    'project_id': :'String',
    'project_name': :'String',
    'ssh_url': :'String',
    'http_url': :'String',
    'description': :'String',
    'default_branch': :'String',
    'repository_type': :'String',
    'mirror_repository_config': :'OCI::Devops::Models::MirrorRepositoryConfig',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecyle_details': :'String',
    'branch_count': :'Integer',
    'commit_count': :'Integer',
    'size_in_bytes': :'Integer',
    'trigger_build_events': :'Array<String>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
# File 'lib/oci/devops/models/repository.rb', line 410

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    compartment_id == other.compartment_id &&
    namespace == other.namespace &&
    project_id == other.project_id &&
    project_name == other.project_name &&
    ssh_url == other.ssh_url &&
    http_url == other.http_url &&
    description == other.description &&
    default_branch == other.default_branch &&
    repository_type == other.repository_type &&
    mirror_repository_config == other.mirror_repository_config &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecyle_details == other.lifecyle_details &&
    branch_count == other.branch_count &&
    commit_count == other.commit_count &&
    size_in_bytes == other.size_in_bytes &&
    trigger_build_events == other.trigger_build_events &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
# File 'lib/oci/devops/models/repository.rb', line 462

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


442
443
444
# File 'lib/oci/devops/models/repository.rb', line 442

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



451
452
453
# File 'lib/oci/devops/models/repository.rb', line 451

def hash
  [id, name, compartment_id, namespace, project_id, project_name, ssh_url, http_url, description, default_branch, repository_type, mirror_repository_config, time_created, time_updated, lifecycle_state, lifecyle_details, branch_count, commit_count, size_in_bytes, trigger_build_events, freeform_tags, defined_tags, system_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



495
496
497
498
499
500
501
502
503
504
# File 'lib/oci/devops/models/repository.rb', line 495

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



489
490
491
# File 'lib/oci/devops/models/repository.rb', line 489

def to_s
  to_hash.to_s
end