class OCI::Identity::Models::BulkActionResource
The bulk action resource entity.
Attributes
[Required] The resource-type. To get the list of supported resource-types use {#list_bulk_action_resource_types list_bulk_action_resource_types}.
@return [String]
[Required] The resource OCID. @return [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 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 delete_bucket} and {#update_bucket 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\" } }
@return [Hash<String, String>]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/identity/models/bulk_action_resource.rb, line 52 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'identifier': :'identifier', 'entity_type': :'entityType', 'metadata': :'metadata' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :identifier The value to assign to the {#identifier} property @option attributes [String] :entity_type The value to assign to the {#entity_type} property @option attributes [Hash<String, String>] :metadata The value to assign to the {#metadata} property
# File lib/oci/identity/models/bulk_action_resource.rb, line 82 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
Attribute type mapping.
# File lib/oci/identity/models/bulk_action_resource.rb, line 63 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'identifier': :'String', 'entity_type': :'String', 'metadata': :'Hash<String, String>' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/identity/models/bulk_action_resource.rb, line 106 def ==(other) return true if equal?(other) self.class == other.class && identifier == other.identifier && entity_type == other.entity_type && metadata == other.metadata end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/identity/models/bulk_action_resource.rb, line 138 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/identity/models/bulk_action_resource.rb, line 118 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/identity/models/bulk_action_resource.rb, line 127 def hash [identifier, entity_type, metadata].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/identity/models/bulk_action_resource.rb, line 171 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/identity/models/bulk_action_resource.rb, line 165 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/identity/models/bulk_action_resource.rb, line 188 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end