Class: OCI::IdentityDomains::Models::MyAppApp

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity_domains/models/my_app_app.rb

Overview

Application on which the account is based

SCIM++ Properties: - idcsSearchable: true - multiValued: false - mutability: readOnly - required: true - returned: default - type: complex - uniqueness: none

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MyAppApp

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :value (String) —

    The value to assign to the #value property

  • :ref (String) —

    The value to assign to the #ref property

  • :display (String) —

    The value to assign to the #display property

  • :description (String) —

    The value to assign to the #description property

  • :is_login_target (BOOLEAN) —

    The value to assign to the #is_login_target property

  • :show_in_my_apps (BOOLEAN) —

    The value to assign to the #show_in_my_apps property

  • :is_alias_app (BOOLEAN) —

    The value to assign to the #is_alias_app property

  • :active (BOOLEAN) —

    The value to assign to the #active property

  • :login_mechanism (String) —

    The value to assign to the #login_mechanism property

  • :app_icon (String) —

    The value to assign to the #app_icon property

  • :app_thumbnail (String) —

    The value to assign to the #app_thumbnail property

  • :is_opc_service (BOOLEAN) —

    The value to assign to the #is_opc_service property

  • :service_type_urn (String) —

    The value to assign to the #service_type_urn property



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/oci/identity_domains/models/my_app_app.rb', line 253

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

  self.ref = attributes[:'$ref'] if attributes[:'$ref']

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

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

  self. = attributes[:'isLoginTarget'] unless attributes[:'isLoginTarget'].nil?

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

  self. = attributes[:'is_login_target'] unless attributes[:'is_login_target'].nil?

  self.show_in_my_apps = attributes[:'showInMyApps'] unless attributes[:'showInMyApps'].nil?

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

  self.show_in_my_apps = attributes[:'show_in_my_apps'] unless attributes[:'show_in_my_apps'].nil?

  self.is_alias_app = attributes[:'isAliasApp'] unless attributes[:'isAliasApp'].nil?

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

  self.is_alias_app = attributes[:'is_alias_app'] unless attributes[:'is_alias_app'].nil?

  self.active = attributes[:'active'] unless attributes[:'active'].nil?

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

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

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

  self.app_icon = attributes[:'appIcon'] if attributes[:'appIcon']

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

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

  self.app_thumbnail = attributes[:'appThumbnail'] if attributes[:'appThumbnail']

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

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

  self.is_opc_service = attributes[:'isOPCService'] unless attributes[:'isOPCService'].nil?

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

  self.is_opc_service = attributes[:'is_opc_service'] unless attributes[:'is_opc_service'].nil?

  self.service_type_urn = attributes[:'serviceTypeURN'] if attributes[:'serviceTypeURN']

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

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

Instance Attribute Details

#active ⇒ BOOLEAN

If true, this App is able to participate in runtime services, such as automatic-login, OAuth, and SAML. If false, all runtime services are disabled for this App, and only administrative operations can be performed.

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


125
126
127
 
# File 'lib/oci/identity_domains/models/my_app_app.rb', line 125

def active
  @active
end

#app_icon ⇒ String

Application icon.

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


151
152
153
 
# File 'lib/oci/identity_domains/models/my_app_app.rb', line 151

def app_icon
  @app_icon
end

#app_thumbnail ⇒ String

Application thumbnail.

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Returns:

  • (String) 


164
165
166
 
# File 'lib/oci/identity_domains/models/my_app_app.rb', line 164

def app_thumbnail
  @app_thumbnail
end

#description ⇒ String

Application description

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/identity_domains/models/my_app_app.rb', line 73

def description
  @description
end

#display ⇒ String

Application display name

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/identity_domains/models/my_app_app.rb', line 59

def display
  @display
end

#is_alias_app ⇒ BOOLEAN

If true, this App is an AliasApp and it cannot be granted to an end user directly

SCIM++ Properties: - idcsSearchable: true - multiValued: false - mutability: writeOnly - required: false - returned: never - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


112
113
114
 
# File 'lib/oci/identity_domains/models/my_app_app.rb', line 112

def is_alias_app
  @is_alias_app
end

#is_login_target ⇒ BOOLEAN

If true, this App allows runtime services to log end users into this App automatically.

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


86
87
88
 
# File 'lib/oci/identity_domains/models/my_app_app.rb', line 86

def 
  @is_login_target
end

#is_opc_service ⇒ BOOLEAN

If true, this application is an Oracle Public Cloud service-instance.

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


177
178
179
 
# File 'lib/oci/identity_domains/models/my_app_app.rb', line 177

def is_opc_service
  @is_opc_service
end

#login_mechanism ⇒ String

The protocol that runtime services will use to log end users in to this App automatically. If 'OIDC', then runtime services use the OpenID Connect protocol. If 'SAML', then runtime services use Security Assertion Markup Language protocol.

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


138
139
140
 
# File 'lib/oci/identity_domains/models/my_app_app.rb', line 138

def 
  @login_mechanism
end

#ref ⇒ String

Application URI

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: reference - uniqueness: none

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/identity_domains/models/my_app_app.rb', line 45

def ref
  @ref
end

#service_type_urn ⇒ String

This Uniform Resource Name (URN) value identifies the type of Oracle Public Cloud service of which this app is an instance.

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


190
191
192
 
# File 'lib/oci/identity_domains/models/my_app_app.rb', line 190

def service_type_urn
  @service_type_urn
end

#show_in_my_apps ⇒ BOOLEAN

If true, this App will be displayed in the MyApps page of each end-user who has access to this App.

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


99
100
101
 
# File 'lib/oci/identity_domains/models/my_app_app.rb', line 99

def show_in_my_apps
  @show_in_my_apps
end

#value ⇒ String

[Required] Application identifier

SCIM++ Properties: - caseExact: true - idcsSearchable: true - multiValued: false - mutability: readOnly - required: true - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/identity_domains/models/my_app_app.rb', line 32

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/oci/identity_domains/models/my_app_app.rb', line 193

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'value': :'value',
    'ref': :'$ref',
    'display': :'display',
    'description': :'description',
    'is_login_target': :'isLoginTarget',
    'show_in_my_apps': :'showInMyApps',
    'is_alias_app': :'isAliasApp',
    'active': :'active',
    'login_mechanism': :'loginMechanism',
    'app_icon': :'appIcon',
    'app_thumbnail': :'appThumbnail',
    'is_opc_service': :'isOPCService',
    'service_type_urn': :'serviceTypeURN'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/oci/identity_domains/models/my_app_app.rb', line 214

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'value': :'String',
    'ref': :'String',
    'display': :'String',
    'description': :'String',
    'is_login_target': :'BOOLEAN',
    'show_in_my_apps': :'BOOLEAN',
    'is_alias_app': :'BOOLEAN',
    'active': :'BOOLEAN',
    'login_mechanism': :'String',
    'app_icon': :'String',
    'app_thumbnail': :'String',
    'is_opc_service': :'BOOLEAN',
    'service_type_urn': :'String'
    # 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



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/oci/identity_domains/models/my_app_app.rb', line 325

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

  self.class == other.class &&
    value == other.value &&
    ref == other.ref &&
    display == other.display &&
    description == other.description &&
     == other. &&
    show_in_my_apps == other.show_in_my_apps &&
    is_alias_app == other.is_alias_app &&
    active == other.active &&
     == other. &&
    app_icon == other.app_icon &&
    app_thumbnail == other.app_thumbnail &&
    is_opc_service == other.is_opc_service &&
    service_type_urn == other.service_type_urn
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



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/oci/identity_domains/models/my_app_app.rb', line 367

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


347
348
349
 
# File 'lib/oci/identity_domains/models/my_app_app.rb', line 347

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



356
357
358
 
# File 'lib/oci/identity_domains/models/my_app_app.rb', line 356

def hash
  [value, ref, display, description, , show_in_my_apps, is_alias_app, active, , app_icon, app_thumbnail, is_opc_service, service_type_urn].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



400
401
402
403
404
405
406
407
408
409
 
# File 'lib/oci/identity_domains/models/my_app_app.rb', line 400

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



394
395
396
 
# File 'lib/oci/identity_domains/models/my_app_app.rb', line 394

def to_s
  to_hash.to_s
end