class OCI::Analytics::Models::AnalyticsInstance
Analytics
Instance metadata.
Constants
- FEATURE_SET_ENUM
- LICENSE_TYPE_ENUM
- LIFECYCLE_STATE_ENUM
Attributes
This attribute is required. @return [OCI::Analytics::Models::Capacity]
[Required] The OCID of the compartment.
@return [String]
Optional description.
@return [String]
Email
address receiving notifications.
@return [String]
[Required] Analytics
feature set.
@return [String]
[Required] The resource OCID.
@return [String]
The license used for the service.
@return [String]
[Required] The current state of an instance.
@return [String]
[Required] The name of the Analytics
instance. This name must be unique in the tenancy and cannot be changed.
@return [String]
This attribute is required. @return [OCI::Analytics::Models::NetworkEndpointDetails]
Map of PrivateAccessChannel unique identifier key as KEY and PrivateAccessChannel Object
as VALUE.
@return [Hash<String, OCI::Analytics::Models::PrivateAccessChannel>]
URL of the Analytics
service.
@return [String]
[Required] The date and time the instance was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`
@return [DateTime]
The date and time the instance was last updated (in the format defined by RFC3339). This timestamp represents updates made through this API. External events do not influence it.
@return [DateTime]
Map of VanityUrl unique identifier key as KEY and VanityUrl Object
as VALUE.
@return [Hash<String, OCI::Analytics::Models::VanityUrlDetails>]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/analytics/models/analytics_instance.rb, line 129 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'name': :'name', 'description': :'description', 'compartment_id': :'compartmentId', 'lifecycle_state': :'lifecycleState', 'feature_set': :'featureSet', 'capacity': :'capacity', 'license_type': :'licenseType', 'email_notification': :'emailNotification', 'network_endpoint_details': :'networkEndpointDetails', 'private_access_channels': :'privateAccessChannels', 'vanity_url_details': :'vanityUrlDetails', 'service_url': :'serviceUrl', 'defined_tags': :'definedTags', 'freeform_tags': :'freeformTags', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :description The value to assign to the {#description} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [String] :feature_set The value to assign to the {#feature_set} property @option attributes [OCI::Analytics::Models::Capacity] :capacity The value to assign to the {#capacity} property @option attributes [String] :license_type The value to assign to the {#license_type} property @option attributes [String] :email_notification The value to assign to the {#email_notification} property @option attributes [OCI::Analytics::Models::NetworkEndpointDetails] :network_endpoint_details The value to assign to the {#network_endpoint_details} property @option attributes [Hash<String, OCI::Analytics::Models::PrivateAccessChannel>] :private_access_channels The value to assign to the {#private_access_channels} property @option attributes [Hash<String, OCI::Analytics::Models::VanityUrlDetails>] :vanity_url_details The value to assign to the {#vanity_url_details} property @option attributes [String] :service_url The value to assign to the {#service_url} 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 @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [DateTime] :time_updated The value to assign to the {#time_updated} property
# File lib/oci/analytics/models/analytics_instance.rb, line 201 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.name = attributes[:'name'] if attributes[:'name'] self.description = attributes[:'description'] if attributes[:'description'] 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.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.feature_set = attributes[:'featureSet'] if attributes[:'featureSet'] raise 'You cannot provide both :featureSet and :feature_set' if attributes.key?(:'featureSet') && attributes.key?(:'feature_set') self.feature_set = attributes[:'feature_set'] if attributes[:'feature_set'] self.capacity = attributes[:'capacity'] if attributes[:'capacity'] self.license_type = attributes[:'licenseType'] if attributes[:'licenseType'] raise 'You cannot provide both :licenseType and :license_type' if attributes.key?(:'licenseType') && attributes.key?(:'license_type') self.license_type = attributes[:'license_type'] if attributes[:'license_type'] self.email_notification = attributes[:'emailNotification'] if attributes[:'emailNotification'] raise 'You cannot provide both :emailNotification and :email_notification' if attributes.key?(:'emailNotification') && attributes.key?(:'email_notification') self.email_notification = attributes[:'email_notification'] if attributes[:'email_notification'] self.network_endpoint_details = attributes[:'networkEndpointDetails'] if attributes[:'networkEndpointDetails'] raise 'You cannot provide both :networkEndpointDetails and :network_endpoint_details' if attributes.key?(:'networkEndpointDetails') && attributes.key?(:'network_endpoint_details') self.network_endpoint_details = attributes[:'network_endpoint_details'] if attributes[:'network_endpoint_details'] self.private_access_channels = attributes[:'privateAccessChannels'] if attributes[:'privateAccessChannels'] raise 'You cannot provide both :privateAccessChannels and :private_access_channels' if attributes.key?(:'privateAccessChannels') && attributes.key?(:'private_access_channels') self.private_access_channels = attributes[:'private_access_channels'] if attributes[:'private_access_channels'] self.vanity_url_details = attributes[:'vanityUrlDetails'] if attributes[:'vanityUrlDetails'] raise 'You cannot provide both :vanityUrlDetails and :vanity_url_details' if attributes.key?(:'vanityUrlDetails') && attributes.key?(:'vanity_url_details') self.vanity_url_details = attributes[:'vanity_url_details'] if attributes[:'vanity_url_details'] self.service_url = attributes[:'serviceUrl'] if attributes[:'serviceUrl'] raise 'You cannot provide both :serviceUrl and :service_url' if attributes.key?(:'serviceUrl') && attributes.key?(:'service_url') self.service_url = attributes[:'service_url'] if attributes[:'service_url'] 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'] 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'] end
Attribute type mapping.
# File lib/oci/analytics/models/analytics_instance.rb, line 154 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'name': :'String', 'description': :'String', 'compartment_id': :'String', 'lifecycle_state': :'String', 'feature_set': :'String', 'capacity': :'OCI::Analytics::Models::Capacity', 'license_type': :'String', 'email_notification': :'String', 'network_endpoint_details': :'OCI::Analytics::Models::NetworkEndpointDetails', 'private_access_channels': :'Hash<String, OCI::Analytics::Models::PrivateAccessChannel>', 'vanity_url_details': :'Hash<String, OCI::Analytics::Models::VanityUrlDetails>', 'service_url': :'String', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'freeform_tags': :'Hash<String, String>', 'time_created': :'DateTime', 'time_updated': :'DateTime' # 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/analytics/models/analytics_instance.rb, line 340 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && name == other.name && description == other.description && compartment_id == other.compartment_id && lifecycle_state == other.lifecycle_state && feature_set == other.feature_set && capacity == other.capacity && license_type == other.license_type && email_notification == other.email_notification && network_endpoint_details == other.network_endpoint_details && private_access_channels == other.private_access_channels && vanity_url_details == other.vanity_url_details && service_url == other.service_url && defined_tags == other.defined_tags && freeform_tags == other.freeform_tags && time_created == other.time_created && time_updated == other.time_updated 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/analytics/models/analytics_instance.rb, line 386 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/analytics/models/analytics_instance.rb, line 366 def eql?(other) self == other end
Custom attribute writer method checking allowed values (enum). @param [Object] feature_set
Object
to be assigned
# File lib/oci/analytics/models/analytics_instance.rb, line 311 def feature_set=(feature_set) # rubocop:disable Style/ConditionalAssignment if feature_set && !FEATURE_SET_ENUM.include?(feature_set) OCI.logger.debug("Unknown value for 'feature_set' [" + feature_set + "]. Mapping to 'FEATURE_SET_UNKNOWN_ENUM_VALUE'") if OCI.logger @feature_set = FEATURE_SET_UNKNOWN_ENUM_VALUE else @feature_set = feature_set end # rubocop:enable Style/ConditionalAssignment end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/analytics/models/analytics_instance.rb, line 375 def hash [id, name, description, compartment_id, lifecycle_state, feature_set, capacity, license_type, email_notification, network_endpoint_details, private_access_channels, vanity_url_details, service_url, defined_tags, freeform_tags, time_created, time_updated].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] license_type
Object
to be assigned
# File lib/oci/analytics/models/analytics_instance.rb, line 324 def license_type=(license_type) # rubocop:disable Style/ConditionalAssignment if license_type && !LICENSE_TYPE_ENUM.include?(license_type) OCI.logger.debug("Unknown value for 'license_type' [" + license_type + "]. Mapping to 'LICENSE_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger @license_type = LICENSE_TYPE_UNKNOWN_ENUM_VALUE else @license_type = license_type end # rubocop:enable Style/ConditionalAssignment end
Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state
Object
to be assigned
# File lib/oci/analytics/models/analytics_instance.rb, line 298 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/analytics/models/analytics_instance.rb, line 419 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/analytics/models/analytics_instance.rb, line 413 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/analytics/models/analytics_instance.rb, line 436 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