class OCI::DataCatalog::Models::CustomPropertySummary
Summary of a custom property
Constants
- DATA_TYPE_ENUM
- LIFECYCLE_STATE_ENUM
Attributes
Allowed values for the custom property if any @return [Array<String>]
OCID of the user who created the custom property. @return [String]
Data type of the custom property @return [String]
Description of the custom property @return [String]
Display name of the custom property @return [String]
If this field is a editable field @return [BOOLEAN]
If an OCI
Event will be emitted when the custom property is modified. @return [BOOLEAN]
If this field allows to filter or create facets from UI @return [BOOLEAN]
If this field allows multiple values to be set @return [BOOLEAN]
If this field is defined by service or by a user @return [BOOLEAN]
If this field is displayed in a list view of applicable objects. @return [BOOLEAN]
If this field allows to sort from UI @return [BOOLEAN]
[Required] Unique custom property key that is immutable. @return [String]
The current state of the custom property. @return [String]
Namespace name of the custom property @return [String]
Type or scope of the custom property belongs to. This will be an array of type id it will be belongs to
@return [Array<OCI::DataCatalog::Models::CustomPropertyTypeUsage>]
The date and time the custom property was created, in the format defined by [RFC3339](tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`
@return [DateTime]
The last time that any change was made to the custom property. An [RFC3339](tools.ietf.org/html/rfc3339) formatted datetime string.
@return [DateTime]
OCID of the user who last modified the custom property. @return [String]
Total number of first class objects using this custom property @return [Integer]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/data_catalog/models/custom_property_summary.rb, line 126 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'key': :'key', 'display_name': :'displayName', 'description': :'description', 'data_type': :'dataType', 'namespace_name': :'namespaceName', 'is_sortable': :'isSortable', 'is_filterable': :'isFilterable', 'is_multi_valued': :'isMultiValued', 'is_hidden': :'isHidden', 'is_editable': :'isEditable', 'is_shown_in_list': :'isShownInList', 'is_service_defined': :'isServiceDefined', 'is_hidden_in_search': :'isHiddenInSearch', 'time_created': :'timeCreated', 'lifecycle_state': :'lifecycleState', 'usage_count': :'usageCount', 'scope': :'scope', 'allowed_values': :'allowedValues', 'time_updated': :'timeUpdated', 'created_by_id': :'createdById', 'updated_by_id': :'updatedById', 'is_event_enabled': :'isEventEnabled' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :key The value to assign to the {#key} property @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [String] :description The value to assign to the {#description} property @option attributes [String] :data_type The value to assign to the {#data_type} property @option attributes [String] :namespace_name The value to assign to the {#namespace_name} property @option attributes [BOOLEAN] :is_sortable The value to assign to the {#is_sortable} property @option attributes [BOOLEAN] :is_filterable The value to assign to the {#is_filterable} property @option attributes [BOOLEAN] :is_multi_valued The value to assign to the {#is_multi_valued} property @option attributes [BOOLEAN] :is_hidden The value to assign to the {#is_hidden} property @option attributes [BOOLEAN] :is_editable The value to assign to the {#is_editable} property @option attributes [BOOLEAN] :is_shown_in_list The value to assign to the {#is_shown_in_list} property @option attributes [BOOLEAN] :is_service_defined The value to assign to the {#is_service_defined} property @option attributes [BOOLEAN] :is_hidden_in_search The value to assign to the {#is_hidden_in_search} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [Integer] :usage_count The value to assign to the {#usage_count} property @option attributes [Array<OCI::DataCatalog::Models::CustomPropertyTypeUsage>] :scope The value to assign to the {#scope} property @option attributes [Array<String>] :allowed_values The value to assign to the {#allowed_values} property @option attributes [DateTime] :time_updated The value to assign to the {#time_updated} property @option attributes [String] :created_by_id The value to assign to the {#created_by_id} property @option attributes [String] :updated_by_id The value to assign to the {#updated_by_id} property @option attributes [BOOLEAN] :is_event_enabled The value to assign to the {#is_event_enabled} property
# File lib/oci/data_catalog/models/custom_property_summary.rb, line 213 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.key = attributes[:'key'] if attributes[:'key'] 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.data_type = attributes[:'dataType'] if attributes[:'dataType'] raise 'You cannot provide both :dataType and :data_type' if attributes.key?(:'dataType') && attributes.key?(:'data_type') self.data_type = attributes[:'data_type'] if attributes[:'data_type'] self.namespace_name = attributes[:'namespaceName'] if attributes[:'namespaceName'] raise 'You cannot provide both :namespaceName and :namespace_name' if attributes.key?(:'namespaceName') && attributes.key?(:'namespace_name') self.namespace_name = attributes[:'namespace_name'] if attributes[:'namespace_name'] self.is_sortable = attributes[:'isSortable'] unless attributes[:'isSortable'].nil? self.is_sortable = false if is_sortable.nil? && !attributes.key?(:'isSortable') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isSortable and :is_sortable' if attributes.key?(:'isSortable') && attributes.key?(:'is_sortable') self.is_sortable = attributes[:'is_sortable'] unless attributes[:'is_sortable'].nil? self.is_sortable = false if is_sortable.nil? && !attributes.key?(:'isSortable') && !attributes.key?(:'is_sortable') # rubocop:disable Style/StringLiterals self.is_filterable = attributes[:'isFilterable'] unless attributes[:'isFilterable'].nil? self.is_filterable = false if is_filterable.nil? && !attributes.key?(:'isFilterable') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isFilterable and :is_filterable' if attributes.key?(:'isFilterable') && attributes.key?(:'is_filterable') self.is_filterable = attributes[:'is_filterable'] unless attributes[:'is_filterable'].nil? self.is_filterable = false if is_filterable.nil? && !attributes.key?(:'isFilterable') && !attributes.key?(:'is_filterable') # rubocop:disable Style/StringLiterals self.is_multi_valued = attributes[:'isMultiValued'] unless attributes[:'isMultiValued'].nil? self.is_multi_valued = false if is_multi_valued.nil? && !attributes.key?(:'isMultiValued') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isMultiValued and :is_multi_valued' if attributes.key?(:'isMultiValued') && attributes.key?(:'is_multi_valued') self.is_multi_valued = attributes[:'is_multi_valued'] unless attributes[:'is_multi_valued'].nil? self.is_multi_valued = false if is_multi_valued.nil? && !attributes.key?(:'isMultiValued') && !attributes.key?(:'is_multi_valued') # rubocop:disable Style/StringLiterals self.is_hidden = attributes[:'isHidden'] unless attributes[:'isHidden'].nil? self.is_hidden = true if is_hidden.nil? && !attributes.key?(:'isHidden') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isHidden and :is_hidden' if attributes.key?(:'isHidden') && attributes.key?(:'is_hidden') self.is_hidden = attributes[:'is_hidden'] unless attributes[:'is_hidden'].nil? self.is_hidden = true if is_hidden.nil? && !attributes.key?(:'isHidden') && !attributes.key?(:'is_hidden') # rubocop:disable Style/StringLiterals self.is_editable = attributes[:'isEditable'] unless attributes[:'isEditable'].nil? self.is_editable = true if is_editable.nil? && !attributes.key?(:'isEditable') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isEditable and :is_editable' if attributes.key?(:'isEditable') && attributes.key?(:'is_editable') self.is_editable = attributes[:'is_editable'] unless attributes[:'is_editable'].nil? self.is_editable = true if is_editable.nil? && !attributes.key?(:'isEditable') && !attributes.key?(:'is_editable') # rubocop:disable Style/StringLiterals self.is_shown_in_list = attributes[:'isShownInList'] unless attributes[:'isShownInList'].nil? self.is_shown_in_list = false if is_shown_in_list.nil? && !attributes.key?(:'isShownInList') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isShownInList and :is_shown_in_list' if attributes.key?(:'isShownInList') && attributes.key?(:'is_shown_in_list') self.is_shown_in_list = attributes[:'is_shown_in_list'] unless attributes[:'is_shown_in_list'].nil? self.is_shown_in_list = false if is_shown_in_list.nil? && !attributes.key?(:'isShownInList') && !attributes.key?(:'is_shown_in_list') # rubocop:disable Style/StringLiterals self.is_service_defined = attributes[:'isServiceDefined'] unless attributes[:'isServiceDefined'].nil? self.is_service_defined = false if is_service_defined.nil? && !attributes.key?(:'isServiceDefined') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isServiceDefined and :is_service_defined' if attributes.key?(:'isServiceDefined') && attributes.key?(:'is_service_defined') self.is_service_defined = attributes[:'is_service_defined'] unless attributes[:'is_service_defined'].nil? self.is_service_defined = false if is_service_defined.nil? && !attributes.key?(:'isServiceDefined') && !attributes.key?(:'is_service_defined') # rubocop:disable Style/StringLiterals self.is_hidden_in_search = attributes[:'isHiddenInSearch'] unless attributes[:'isHiddenInSearch'].nil? self.is_hidden_in_search = false if is_hidden_in_search.nil? && !attributes.key?(:'isHiddenInSearch') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isHiddenInSearch and :is_hidden_in_search' if attributes.key?(:'isHiddenInSearch') && attributes.key?(:'is_hidden_in_search') self.is_hidden_in_search = attributes[:'is_hidden_in_search'] unless attributes[:'is_hidden_in_search'].nil? self.is_hidden_in_search = false if is_hidden_in_search.nil? && !attributes.key?(:'isHiddenInSearch') && !attributes.key?(:'is_hidden_in_search') # rubocop:disable Style/StringLiterals 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.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self.usage_count = attributes[:'usageCount'] if attributes[:'usageCount'] raise 'You cannot provide both :usageCount and :usage_count' if attributes.key?(:'usageCount') && attributes.key?(:'usage_count') self.usage_count = attributes[:'usage_count'] if attributes[:'usage_count'] self.scope = attributes[:'scope'] if attributes[:'scope'] self.allowed_values = attributes[:'allowedValues'] if attributes[:'allowedValues'] raise 'You cannot provide both :allowedValues and :allowed_values' if attributes.key?(:'allowedValues') && attributes.key?(:'allowed_values') self.allowed_values = attributes[:'allowed_values'] if attributes[:'allowed_values'] 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.created_by_id = attributes[:'createdById'] if attributes[:'createdById'] raise 'You cannot provide both :createdById and :created_by_id' if attributes.key?(:'createdById') && attributes.key?(:'created_by_id') self.created_by_id = attributes[:'created_by_id'] if attributes[:'created_by_id'] self.updated_by_id = attributes[:'updatedById'] if attributes[:'updatedById'] raise 'You cannot provide both :updatedById and :updated_by_id' if attributes.key?(:'updatedById') && attributes.key?(:'updated_by_id') self.updated_by_id = attributes[:'updated_by_id'] if attributes[:'updated_by_id'] self.is_event_enabled = attributes[:'isEventEnabled'] unless attributes[:'isEventEnabled'].nil? self.is_event_enabled = false if is_event_enabled.nil? && !attributes.key?(:'isEventEnabled') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isEventEnabled and :is_event_enabled' if attributes.key?(:'isEventEnabled') && attributes.key?(:'is_event_enabled') self.is_event_enabled = attributes[:'is_event_enabled'] unless attributes[:'is_event_enabled'].nil? self.is_event_enabled = false if is_event_enabled.nil? && !attributes.key?(:'isEventEnabled') && !attributes.key?(:'is_event_enabled') # rubocop:disable Style/StringLiterals end
Attribute type mapping.
# File lib/oci/data_catalog/models/custom_property_summary.rb, line 156 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'key': :'String', 'display_name': :'String', 'description': :'String', 'data_type': :'String', 'namespace_name': :'String', 'is_sortable': :'BOOLEAN', 'is_filterable': :'BOOLEAN', 'is_multi_valued': :'BOOLEAN', 'is_hidden': :'BOOLEAN', 'is_editable': :'BOOLEAN', 'is_shown_in_list': :'BOOLEAN', 'is_service_defined': :'BOOLEAN', 'is_hidden_in_search': :'BOOLEAN', 'time_created': :'DateTime', 'lifecycle_state': :'String', 'usage_count': :'Integer', 'scope': :'Array<OCI::DataCatalog::Models::CustomPropertyTypeUsage>', 'allowed_values': :'Array<String>', 'time_updated': :'DateTime', 'created_by_id': :'String', 'updated_by_id': :'String', 'is_event_enabled': :'BOOLEAN' # 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/data_catalog/models/custom_property_summary.rb, line 391 def ==(other) return true if equal?(other) self.class == other.class && key == other.key && display_name == other.display_name && description == other.description && data_type == other.data_type && namespace_name == other.namespace_name && is_sortable == other.is_sortable && is_filterable == other.is_filterable && is_multi_valued == other.is_multi_valued && is_hidden == other.is_hidden && is_editable == other.is_editable && is_shown_in_list == other.is_shown_in_list && is_service_defined == other.is_service_defined && is_hidden_in_search == other.is_hidden_in_search && time_created == other.time_created && lifecycle_state == other.lifecycle_state && usage_count == other.usage_count && scope == other.scope && allowed_values == other.allowed_values && time_updated == other.time_updated && created_by_id == other.created_by_id && updated_by_id == other.updated_by_id && is_event_enabled == other.is_event_enabled 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/data_catalog/models/custom_property_summary.rb, line 442 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
Custom attribute writer method checking allowed values (enum). @param [Object] data_type
Object
to be assigned
# File lib/oci/data_catalog/models/custom_property_summary.rb, line 362 def data_type=(data_type) # rubocop:disable Style/ConditionalAssignment if data_type && !DATA_TYPE_ENUM.include?(data_type) OCI.logger.debug("Unknown value for 'data_type' [" + data_type + "]. Mapping to 'DATA_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger @data_type = DATA_TYPE_UNKNOWN_ENUM_VALUE else @data_type = data_type end # rubocop:enable Style/ConditionalAssignment end
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/data_catalog/models/custom_property_summary.rb, line 422 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/data_catalog/models/custom_property_summary.rb, line 431 def hash [key, display_name, description, data_type, namespace_name, is_sortable, is_filterable, is_multi_valued, is_hidden, is_editable, is_shown_in_list, is_service_defined, is_hidden_in_search, time_created, lifecycle_state, usage_count, scope, allowed_values, time_updated, created_by_id, updated_by_id, is_event_enabled].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state
Object
to be assigned
# File lib/oci/data_catalog/models/custom_property_summary.rb, line 375 def lifecycle_state=(lifecycle_state) # rubocop:disable Style/ConditionalAssignment if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state) OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE else @lifecycle_state = lifecycle_state end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/data_catalog/models/custom_property_summary.rb, line 475 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/data_catalog/models/custom_property_summary.rb, line 469 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/data_catalog/models/custom_property_summary.rb, line 492 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