Class: OCI::Artifacts::Models::CreateRepositoryDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/artifacts/models/create_repository_details.rb

Overview

Parameters needed to create an artifact repository. 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

CreateGenericRepositoryDetails

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateRepositoryDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String)

    The value to assign to the #display_name property

  • :compartment_id (String)

    The value to assign to the #compartment_id property

  • :repository_type (String)

    The value to assign to the #repository_type property

  • :description (String)

    The value to assign to the #description property

  • :is_immutable (BOOLEAN)

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



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
141
142
143
144
145
146
147
148
149
150
# File 'lib/oci/artifacts/models/create_repository_details.rb', line 107

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

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

  self.display_name = attributes[:'display_name'] if attributes[:'display_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.repository_type = attributes[:'repositoryType'] if attributes[:'repositoryType']

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

  self.is_immutable = attributes[:'isImmutable'] unless attributes[:'isImmutable'].nil?

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

  self.is_immutable = attributes[:'is_immutable'] unless attributes[:'is_immutable'].nil?

  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

#compartment_idString

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

Returns:

  • (String)


19
20
21
# File 'lib/oci/artifacts/models/create_repository_details.rb', line 19

def compartment_id
  @compartment_id
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


47
48
49
# File 'lib/oci/artifacts/models/create_repository_details.rb', line 47

def defined_tags
  @defined_tags
end

#descriptionString

A short description of the repository. It can be updated later.

Returns:

  • (String)


27
28
29
# File 'lib/oci/artifacts/models/create_repository_details.rb', line 27

def description
  @description
end

#display_nameString

A user-friendly display name for the repository. If not present, will be auto-generated. It can be modified later. Avoid entering confidential information.

Returns:

  • (String)


14
15
16
# File 'lib/oci/artifacts/models/create_repository_details.rb', line 14

def display_name
  @display_name
end

#freeform_tagsHash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>)


39
40
41
# File 'lib/oci/artifacts/models/create_repository_details.rb', line 39

def freeform_tags
  @freeform_tags
end

#is_immutableBOOLEAN

[Required] Whether to make the repository immutable. The artifacts of an immutable repository cannot be overwritten.

Returns:

  • (BOOLEAN)


31
32
33
# File 'lib/oci/artifacts/models/create_repository_details.rb', line 31

def is_immutable
  @is_immutable
end

#repository_typeString

[Required] The repository's supported artifact type.

Returns:

  • (String)


23
24
25
# File 'lib/oci/artifacts/models/create_repository_details.rb', line 23

def repository_type
  @repository_type
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'repository_type': :'repositoryType',
    'description': :'description',
    'is_immutable': :'isImmutable',
    '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.



84
85
86
87
88
89
90
91
# File 'lib/oci/artifacts/models/create_repository_details.rb', line 84

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

  return 'OCI::Artifacts::Models::CreateGenericRepositoryDetails' if type == 'GENERIC'

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

.swagger_typesObject

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/oci/artifacts/models/create_repository_details.rb', line 65

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'compartment_id': :'String',
    'repository_type': :'String',
    'description': :'String',
    'is_immutable': :'BOOLEAN',
    '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



159
160
161
162
163
164
165
166
167
168
169
170
# File 'lib/oci/artifacts/models/create_repository_details.rb', line 159

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

  self.class == other.class &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    repository_type == other.repository_type &&
    description == other.description &&
    is_immutable == other.is_immutable &&
    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



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

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


175
176
177
# File 'lib/oci/artifacts/models/create_repository_details.rb', line 175

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



184
185
186
# File 'lib/oci/artifacts/models/create_repository_details.rb', line 184

def hash
  [display_name, compartment_id, repository_type, description, is_immutable, freeform_tags, defined_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



228
229
230
231
232
233
234
235
236
237
# File 'lib/oci/artifacts/models/create_repository_details.rb', line 228

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



222
223
224
# File 'lib/oci/artifacts/models/create_repository_details.rb', line 222

def to_s
  to_hash.to_s
end