Class: OCI::MarketplacePublisher::Models::PublisherSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/marketplace_publisher/models/publisher_summary.rb

Overview

The model for a publisher.

Constant Summary collapse

PUBLISHER_TYPE_ENUM = 
[
  PUBLISHER_TYPE_INTERNAL = 'INTERNAL'.freeze,
  PUBLISHER_TYPE_EXTERNAL = 'EXTERNAL'.freeze,
  PUBLISHER_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 = {}) ⇒ PublisherSummary

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

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :registry_namespace (String) —

    The value to assign to the #registry_namespace property

  • :legacy_id (String) —

    The value to assign to the #legacy_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :year_founded (Integer) —

    The value to assign to the #year_founded property

  • :website_url (String) —

    The value to assign to the #website_url property

  • :contact_email (String) —

    The value to assign to the #contact_email property

  • :contact_phone (String) —

    The value to assign to the #contact_phone property

  • :hq_address (String) —

    The value to assign to the #hq_address property

  • :logo (OCI::MarketplacePublisher::Models::UploadData) —

    The value to assign to the #logo property

  • :facebook_url (String) —

    The value to assign to the #facebook_url property

  • :twitter_url (String) —

    The value to assign to the #twitter_url property

  • :linkedin_url (String) —

    The value to assign to the #linkedin_url property

  • :publisher_type (String) —

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



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
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
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 192

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

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

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

  self.legacy_id = attributes[:'legacyId'] if attributes[:'legacyId']

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

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

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

  self.year_founded = attributes[:'yearFounded'] if attributes[:'yearFounded']

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

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

  self.website_url = attributes[:'websiteUrl'] if attributes[:'websiteUrl']

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

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

  self.contact_email = attributes[:'contactEmail'] if attributes[:'contactEmail']

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

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

  self.contact_phone = attributes[:'contactPhone'] if attributes[:'contactPhone']

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

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

  self.hq_address = attributes[:'hqAddress'] if attributes[:'hqAddress']

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

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

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

  self.facebook_url = attributes[:'facebookUrl'] if attributes[:'facebookUrl']

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

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

  self.twitter_url = attributes[:'twitterUrl'] if attributes[:'twitterUrl']

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

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

  self.linkedin_url = attributes[:'linkedinUrl'] if attributes[:'linkedinUrl']

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

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

  self.publisher_type = attributes[:'publisherType'] if attributes[:'publisherType']

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

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

  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

#compartment_id ⇒ String

[Required] The root compartment of the Publisher.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 24

def compartment_id
  @compartment_id
end

#contact_email ⇒ String

[Required] The public email address of the publisher for customers.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 52

def contact_email
  @contact_email
end

#contact_phone ⇒ String

[Required] The phone number of the publisher in E.164 format.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 56

def contact_phone
  @contact_phone
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

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

Returns:

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


99
100
101
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 99

def defined_tags
  @defined_tags
end

#description ⇒ String

A description of the publisher.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 40

def description
  @description
end

#display_name ⇒ String

[Required] The name of the publisher.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 36

def display_name
  @display_name
end

#facebook_url ⇒ String

Publisher's Facebook URL

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 67

def facebook_url
  @facebook_url
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. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


93
94
95
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 93

def freeform_tags
  @freeform_tags
end

#hq_address ⇒ String

The address of the publisher's headquarters.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 60

def hq_address
  @hq_address
end

#id ⇒ String

[Required] Unique OCID identifier for the publisher.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 20

def id
  @id
end

#legacy_id ⇒ String

Unique legacy service identifier for the publisher.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 32

def legacy_id
  @legacy_id
end

#linkedin_url ⇒ String

Publisher's LinkedIn URL

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 75

def linkedin_url
  @linkedin_url
end

#logo ⇒ OCI::MarketplacePublisher::Models::UploadData

Returns:



63
64
65
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 63

def 
  @logo
end

#publisher_type ⇒ String

[Required] publisher type.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 79

def publisher_type
  @publisher_type
end

#registry_namespace ⇒ String

[Required] The namespace for the publisher registry to persist artifacts.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 28

def registry_namespace
  @registry_namespace
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


105
106
107
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 105

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time the publisher was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


83
84
85
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 83

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The time the publisher was updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


87
88
89
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 87

def time_updated
  @time_updated
end

#twitter_url ⇒ String

Publisher's Twitter URL

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 71

def twitter_url
  @twitter_url
end

#website_url ⇒ String

The publisher's website.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 48

def website_url
  @website_url
end

#year_founded ⇒ Integer

The year the publisher's company or organization was founded.

Returns:

  • (Integer) 


44
45
46
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 44

def year_founded
  @year_founded
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 108

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'registry_namespace': :'registryNamespace',
    'legacy_id': :'legacyId',
    'display_name': :'displayName',
    'description': :'description',
    'year_founded': :'yearFounded',
    'website_url': :'websiteUrl',
    'contact_email': :'contactEmail',
    'contact_phone': :'contactPhone',
    'hq_address': :'hqAddress',
    'logo': :'logo',
    'facebook_url': :'facebookUrl',
    'twitter_url': :'twitterUrl',
    'linkedin_url': :'linkedinUrl',
    'publisher_type': :'publisherType',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 137

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'registry_namespace': :'String',
    'legacy_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'year_founded': :'Integer',
    'website_url': :'String',
    'contact_email': :'String',
    'contact_phone': :'String',
    'hq_address': :'String',
    'logo': :'OCI::MarketplacePublisher::Models::UploadData',
    'facebook_url': :'String',
    'twitter_url': :'String',
    'linkedin_url': :'String',
    'publisher_type': :'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



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 333

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    registry_namespace == other.registry_namespace &&
    legacy_id == other.legacy_id &&
    display_name == other.display_name &&
    description == other.description &&
    year_founded == other.year_founded &&
    website_url == other.website_url &&
    contact_email == other.contact_email &&
    contact_phone == other.contact_phone &&
    hq_address == other.hq_address &&
     == other. &&
    facebook_url == other.facebook_url &&
    twitter_url == other.twitter_url &&
    linkedin_url == other.linkedin_url &&
    publisher_type == other.publisher_type &&
    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



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 383

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


363
364
365
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 363

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



372
373
374
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 372

def hash
  [id, compartment_id, registry_namespace, legacy_id, display_name, description, year_founded, website_url, contact_email, contact_phone, hq_address, , facebook_url, twitter_url, linkedin_url, publisher_type, 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



416
417
418
419
420
421
422
423
424
425
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 416

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



410
411
412
 
# File 'lib/oci/marketplace_publisher/models/publisher_summary.rb', line 410

def to_s
  to_hash.to_s
end