Class: OCI::Functions::Models::Function

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/functions/models/function.rb

Overview

A function resource defines the code (Docker image) and configuration for a specific function. Functions are defined in applications. Avoid entering confidential information.

Constant Summary collapse

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

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

  • :display_name (String)

    The value to assign to the #display_name property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :application_id (String)

    The value to assign to the #application_id property

  • :compartment_id (String)

    The value to assign to the #compartment_id property

  • :image (String)

    The value to assign to the #image property

  • :image_digest (String)

    The value to assign to the #image_digest property

  • :memory_in_m_bs (Integer)

    The value to assign to the #memory_in_m_bs property

  • :config (Hash<String, String>)

    The value to assign to the #config property

  • :timeout_in_seconds (Integer)

    The value to assign to the #timeout_in_seconds property

  • :freeform_tags (Hash<String, String>)

    The value to assign to the #freeform_tags property

  • :invoke_endpoint (String)

    The value to assign to the #invoke_endpoint property

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

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



182
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
# File 'lib/oci/functions/models/function.rb', line 182

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

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

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

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

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

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

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

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

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

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

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

  self.timeout_in_seconds = attributes[:'timeoutInSeconds'] if attributes[:'timeoutInSeconds']
  self.timeout_in_seconds = 30 if timeout_in_seconds.nil? && !attributes.key?(:'timeoutInSeconds') # rubocop:disable Style/StringLiterals

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

  self.timeout_in_seconds = attributes[:'timeout_in_seconds'] if attributes[:'timeout_in_seconds']
  self.timeout_in_seconds = 30 if timeout_in_seconds.nil? && !attributes.key?(:'timeoutInSeconds') && !attributes.key?(:'timeout_in_seconds') # rubocop:disable Style/StringLiterals

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

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

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

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

Instance Attribute Details

#application_idString

The OCID of the application the function belongs to.

Returns:

  • (String)


40
41
42
# File 'lib/oci/functions/models/function.rb', line 40

def application_id
  @application_id
end

#compartment_idString

The OCID of the compartment that contains the function.

Returns:

  • (String)


45
46
47
# File 'lib/oci/functions/models/function.rb', line 45

def compartment_id
  @compartment_id
end

#configHash<String, String>

Function configuration. Overrides application configuration. Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters.

Example: {\"MY_FUNCTION_CONFIG\": \"ConfVal\"}

The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8.

Returns:

  • (Hash<String, String>)


73
74
75
# File 'lib/oci/functions/models/function.rb', line 73

def config
  @config
end

#defined_tagsHash<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>>)


97
98
99
# File 'lib/oci/functions/models/function.rb', line 97

def defined_tags
  @defined_tags
end

#display_nameString

The display name of the function. The display name is unique within the application containing the function.

Returns:

  • (String)


31
32
33
# File 'lib/oci/functions/models/function.rb', line 31

def display_name
  @display_name
end

#freeform_tagsHash<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>)


85
86
87
# File 'lib/oci/functions/models/function.rb', line 85

def freeform_tags
  @freeform_tags
end

#idString

The OCID of the function.

Returns:

  • (String)


26
27
28
# File 'lib/oci/functions/models/function.rb', line 26

def id
  @id
end

#imageString

The qualified name of the Docker image to use in the function, including the image tag. The image should be in the OCI Registry that is in the same region as the function itself. Example: phx.ocir.io/ten/functions/function:0.0.1

Returns:

  • (String)


52
53
54
# File 'lib/oci/functions/models/function.rb', line 52

def image
  @image
end

#image_digestString

The image digest for the version of the image that will be pulled when invoking this function. If no value is specified, the digest currently associated with the image in the OCI Registry will be used. Example: sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7

Returns:

  • (String)


59
60
61
# File 'lib/oci/functions/models/function.rb', line 59

def image_digest
  @image_digest
end

#invoke_endpointString

The base https invoke URL to set on a client in order to invoke a function. This URL will never change over the lifetime of the function and can be cached.

Returns:

  • (String)


90
91
92
# File 'lib/oci/functions/models/function.rb', line 90

def invoke_endpoint
  @invoke_endpoint
end

#lifecycle_stateString

The current state of the function.

Returns:

  • (String)


36
37
38
# File 'lib/oci/functions/models/function.rb', line 36

def lifecycle_state
  @lifecycle_state
end

#memory_in_m_bsInteger

Maximum usable memory for the function (MiB).

Returns:

  • (Integer)


63
64
65
# File 'lib/oci/functions/models/function.rb', line 63

def memory_in_m_bs
  @memory_in_m_bs
end

#time_createdDateTime

The time the function was created, expressed in RFC 3339 timestamp format.

Example: 2018-09-12T22:47:12.613Z

Returns:

  • (DateTime)


105
106
107
# File 'lib/oci/functions/models/function.rb', line 105

def time_created
  @time_created
end

#time_updatedDateTime

The time the function was updated, expressed in RFC 3339 timestamp format.

Example: 2018-09-12T22:47:12.613Z

Returns:

  • (DateTime)


113
114
115
# File 'lib/oci/functions/models/function.rb', line 113

def time_updated
  @time_updated
end

#timeout_in_secondsInteger

Timeout for executions of the function. Value in seconds.

Returns:

  • (Integer)


77
78
79
# File 'lib/oci/functions/models/function.rb', line 77

def timeout_in_seconds
  @timeout_in_seconds
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'lifecycle_state': :'lifecycleState',
    'application_id': :'applicationId',
    'compartment_id': :'compartmentId',
    'image': :'image',
    'image_digest': :'imageDigest',
    'memory_in_m_bs': :'memoryInMBs',
    'config': :'config',
    'timeout_in_seconds': :'timeoutInSeconds',
    'freeform_tags': :'freeformTags',
    'invoke_endpoint': :'invokeEndpoint',
    'defined_tags': :'definedTags',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'lifecycle_state': :'String',
    'application_id': :'String',
    'compartment_id': :'String',
    'image': :'String',
    'image_digest': :'String',
    'memory_in_m_bs': :'Integer',
    'config': :'Hash<String, String>',
    'timeout_in_seconds': :'Integer',
    'freeform_tags': :'Hash<String, String>',
    'invoke_endpoint': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime'
    # 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



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

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    lifecycle_state == other.lifecycle_state &&
    application_id == other.application_id &&
    compartment_id == other.compartment_id &&
    image == other.image &&
    image_digest == other.image_digest &&
    memory_in_m_bs == other.memory_in_m_bs &&
    config == other.config &&
    timeout_in_seconds == other.timeout_in_seconds &&
    freeform_tags == other.freeform_tags &&
    invoke_endpoint == other.invoke_endpoint &&
    defined_tags == other.defined_tags &&
    time_created == other.time_created &&
    time_updated == other.time_updated
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



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

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


313
314
315
# File 'lib/oci/functions/models/function.rb', line 313

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



322
323
324
# File 'lib/oci/functions/models/function.rb', line 322

def hash
  [id, display_name, lifecycle_state, application_id, compartment_id, image, image_digest, memory_in_m_bs, config, timeout_in_seconds, freeform_tags, invoke_endpoint, defined_tags, time_created, time_updated].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



366
367
368
369
370
371
372
373
374
375
# File 'lib/oci/functions/models/function.rb', line 366

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



360
361
362
# File 'lib/oci/functions/models/function.rb', line 360

def to_s
  to_hash.to_s
end