Class: OCI::DataCatalog::Models::NamespaceSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_catalog/models/namespace_summary.rb

Overview

Summary of a namespace

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_MOVING = 'MOVING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NamespaceSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :key (String) —

    The value to assign to the #key property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :is_service_defined (BOOLEAN) —

    The value to assign to the #is_service_defined property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

[View source]

91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/oci/data_catalog/models/namespace_summary.rb', line 91

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.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.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.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']
end

Instance Attribute Details

#description ⇒ String

Detailed description of the namespace.

Returns:

  • (String) 

35
36
37
 
# File 'lib/oci/data_catalog/models/namespace_summary.rb', line 35

def description
  @description
end

#display_name ⇒ String

Name of the namespace

Returns:

  • (String) 

31
32
33
 
# File 'lib/oci/data_catalog/models/namespace_summary.rb', line 31

def display_name
  @display_name
end

#is_service_defined ⇒ BOOLEAN

If this field is defined by service or by a user

Returns:

  • (BOOLEAN) 

39
40
41
 
# File 'lib/oci/data_catalog/models/namespace_summary.rb', line 39

def is_service_defined
  @is_service_defined
end

#key ⇒ String

[Required] Unique namespace key that is immutable.

Returns:

  • (String) 

27
28
29
 
# File 'lib/oci/data_catalog/models/namespace_summary.rb', line 27

def key
  @key
end

#lifecycle_state ⇒ String

The current state of the namespace.

Returns:

  • (String) 

43
44
45
 
# File 'lib/oci/data_catalog/models/namespace_summary.rb', line 43

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

The date and time the namespace was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

Returns:

  • (DateTime) 

49
50
51
 
# File 'lib/oci/data_catalog/models/namespace_summary.rb', line 49

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/data_catalog/models/namespace_summary.rb', line 52

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'display_name': :'displayName',
    'description': :'description',
    'is_service_defined': :'isServiceDefined',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'display_name': :'String',
    'description': :'String',
    'is_service_defined': :'BOOLEAN',
    'lifecycle_state': :'String',
    'time_created': :'DateTime'
    # 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

[View source]

148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/data_catalog/models/namespace_summary.rb', line 148

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

  self.class == other.class &&
    key == other.key &&
    display_name == other.display_name &&
    description == other.description &&
    is_service_defined == other.is_service_defined &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created
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

[View source]

183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/data_catalog/models/namespace_summary.rb', line 183

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
[View source]

163
164
165
 
# File 'lib/oci/data_catalog/models/namespace_summary.rb', line 163

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

172
173
174
 
# File 'lib/oci/data_catalog/models/namespace_summary.rb', line 172

def hash
  [key, display_name, description, is_service_defined, lifecycle_state, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

216
217
218
219
220
221
222
223
224
225
 
# File 'lib/oci/data_catalog/models/namespace_summary.rb', line 216

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

[View source]

210
211
212
 
# File 'lib/oci/data_catalog/models/namespace_summary.rb', line 210

def to_s
  to_hash.to_s
end