Class: OCI::Devops::Models::RepositoryRefSummary

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

Overview

Summary of a reference. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RepositoryRefSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :ref_name (String) —

    The value to assign to the #ref_name property

  • :ref_type (String) —

    The value to assign to the #ref_type property

  • :full_ref_name (String) —

    The value to assign to the #full_ref_name property

  • :repository_id (String) —

    The value to assign to the #repository_id 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

  • :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



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
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
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/oci/devops/models/repository_ref_summary.rb', line 113

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

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

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

  self.ref_type = attributes[:'refType'] if attributes[:'refType']

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

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

  self.full_ref_name = attributes[:'fullRefName'] if attributes[:'fullRefName']

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

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

  self.repository_id = attributes[:'repositoryId'] if attributes[:'repositoryId']

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

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

  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.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

#defined_tags ⇒ Hash<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>>) 


42
43
44
 
# File 'lib/oci/devops/models/repository_ref_summary.rb', line 42

def defined_tags
  @defined_tags
end

#freeform_tags ⇒ Hash<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>) 


38
39
40
 
# File 'lib/oci/devops/models/repository_ref_summary.rb', line 38

def freeform_tags
  @freeform_tags
end

#full_ref_name ⇒ String

[Required] Unique full reference name inside a repository.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/devops/models/repository_ref_summary.rb', line 22

def full_ref_name
  @full_ref_name
end

#ref_name ⇒ String

[Required] Reference name inside a repository.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/devops/models/repository_ref_summary.rb', line 14

def ref_name
  @ref_name
end

#ref_type ⇒ String

[Required] The type of reference (BRANCH or TAG).

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/devops/models/repository_ref_summary.rb', line 18

def ref_type
  @ref_type
end

#repository_id ⇒ String

[Required] The OCID of the repository containing the reference.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/devops/models/repository_ref_summary.rb', line 26

def repository_id
  @repository_id
end

#system_tags ⇒ Hash<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>>) 


46
47
48
 
# File 'lib/oci/devops/models/repository_ref_summary.rb', line 46

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

Creation timestamp. Format defined by RFC3339.

Returns:

  • (DateTime) 


30
31
32
 
# File 'lib/oci/devops/models/repository_ref_summary.rb', line 30

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


34
35
36
 
# File 'lib/oci/devops/models/repository_ref_summary.rb', line 34

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/devops/models/repository_ref_summary.rb', line 49

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'ref_name': :'refName',
    'ref_type': :'refType',
    'full_ref_name': :'fullRefName',
    'repository_id': :'repositoryId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/devops/models/repository_ref_summary.rb', line 87

def self.get_subtype(object_hash)
  type = object_hash[:'refType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Devops::Models::RepositoryBranchSummary' if type == 'BRANCH'
  return 'OCI::Devops::Models::RepositoryTagSummary' if type == 'TAG'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Devops::Models::RepositoryRefSummary'
end

.swagger_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/devops/models/repository_ref_summary.rb', line 66

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'ref_name': :'String',
    'ref_type': :'String',
    'full_ref_name': :'String',
    'repository_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    '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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/oci/devops/models/repository_ref_summary.rb', line 181

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

  self.class == other.class &&
    ref_name == other.ref_name &&
    ref_type == other.ref_type &&
    full_ref_name == other.full_ref_name &&
    repository_id == other.repository_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/oci/devops/models/repository_ref_summary.rb', line 219

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


199
200
201
 
# File 'lib/oci/devops/models/repository_ref_summary.rb', line 199

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



208
209
210
 
# File 'lib/oci/devops/models/repository_ref_summary.rb', line 208

def hash
  [ref_name, ref_type, full_ref_name, repository_id, time_created, time_updated, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



252
253
254
255
256
257
258
259
260
261
 
# File 'lib/oci/devops/models/repository_ref_summary.rb', line 252

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



246
247
248
 
# File 'lib/oci/devops/models/repository_ref_summary.rb', line 246

def to_s
  to_hash.to_s
end