Class: OCI::Devops::Models::RepositoryRef

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

Overview

Reference object with name and commit ID. 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

Direct Known Subclasses

RepositoryBranch, RepositoryTag

Constant Summary collapse

REF_TYPE_ENUM = 
[
  REF_TYPE_BRANCH = 'BRANCH'.freeze,
  REF_TYPE_TAG = 'TAG'.freeze,
  REF_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RepositoryRef

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

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
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
 
# File 'lib/oci/devops/models/repository_ref.rb', line 99

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.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']
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>>) 


41
42
43
 
# File 'lib/oci/devops/models/repository_ref.rb', line 41

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


37
38
39
 
# File 'lib/oci/devops/models/repository_ref.rb', line 37

def freeform_tags
  @freeform_tags
end

#full_ref_name ⇒ String

[Required] Unique full reference name inside a repository.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/devops/models/repository_ref.rb', line 29

def full_ref_name
  @full_ref_name
end

#ref_name ⇒ String

[Required] Unique reference name inside a repository.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/devops/models/repository_ref.rb', line 21

def ref_name
  @ref_name
end

#ref_type ⇒ String

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

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/devops/models/repository_ref.rb', line 25

def ref_type
  @ref_type
end

#repository_id ⇒ String

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

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/devops/models/repository_ref.rb', line 33

def repository_id
  @repository_id
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/devops/models/repository_ref.rb', line 44

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'ref_name': :'refName',
    'ref_type': :'refType',
    'full_ref_name': :'fullRefName',
    'repository_id': :'repositoryId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # 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.



76
77
78
79
80
81
82
83
84
 
# File 'lib/oci/devops/models/repository_ref.rb', line 76

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

  return 'OCI::Devops::Models::RepositoryBranch' if type == 'BRANCH'
  return 'OCI::Devops::Models::RepositoryTag' if type == 'TAG'

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

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/devops/models/repository_ref.rb', line 58

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



162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/oci/devops/models/repository_ref.rb', line 162

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 &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/oci/devops/models/repository_ref.rb', line 197

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


177
178
179
 
# File 'lib/oci/devops/models/repository_ref.rb', line 177

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



186
187
188
 
# File 'lib/oci/devops/models/repository_ref.rb', line 186

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



230
231
232
233
234
235
236
237
238
239
 
# File 'lib/oci/devops/models/repository_ref.rb', line 230

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



224
225
226
 
# File 'lib/oci/devops/models/repository_ref.rb', line 224

def to_s
  to_hash.to_s
end