Class: OCI::CloudGuard::Models::ServiceSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cloud_guard/models/service_summary.rb

Overview

A SaaS service which exists in the tenancy.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ServiceSummary

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

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :saas_service_name (String) —

    The value to assign to the #saas_service_name property

  • :service_overview_path (String) —

    The value to assign to the #service_overview_path property

  • :region (String) —

    The value to assign to the #region property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/cloud_guard/models/service_summary.rb', line 114

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

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

  self.saas_service_name = attributes[:'saas_service_name'] if attributes[:'saas_service_name']

  self.service_overview_path = attributes[:'serviceOverviewPath'] if attributes[:'serviceOverviewPath']

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

  self.service_overview_path = attributes[:'service_overview_path'] if attributes[:'service_overview_path']

  self.region = attributes[:'region'] if attributes[:'region']

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

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

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_tags']
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] OCID of the compartment. Always a tenancy OCID

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/cloud_guard/models/service_summary.rb', line 25

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


54
55
56
 
# File 'lib/oci/cloud_guard/models/service_summary.rb', line 54

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The Value to be displayed on the One Console

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/cloud_guard/models/service_summary.rb', line 20

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Avoid entering confidential information.

Returns:

  • (Hash<String, String>) 


48
49
50
 
# File 'lib/oci/cloud_guard/models/service_summary.rb', line 48

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The ocid of the service.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/cloud_guard/models/service_summary.rb', line 15

def id
  @id
end

#region ⇒ String

The region in which the service exists

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/cloud_guard/models/service_summary.rb', line 40

def region
  @region
end

#saas_service_name ⇒ String

[Required] The service name of the service. This value is fetched from Tenant-Manager which syncs with TAS

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/cloud_guard/models/service_summary.rb', line 30

def saas_service_name
  @saas_service_name
end

#service_overview_path ⇒ String

The service overview path of the service. This value is used to perform navigation to the service overview page.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/cloud_guard/models/service_summary.rb', line 35

def service_overview_path
  @service_overview_path
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


63
64
65
 
# File 'lib/oci/cloud_guard/models/service_summary.rb', line 63

def system_tags
  @system_tags
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/cloud_guard/models/service_summary.rb', line 66

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'saas_service_name': :'saasServiceName',
    'service_overview_path': :'serviceOverviewPath',
    'region': :'region',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/cloud_guard/models/service_summary.rb', line 83

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'saas_service_name': :'String',
    'service_overview_path': :'String',
    'region': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/oci/cloud_guard/models/service_summary.rb', line 174

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    saas_service_name == other.saas_service_name &&
    service_overview_path == other.service_overview_path &&
    region == other.region &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/oci/cloud_guard/models/service_summary.rb', line 212

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


192
193
194
 
# File 'lib/oci/cloud_guard/models/service_summary.rb', line 192

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



201
202
203
 
# File 'lib/oci/cloud_guard/models/service_summary.rb', line 201

def hash
  [id, display_name, compartment_id, saas_service_name, service_overview_path, region, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



245
246
247
248
249
250
251
252
253
254
 
# File 'lib/oci/cloud_guard/models/service_summary.rb', line 245

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



239
240
241
 
# File 'lib/oci/cloud_guard/models/service_summary.rb', line 239

def to_s
  to_hash.to_s
end