class OCI::Marketplace::Models::CreatePublicationDetails
The model for the parameters needed to create a publication.
Constants
- LISTING_TYPE_ENUM
Attributes
[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the publication. @return [String]
[Required] Whether the publisher acknowledged that they have the right and authority to share the contents of the publication and that they accepted the Oracle terms of use agreements required to create a publication.
@return [BOOLEAN]
[Required] The publisher category to which the publication belongs. The publisher category informs where the listing appears for use.
@return [String]
A long description of the publication to use in the listing. @return [String]
[Required] The name of the publication, which is also used in the listing. @return [String]
This attribute is required. @return [OCI::Marketplace::Models::CreatePublicationPackage]
[Required] A short description of the publication to use in the listing. @return [String]
[Required] Contact information for getting support from the publisher for the listing. @return [Array<OCI::Marketplace::Models::SupportContact>]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/marketplace/models/create_publication_details.rb, line 65 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'listing_type': :'listingType', 'name': :'name', 'short_description': :'shortDescription', 'long_description': :'longDescription', 'support_contacts': :'supportContacts', 'compartment_id': :'compartmentId', 'package_details': :'packageDetails', 'is_agreement_acknowledged': :'isAgreementAcknowledged', 'defined_tags': :'definedTags', 'freeform_tags': :'freeformTags' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :listing_type The value to assign to the {#listing_type} property @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :short_description The value to assign to the {#short_description} property @option attributes [String] :long_description The value to assign to the {#long_description} property @option attributes [Array<OCI::Marketplace::Models::SupportContact>] :support_contacts The value to assign to the {#support_contacts} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [OCI::Marketplace::Models::CreatePublicationPackage] :package_details The value to assign to the {#package_details} property @option attributes [BOOLEAN] :is_agreement_acknowledged The value to assign to the {#is_agreement_acknowledged} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property
# File lib/oci/marketplace/models/create_publication_details.rb, line 116 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.listing_type = attributes[:'listingType'] if attributes[:'listingType'] raise 'You cannot provide both :listingType and :listing_type' if attributes.key?(:'listingType') && attributes.key?(:'listing_type') self.listing_type = attributes[:'listing_type'] if attributes[:'listing_type'] self.name = attributes[:'name'] if attributes[:'name'] self.short_description = attributes[:'shortDescription'] if attributes[:'shortDescription'] raise 'You cannot provide both :shortDescription and :short_description' if attributes.key?(:'shortDescription') && attributes.key?(:'short_description') self.short_description = attributes[:'short_description'] if attributes[:'short_description'] self.long_description = attributes[:'longDescription'] if attributes[:'longDescription'] raise 'You cannot provide both :longDescription and :long_description' if attributes.key?(:'longDescription') && attributes.key?(:'long_description') self.long_description = attributes[:'long_description'] if attributes[:'long_description'] self.support_contacts = attributes[:'supportContacts'] if attributes[:'supportContacts'] raise 'You cannot provide both :supportContacts and :support_contacts' if attributes.key?(:'supportContacts') && attributes.key?(:'support_contacts') self.support_contacts = attributes[:'support_contacts'] if attributes[:'support_contacts'] 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.package_details = attributes[:'packageDetails'] if attributes[:'packageDetails'] raise 'You cannot provide both :packageDetails and :package_details' if attributes.key?(:'packageDetails') && attributes.key?(:'package_details') self.package_details = attributes[:'package_details'] if attributes[:'package_details'] self.is_agreement_acknowledged = attributes[:'isAgreementAcknowledged'] unless attributes[:'isAgreementAcknowledged'].nil? raise 'You cannot provide both :isAgreementAcknowledged and :is_agreement_acknowledged' if attributes.key?(:'isAgreementAcknowledged') && attributes.key?(:'is_agreement_acknowledged') self.is_agreement_acknowledged = attributes[:'is_agreement_acknowledged'] unless attributes[:'is_agreement_acknowledged'].nil? 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.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'] end
Attribute type mapping.
# File lib/oci/marketplace/models/create_publication_details.rb, line 83 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'listing_type': :'String', 'name': :'String', 'short_description': :'String', 'long_description': :'String', 'support_contacts': :'Array<OCI::Marketplace::Models::SupportContact>', 'compartment_id': :'String', 'package_details': :'OCI::Marketplace::Models::CreatePublicationPackage', 'is_agreement_acknowledged': :'BOOLEAN', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'freeform_tags': :'Hash<String, String>' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/marketplace/models/create_publication_details.rb, line 194 def ==(other) return true if equal?(other) self.class == other.class && listing_type == other.listing_type && name == other.name && short_description == other.short_description && long_description == other.long_description && support_contacts == other.support_contacts && compartment_id == other.compartment_id && package_details == other.package_details && is_agreement_acknowledged == other.is_agreement_acknowledged && defined_tags == other.defined_tags && freeform_tags == other.freeform_tags end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/marketplace/models/create_publication_details.rb, line 233 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/marketplace/models/create_publication_details.rb, line 213 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/marketplace/models/create_publication_details.rb, line 222 def hash [listing_type, name, short_description, long_description, support_contacts, compartment_id, package_details, is_agreement_acknowledged, defined_tags, freeform_tags].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] listing_type
Object
to be assigned
# File lib/oci/marketplace/models/create_publication_details.rb, line 183 def listing_type=(listing_type) raise "Invalid value for 'listing_type': this must be one of the values in LISTING_TYPE_ENUM." if listing_type && !LISTING_TYPE_ENUM.include?(listing_type) @listing_type = listing_type end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/marketplace/models/create_publication_details.rb, line 266 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/marketplace/models/create_publication_details.rb, line 260 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/marketplace/models/create_publication_details.rb, line 283 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end