Class: OCI::Identity::Models::BulkActionResource

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity/models/bulk_action_resource.rb

Overview

The bulk action resource entity.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BulkActionResource

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :identifier (String) —

    The value to assign to the #identifier property

  • :entity_type (String) —

    The value to assign to the #entity_type property

  • :metadata (Hash<String, String>) —

    The value to assign to the #metadata property



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/identity/models/bulk_action_resource.rb', line 83

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

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

Instance Attribute Details

#entity_type ⇒ String

[Required] The resource-type. To get the list of supported resource-types use list_bulk_action_resource_types.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/identity/models/bulk_action_resource.rb', line 20

def entity_type
  @entity_type
end

#identifier ⇒ String

[Required] The resource OCID.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/identity/models/bulk_action_resource.rb', line 14

def identifier
  @identifier
end

#metadata ⇒ Hash<String, String>

Additional information that helps to identity the resource for bulk action.

The APIs to delete and move most resource types only require the resource identifier (ocid). But some resource-types require additional identifying information.

This information is provided in the resource's public API document. It is also available through the list_bulk_action_resource_types.

Example: The APIs to delete or move the buckets resource-type require namespaceName and bucketName to identify the resource, as shown in the APIs, delete_bucket and update_bucket.

To add a bucket for bulk actions, specify namespaceName and bucketName in the metadata property as shown in this example

{
  \"identifier\": \"<OCID_of_bucket>\"
  \"entityType\": \"bucket\",
  \"metadata\":
  {
    \"namespaceName\": \"sampleNamespace\",
    \"bucketName\": \"sampleBucket\"
  }
}

Returns:

  • (Hash<String, String>) 


50
51
52
 
# File 'lib/oci/identity/models/bulk_action_resource.rb', line 50

def metadata
  @metadata
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/identity/models/bulk_action_resource.rb', line 53

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'identifier': :'identifier',
    'entity_type': :'entityType',
    'metadata': :'metadata'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
 
# File 'lib/oci/identity/models/bulk_action_resource.rb', line 64

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'identifier': :'String',
    'entity_type': :'String',
    'metadata': :'Hash<String, 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



107
108
109
110
111
112
113
114
 
# File 'lib/oci/identity/models/bulk_action_resource.rb', line 107

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

  self.class == other.class &&
    identifier == other.identifier &&
    entity_type == other.entity_type &&
    metadata == other.metadata
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



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

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


119
120
121
 
# File 'lib/oci/identity/models/bulk_action_resource.rb', line 119

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



128
129
130
 
# File 'lib/oci/identity/models/bulk_action_resource.rb', line 128

def hash
  [identifier, entity_type, metadata].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/identity/models/bulk_action_resource.rb', line 172

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



166
167
168
 
# File 'lib/oci/identity/models/bulk_action_resource.rb', line 166

def to_s
  to_hash.to_s
end