Class: OCI::IdentityDomains::Models::AppFlatFileBundleConfigurationProperties

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

Overview

Flat file connector bundle configuration properties

SCIM++ Properties: - idcsCompositeKey: [name] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none

Constant Summary collapse

ICF_TYPE_ENUM = 
[
  ICF_TYPE_LONG = 'Long'.freeze,
  ICF_TYPE_STRING = 'String'.freeze,
  ICF_TYPE_CHARACTER = 'Character'.freeze,
  ICF_TYPE_DOUBLE = 'Double'.freeze,
  ICF_TYPE_FLOAT = 'Float'.freeze,
  ICF_TYPE_INTEGER = 'Integer'.freeze,
  ICF_TYPE_BOOLEAN = 'Boolean'.freeze,
  ICF_TYPE_URI = 'URI'.freeze,
  ICF_TYPE_FILE = 'File'.freeze,
  ICF_TYPE_GUARDED_BYTE_ARRAY = 'GuardedByteArray'.freeze,
  ICF_TYPE_GUARDED_STRING = 'GuardedString'.freeze,
  ICF_TYPE_ARRAY_OF_LONG = 'ArrayOfLong'.freeze,
  ICF_TYPE_ARRAY_OF_STRING = 'ArrayOfString'.freeze,
  ICF_TYPE_ARRAY_OF_CHARACTER = 'ArrayOfCharacter'.freeze,
  ICF_TYPE_ARRAY_OF_DOUBLE = 'ArrayOfDouble'.freeze,
  ICF_TYPE_ARRAY_OF_FLOAT = 'ArrayOfFloat'.freeze,
  ICF_TYPE_ARRAY_OF_INTEGER = 'ArrayOfInteger'.freeze,
  ICF_TYPE_ARRAY_OF_BOOLEAN = 'ArrayOfBoolean'.freeze,
  ICF_TYPE_ARRAY_OF_URI = 'ArrayOfURI'.freeze,
  ICF_TYPE_ARRAY_OF_FILE = 'ArrayOfFile'.freeze,
  ICF_TYPE_ARRAY_OF_GUARDED_BYTE_ARRAY = 'ArrayOfGuardedByteArray'.freeze,
  ICF_TYPE_ARRAY_OF_GUARDED_STRING = 'ArrayOfGuardedString'.freeze,
  ICF_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AppFlatFileBundleConfigurationProperties

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :icf_type (String) —

    The value to assign to the #icf_type property

  • :value (Array<String>) —

    The value to assign to the #value property

  • :order (Integer) —

    The value to assign to the #order property

  • :help_message (String) —

    The value to assign to the #help_message property

  • :required (BOOLEAN) —

    The value to assign to the #required property

  • :confidential (BOOLEAN) —

    The value to assign to the #confidential property



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/oci/identity_domains/models/app_flat_file_bundle_configuration_properties.rb', line 205

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

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

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

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

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

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

  self.help_message = attributes[:'helpMessage'] if attributes[:'helpMessage']

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

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

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

  self.confidential = attributes[:'confidential'] unless attributes[:'confidential'].nil?
end

Instance Attribute Details

#confidential ⇒ BOOLEAN

If true, this flatfile bundle configuration property value is confidential and will be encrypted in Oracle Identity Cloud Service. This attribute maps to \“isConfidential\” attribute in \“ConfigurationProperty\” in ICF.

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

Returns:

  • (BOOLEAN) 


157
158
159
 
# File 'lib/oci/identity_domains/models/app_flat_file_bundle_configuration_properties.rb', line 157

def confidential
  @confidential
end

#display_name ⇒ String

Display name of the flatfile bundle configuration property. This attribute maps to \“displayName\” attribute in \“ConfigurationProperty\” in ICF.

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

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/identity_domains/models/app_flat_file_bundle_configuration_properties.rb', line 74

def display_name
  @display_name
end

#help_message ⇒ String

Help message of the flatfile bundle configuration property. This attribute maps to \“helpMessage\” attribute in \“ConfigurationProperty\” in ICF.

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

Returns:

  • (String) 


131
132
133
 
# File 'lib/oci/identity_domains/models/app_flat_file_bundle_configuration_properties.rb', line 131

def help_message
  @help_message
end

#icf_type ⇒ String

[Required] ICF data type of flatfile the bundle configuration property. This attribute maps to \“type\” attribute in \“ConfigurationProperty\” in ICF.

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

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/identity_domains/models/app_flat_file_bundle_configuration_properties.rb', line 88

def icf_type
  @icf_type
end

#name ⇒ String

[Required] Name of the flatfile bundle configuration property. This attribute maps to \“name\” attribute in \“ConfigurationProperty\” in ICF.

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

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/identity_domains/models/app_flat_file_bundle_configuration_properties.rb', line 60

def name
  @name
end

#order ⇒ Integer

Display sequence of the bundle configuration property.

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

Returns:

  • (Integer) 


117
118
119
 
# File 'lib/oci/identity_domains/models/app_flat_file_bundle_configuration_properties.rb', line 117

def order
  @order
end

#required ⇒ BOOLEAN

[Required] If true, this flatfile bundle configuration property is required to connect to the target connected managed app. This attribute maps to \“isRequired\” attribute in \“ConfigurationProperty\” in ICF.

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

Returns:

  • (BOOLEAN) 


144
145
146
 
# File 'lib/oci/identity_domains/models/app_flat_file_bundle_configuration_properties.rb', line 144

def required
  @required
end

#value ⇒ Array<String>

Value of the flatfile bundle configuration property. This attribute maps to \“value\” attribute in \“ConfigurationProperty\” in ICF.

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

Returns:

  • (Array<String>) 


103
104
105
 
# File 'lib/oci/identity_domains/models/app_flat_file_bundle_configuration_properties.rb', line 103

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/identity_domains/models/app_flat_file_bundle_configuration_properties.rb', line 160

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'display_name': :'displayName',
    'icf_type': :'icfType',
    'value': :'value',
    'order': :'order',
    'help_message': :'helpMessage',
    'required': :'required',
    'confidential': :'confidential'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/oci/identity_domains/models/app_flat_file_bundle_configuration_properties.rb', line 176

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'display_name': :'String',
    'icf_type': :'String',
    'value': :'Array<String>',
    'order': :'Integer',
    'help_message': :'String',
    'required': :'BOOLEAN',
    'confidential': :'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



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/oci/identity_domains/models/app_flat_file_bundle_configuration_properties.rb', line 260

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

  self.class == other.class &&
    name == other.name &&
    display_name == other.display_name &&
    icf_type == other.icf_type &&
    value == other.value &&
    order == other.order &&
    help_message == other.help_message &&
    required == other.required &&
    confidential == other.confidential
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



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/oci/identity_domains/models/app_flat_file_bundle_configuration_properties.rb', line 297

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


277
278
279
 
# File 'lib/oci/identity_domains/models/app_flat_file_bundle_configuration_properties.rb', line 277

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



286
287
288
 
# File 'lib/oci/identity_domains/models/app_flat_file_bundle_configuration_properties.rb', line 286

def hash
  [name, display_name, icf_type, value, order, help_message, required, confidential].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



330
331
332
333
334
335
336
337
338
339
 
# File 'lib/oci/identity_domains/models/app_flat_file_bundle_configuration_properties.rb', line 330

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



324
325
326
 
# File 'lib/oci/identity_domains/models/app_flat_file_bundle_configuration_properties.rb', line 324

def to_s
  to_hash.to_s
end