Class: OCI::DelegateAccessControl::Models::ServiceProvider

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/delegate_access_control/models/service_provider.rb

Overview

Details of the Service Provider. Service provider offers services to the customer to support the delegated resources.

Constant Summary collapse

SERVICE_PROVIDER_TYPE_ENUM =
[
  SERVICE_PROVIDER_TYPE_ORACLE_PROVIDED = 'ORACLE_PROVIDED'.freeze,
  SERVICE_PROVIDER_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SERVICE_TYPES_ENUM =
[
  SERVICE_TYPES_TROUBLESHOOTING = 'TROUBLESHOOTING'.freeze,
  SERVICE_TYPES_ASSISTED_PATCHING = 'ASSISTED_PATCHING'.freeze,
  SERVICE_TYPES_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SUPPORTED_RESOURCE_TYPES_ENUM =
[
  SUPPORTED_RESOURCE_TYPES_VMCLUSTER = 'VMCLUSTER'.freeze,
  SUPPORTED_RESOURCE_TYPES_CLOUDVMCLUSTER = 'CLOUDVMCLUSTER'.freeze,
  SUPPORTED_RESOURCE_TYPES_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.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 = {}) ⇒ ServiceProvider

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

  • :compartment_id (String)

    The value to assign to the #compartment_id property

  • :name (String)

    The value to assign to the #name property

  • :description (String)

    The value to assign to the #description property

  • :service_provider_type (String)

    The value to assign to the #service_provider_type property

  • :service_types (Array<String>)

    The value to assign to the #service_types property

  • :supported_resource_types (Array<String>)

    The value to assign to the #supported_resource_types property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :lifecycle_state_details (String)

    The value to assign to the #lifecycle_state_details property

  • :time_created (DateTime)

    The value to assign to the #time_created property

  • :time_updated (DateTime)

    The value to assign to the #time_updated 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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
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
239
240
241
242
243
244
245
246
247
248
249
250
251
# File 'lib/oci/delegate_access_control/models/service_provider.rb', line 174

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

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

  self.service_provider_type = attributes[:'serviceProviderType'] if attributes[:'serviceProviderType']

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

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

  self.service_types = attributes[:'serviceTypes'] if attributes[:'serviceTypes']

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

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

  self.supported_resource_types = attributes[:'supportedResourceTypes'] if attributes[:'supportedResourceTypes']

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

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

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

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

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  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_idString

The OCID of the compartment that contains the Delegation Control.

Returns:

  • (String)


46
47
48
# File 'lib/oci/delegate_access_control/models/service_provider.rb', line 46

def compartment_id
  @compartment_id
end

#defined_tagsHash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


101
102
103
# File 'lib/oci/delegate_access_control/models/service_provider.rb', line 101

def defined_tags
  @defined_tags
end

#descriptionString

Description of the Service Provider.

Returns:

  • (String)


55
56
57
# File 'lib/oci/delegate_access_control/models/service_provider.rb', line 55

def description
  @description
end

#freeform_tagsHash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>)


93
94
95
# File 'lib/oci/delegate_access_control/models/service_provider.rb', line 93

def freeform_tags
  @freeform_tags
end

#idString

[Required] Unique identifier for the Service Provider.

Returns:

  • (String)


42
43
44
# File 'lib/oci/delegate_access_control/models/service_provider.rb', line 42

def id
  @id
end

#lifecycle_stateString

The current lifecycle state of the Service Provider.

Returns:

  • (String)


71
72
73
# File 'lib/oci/delegate_access_control/models/service_provider.rb', line 71

def lifecycle_state
  @lifecycle_state
end

#lifecycle_state_detailsString

Description of the current lifecycle state in more detail.

Returns:

  • (String)


75
76
77
# File 'lib/oci/delegate_access_control/models/service_provider.rb', line 75

def lifecycle_state_details
  @lifecycle_state_details
end

#nameString

[Required] Unique name of the Service Provider.

Returns:

  • (String)


50
51
52
# File 'lib/oci/delegate_access_control/models/service_provider.rb', line 50

def name
  @name
end

#service_provider_typeString

[Required] Service Provider type.

Returns:

  • (String)


59
60
61
# File 'lib/oci/delegate_access_control/models/service_provider.rb', line 59

def service_provider_type
  @service_provider_type
end

#service_typesArray<String>

[Required] Types of services offered by this provider.

Returns:

  • (Array<String>)


63
64
65
# File 'lib/oci/delegate_access_control/models/service_provider.rb', line 63

def service_types
  @service_types
end

#supported_resource_typesArray<String>

[Required] Resource types for which this provider will provide service. Default to all if not specified.

Returns:

  • (Array<String>)


67
68
69
# File 'lib/oci/delegate_access_control/models/service_provider.rb', line 67

def supported_resource_types
  @supported_resource_types
end

#system_tagsHash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace.

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

Returns:

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


108
109
110
# File 'lib/oci/delegate_access_control/models/service_provider.rb', line 108

def system_tags
  @system_tags
end

#time_createdDateTime

Time when the Service Provider was created expressed in RFC 3339 timestamp format, e.g. '2020-05-22T21:10:29.600Z'

Returns:

  • (DateTime)


80
81
82
# File 'lib/oci/delegate_access_control/models/service_provider.rb', line 80

def time_created
  @time_created
end

#time_updatedDateTime

Time when the Service Provider was last modified expressed in RFC 3339 timestamp format, e.g. '2020-05-22T21:10:29.600Z'

Returns:

  • (DateTime)


85
86
87
# File 'lib/oci/delegate_access_control/models/service_provider.rb', line 85

def time_updated
  @time_updated
end

Class Method Details

.attribute_mapObject

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
# File 'lib/oci/delegate_access_control/models/service_provider.rb', line 111

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'name': :'name',
    'description': :'description',
    'service_provider_type': :'serviceProviderType',
    'service_types': :'serviceTypes',
    'supported_resource_types': :'supportedResourceTypes',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_state_details': :'lifecycleStateDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
# File 'lib/oci/delegate_access_control/models/service_provider.rb', line 133

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'name': :'String',
    'description': :'String',
    'service_provider_type': :'String',
    'service_types': :'Array<String>',
    'supported_resource_types': :'Array<String>',
    'lifecycle_state': :'String',
    'lifecycle_state_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    '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



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

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    name == other.name &&
    description == other.description &&
    service_provider_type == other.service_provider_type &&
    service_types == other.service_types &&
    supported_resource_types == other.supported_resource_types &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_state_details == other.lifecycle_state_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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



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

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


349
350
351
# File 'lib/oci/delegate_access_control/models/service_provider.rb', line 349

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



358
359
360
# File 'lib/oci/delegate_access_control/models/service_provider.rb', line 358

def hash
  [id, compartment_id, name, description, service_provider_type, service_types, supported_resource_types, lifecycle_state, lifecycle_state_details, time_created, time_updated, freeform_tags, defined_tags, system_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



402
403
404
405
406
407
408
409
410
411
# File 'lib/oci/delegate_access_control/models/service_provider.rb', line 402

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



396
397
398
# File 'lib/oci/delegate_access_control/models/service_provider.rb', line 396

def to_s
  to_hash.to_s
end