Class: OCI::Apiaccesscontrol::Models::ApiMetadata

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apiaccesscontrol/models/api_metadata.rb

Overview

An ApiDetail contains details such as the service it belongs to, the name of the api, the type of api, and the parameters of the api if it contains.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.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 = {}) ⇒ ApiMetadata

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

  • :service_name (String) —

    The value to assign to the #service_name property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :path (String) —

    The value to assign to the #path property

  • :entity_type (String) —

    The value to assign to the #entity_type property

  • :api_name (String) —

    The value to assign to the #api_name property

  • :fields (Array<String>) —

    The value to assign to the #fields property

  • :attributes (Array<String>) —

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

  • :time_deleted (DateTime) —

    The value to assign to the #time_deleted property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

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



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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 183

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

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

  self.service_name = attributes[:'service_name'] if attributes[:'service_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.path = attributes[:'path'] if attributes[:'path']

  self.entity_type = attributes[:'entityType'] if attributes[:'entityType']

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

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

  self.api_name = attributes[:'apiName'] if attributes[:'apiName']

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

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

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

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

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

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

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

  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_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  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

#api_name ⇒ String

The name of the api to execute the api request.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 49

def api_name
  @api_name
end

#attributes ⇒ Array<String>

List of the fields that is use while calling post or put for the data.

Returns:

  • (Array<String>) 


57
58
59
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 57

def attributes
  @attributes
end

#defined_tags ⇒ Hash<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>>) 


104
105
106
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 104

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The operation Name of the api. The name must be unique.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 37

def display_name
  @display_name
end

#entity_type ⇒ String

ResourceType to which the apiMetadata belongs to.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 45

def entity_type
  @entity_type
end

#fields ⇒ Array<String>

deprecated; Use attributes field instead.

Returns:

  • (Array<String>) 


53
54
55
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 53

def fields
  @fields
end

#freeform_tags ⇒ Hash<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>) 


96
97
98
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 96

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the ApiDetail.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 29

def id
  @id
end

#lifecycle_details ⇒ String

A message that describes the current state of the ApiMetadata in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 88

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the ApiMetadata.

Returns:

  • (String) 


82
83
84
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 82

def lifecycle_state
  @lifecycle_state
end

#path ⇒ String

rest path of the api.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 41

def path
  @path
end

#service_name ⇒ String

The service Name to which the api belongs to.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 33

def service_name
  @service_name
end

#system_tags ⇒ Hash<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>>) 


111
112
113
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 111

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


64
65
66
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 64

def time_created
  @time_created
end

#time_deleted ⇒ DateTime

The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


78
79
80
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 78

def time_deleted
  @time_deleted
end

#time_updated ⇒ DateTime

The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


71
72
73
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 71

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 114

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'service_name': :'serviceName',
    'display_name': :'displayName',
    'path': :'path',
    'entity_type': :'entityType',
    'api_name': :'apiName',
    'fields': :'fields',
    'attributes': :'attributes',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'time_deleted': :'timeDeleted',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 138

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'service_name': :'String',
    'display_name': :'String',
    'path': :'String',
    'entity_type': :'String',
    'api_name': :'String',
    'fields': :'Array<String>',
    'attributes': :'Array<String>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'time_deleted': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 290

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

  self.class == other.class &&
    id == other.id &&
    service_name == other.service_name &&
    display_name == other.display_name &&
    path == other.path &&
    entity_type == other.entity_type &&
    api_name == other.api_name &&
    fields == other.fields &&
    attributes == other.attributes &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    time_deleted == other.time_deleted &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    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



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 335

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


315
316
317
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 315

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



324
325
326
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 324

def hash
  [id, service_name, display_name, path, entity_type, api_name, fields, attributes, time_created, time_updated, time_deleted, lifecycle_state, lifecycle_details, 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



368
369
370
371
372
373
374
375
376
377
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 368

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



362
363
364
 
# File 'lib/oci/apiaccesscontrol/models/api_metadata.rb', line 362

def to_s
  to_hash.to_s
end