Class: OCI::Apiaccesscontrol::Models::CreatePrivilegedApiControlDetails

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

Overview

The data to create a PrivilegedApiControl.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreatePrivilegedApiControlDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/apiaccesscontrol/models/create_privileged_api_control_details.rb', line 120

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#approver_group_id_list ⇒ Array<String>

[Required] List of user IAM group ids who can approve an privilegedApi request associated with a resource governed by this operator control.

Returns:

  • (Array<String>) 


30
31
32
 
# File 'lib/oci/apiaccesscontrol/models/create_privileged_api_control_details.rb', line 30

def approver_group_id_list
  @approver_group_id_list
end

#compartment_id ⇒ String

[Required] The OCID of the compartment to create the PrivilegedApiControl in.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/apiaccesscontrol/models/create_privileged_api_control_details.rb', line 22

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. For more information, see Resource Tags.

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

Returns:

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


63
64
65
 
# File 'lib/oci/apiaccesscontrol/models/create_privileged_api_control_details.rb', line 63

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of the privilegedApi control.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/apiaccesscontrol/models/create_privileged_api_control_details.rb', line 17

def description
  @description
end

#display_name ⇒ String

Name of the privilegedApi control It has to be unique.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/apiaccesscontrol/models/create_privileged_api_control_details.rb', line 13

def display_name
  @display_name
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>) 


55
56
57
 
# File 'lib/oci/apiaccesscontrol/models/create_privileged_api_control_details.rb', line 55

def freeform_tags
  @freeform_tags
end

#notification_topic_id ⇒ String

[Required] The OCID of the OCI Notification topic to publish messages related to this Delegation Control.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/apiaccesscontrol/models/create_privileged_api_control_details.rb', line 26

def notification_topic_id
  @notification_topic_id
end

#number_of_approvers ⇒ Integer

Number of approvers required to approve an privilegedApi request.

Returns:

  • (Integer) 


47
48
49
 
# File 'lib/oci/apiaccesscontrol/models/create_privileged_api_control_details.rb', line 47

def number_of_approvers
  @number_of_approvers
end

#privileged_operation_list ⇒ Array<OCI::Apiaccesscontrol::Models::PrivilegedApiDetails>

[Required] List of privileged operator operations. If Privileged API Managment is enabled for a resource it will be validated whether the operation done by the operator is a part of privileged operation.

Returns:



35
36
37
 
# File 'lib/oci/apiaccesscontrol/models/create_privileged_api_control_details.rb', line 35

def privileged_operation_list
  @privileged_operation_list
end

#resource_type ⇒ String

[Required] resourceType for which the PrivilegedApiControl is applicable

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/apiaccesscontrol/models/create_privileged_api_control_details.rb', line 39

def resource_type
  @resource_type
end

#resources ⇒ Array<String>

[Required] contains Resource details

Returns:

  • (Array<String>) 


43
44
45
 
# File 'lib/oci/apiaccesscontrol/models/create_privileged_api_control_details.rb', line 43

def resources
  @resources
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
81
82
 
# File 'lib/oci/apiaccesscontrol/models/create_privileged_api_control_details.rb', line 66

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'notification_topic_id': :'notificationTopicId',
    'approver_group_id_list': :'approverGroupIdList',
    'privileged_operation_list': :'privilegedOperationList',
    'resource_type': :'resourceType',
    'resources': :'resources',
    'number_of_approvers': :'numberOfApprovers',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/apiaccesscontrol/models/create_privileged_api_control_details.rb', line 85

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'notification_topic_id': :'String',
    'approver_group_id_list': :'Array<String>',
    'privileged_operation_list': :'Array<OCI::Apiaccesscontrol::Models::PrivilegedApiDetails>',
    'resource_type': :'String',
    'resources': :'Array<String>',
    'number_of_approvers': :'Integer',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/oci/apiaccesscontrol/models/create_privileged_api_control_details.rb', line 192

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    notification_topic_id == other.notification_topic_id &&
    approver_group_id_list == other.approver_group_id_list &&
    privileged_operation_list == other.privileged_operation_list &&
    resource_type == other.resource_type &&
    resources == other.resources &&
    number_of_approvers == other.number_of_approvers &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/oci/apiaccesscontrol/models/create_privileged_api_control_details.rb', line 232

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


212
213
214
 
# File 'lib/oci/apiaccesscontrol/models/create_privileged_api_control_details.rb', line 212

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



221
222
223
 
# File 'lib/oci/apiaccesscontrol/models/create_privileged_api_control_details.rb', line 221

def hash
  [display_name, description, compartment_id, notification_topic_id, approver_group_id_list, privileged_operation_list, resource_type, resources, number_of_approvers, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



265
266
267
268
269
270
271
272
273
274
 
# File 'lib/oci/apiaccesscontrol/models/create_privileged_api_control_details.rb', line 265

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



259
260
261
 
# File 'lib/oci/apiaccesscontrol/models/create_privileged_api_control_details.rb', line 259

def to_s
  to_hash.to_s
end