Class: OCI::Psa::Models::PsaServiceSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/psa/models/psa_service_summary.rb

Overview

An OCI service summary, that will be used as a catalog for Private Service Access.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PsaServiceSummary

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :fqdns (Array<String>) —

    The value to assign to the #fqdns property

  • :is_v6_enabled (BOOLEAN) —

    The value to assign to the #is_v6_enabled property



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/psa/models/psa_service_summary.rb', line 79

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

  self.is_v6_enabled = attributes[:'isV6Enabled'] unless attributes[:'isV6Enabled'].nil?
  self.is_v6_enabled = false if is_v6_enabled.nil? && !attributes.key?(:'isV6Enabled') # rubocop:disable Style/StringLiterals

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

  self.is_v6_enabled = attributes[:'is_v6_enabled'] unless attributes[:'is_v6_enabled'].nil?
  self.is_v6_enabled = false if is_v6_enabled.nil? && !attributes.key?(:'isV6Enabled') && !attributes.key?(:'is_v6_enabled') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#description ⇒ String

A description of the OCI service.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/psa/models/psa_service_summary.rb', line 28

def description
  @description
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/psa/models/psa_service_summary.rb', line 23

def display_name
  @display_name
end

#fqdns ⇒ Array<String>

[Required] The public facing service FQDNs, which are going to be used to access the service.

Example: xyz.oraclecloud.com

Returns:

  • (Array<String>) 


35
36
37
 
# File 'lib/oci/psa/models/psa_service_summary.rb', line 35

def fqdns
  @fqdns
end

#id ⇒ String

[Required] A unique OCI service identifier.

Example: object-storage-api

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/psa/models/psa_service_summary.rb', line 17

def id
  @id
end

#is_v6_enabled ⇒ BOOLEAN

This optional field will indicate that whether service is IPv6 enabled.

Returns:

  • (BOOLEAN) 


40
41
42
 
# File 'lib/oci/psa/models/psa_service_summary.rb', line 40

def is_v6_enabled
  @is_v6_enabled
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/oci/psa/models/psa_service_summary.rb', line 43

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'fqdns': :'fqdns',
    'is_v6_enabled': :'isV6Enabled'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/psa/models/psa_service_summary.rb', line 56

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'fqdns': :'Array<String>',
    'is_v6_enabled': :'BOOLEAN'
    # 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



113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/psa/models/psa_service_summary.rb', line 113

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    fqdns == other.fqdns &&
    is_v6_enabled == other.is_v6_enabled
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



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/psa/models/psa_service_summary.rb', line 147

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


127
128
129
 
# File 'lib/oci/psa/models/psa_service_summary.rb', line 127

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



136
137
138
 
# File 'lib/oci/psa/models/psa_service_summary.rb', line 136

def hash
  [id, display_name, description, fqdns, is_v6_enabled].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



180
181
182
183
184
185
186
187
188
189
 
# File 'lib/oci/psa/models/psa_service_summary.rb', line 180

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



174
175
176
 
# File 'lib/oci/psa/models/psa_service_summary.rb', line 174

def to_s
  to_hash.to_s
end