Class: OCI::ResourceScheduler::Models::Resource

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/resource_scheduler/models/resource.rb

Overview

This is the schedule resource entity.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Resource

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/oci/resource_scheduler/models/resource.rb', line 107

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

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

Instance Attribute Details

#id ⇒ String

[Required] This is the resource OCID.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/resource_scheduler/models/resource.rb', line 15

def id
  @id
end

#metadata ⇒ Hash<String, String>

This is additional information that helps to identity the resource for the schedule.

{
  \"id\": \"<OCID_of_bucket>\"
  \"metadata\":
  {
    \"namespaceName\": \"sampleNamespace\",
    \"bucketName\": \"sampleBucket\"
  }
}

Returns:

  • (Hash<String, String>) 


29
30
31
 
# File 'lib/oci/resource_scheduler/models/resource.rb', line 29

def metadata
  @metadata
end

#parameters ⇒ Array<OCI::ResourceScheduler::Models::Parameter>

This is the user input parameters to use when acting on the resource.

{ "parameters": [ { "parameterType": "BODY", "value": { "ip": "192.168.44.44", "memory": "1024", "synced_folders": [ { "host_path": "data/", "guest_path": "/var/www", "type": "default" } ], "forwarded_ports": [] } }, { "parameterType": "PATH", "value": { "compartmentId": "ocid1.compartment.oc1..xxxxx", "instanceId": "ocid1.vcn.oc1..yyyy" } }, { "parameterType": "QUERY", "value": { "limit": "10", "tenantId": "ocid1.tenant.oc1..zzzz" } }, { "parameterType": "HEADER", "value": { "token": "xxxx" } } ] }

Returns:



74
75
76
 
# File 'lib/oci/resource_scheduler/models/resource.rb', line 74

def parameters
  @parameters
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
 
# File 'lib/oci/resource_scheduler/models/resource.rb', line 77

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'metadata': :'metadata',
    'parameters': :'parameters'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/resource_scheduler/models/resource.rb', line 88

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'metadata': :'Hash<String, String>',
    'parameters': :'Array<OCI::ResourceScheduler::Models::Parameter>'
    # 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



127
128
129
130
131
132
133
134
 
# File 'lib/oci/resource_scheduler/models/resource.rb', line 127

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

  self.class == other.class &&
    id == other.id &&
    metadata == other.metadata &&
    parameters == other.parameters
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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/resource_scheduler/models/resource.rb', line 159

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


139
140
141
 
# File 'lib/oci/resource_scheduler/models/resource.rb', line 139

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



148
149
150
 
# File 'lib/oci/resource_scheduler/models/resource.rb', line 148

def hash
  [id, metadata, parameters].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



192
193
194
195
196
197
198
199
200
201
 
# File 'lib/oci/resource_scheduler/models/resource.rb', line 192

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



186
187
188
 
# File 'lib/oci/resource_scheduler/models/resource.rb', line 186

def to_s
  to_hash.to_s
end