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
SHAPE_ENUM = 
[
  SHAPE_GENERIC_X86 = 'GENERIC_X86'.freeze,
  SHAPE_GENERIC_ARM = 'GENERIC_ARM'.freeze,
  SHAPE_GENERIC_X86_ARM = 'GENERIC_X86_ARM'.freeze,
  SHAPE_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):



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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/oci/functions/models/function.rb', line 238

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

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

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

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

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

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

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

  self.detached_mode_timeout_in_seconds = attributes[:'detachedModeTimeoutInSeconds'] if attributes[:'detachedModeTimeoutInSeconds']

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

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

  self.failure_destination = attributes[:'failureDestination'] if attributes[:'failureDestination']

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

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

  self.success_destination = attributes[:'successDestination'] if attributes[:'successDestination']

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

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

  self.trace_config = attributes[:'traceConfig'] if attributes[:'traceConfig']

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

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

  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_id ⇒ String

The OCID of the application the function belongs to.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/functions/models/function.rb', line 48

def application_id
  @application_id
end

#compartment_id ⇒ String

The OCID of the compartment that contains the function.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#config ⇒ Hash<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>) 


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

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


132
133
134
 
# File 'lib/oci/functions/models/function.rb', line 132

def defined_tags
  @defined_tags
end

#detached_mode_timeout_in_seconds ⇒ Integer

Timeout for detached function invocations. Value in seconds.

Example: {\"detachedModeTimeoutInSeconds\": 900}

Returns:

  • (Integer) 


103
104
105
 
# File 'lib/oci/functions/models/function.rb', line 103

def detached_mode_timeout_in_seconds
  @detached_mode_timeout_in_seconds
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

#failure_destination ⇒ OCI::Functions::Models::FailureDestinationDetails

Returns:



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

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


120
121
122
 
# File 'lib/oci/functions/models/function.rb', line 120

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the function.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/functions/models/function.rb', line 34

def id
  @id
end

#image ⇒ String

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) 


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

def image
  @image
end

#image_digest ⇒ String

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) 


67
68
69
 
# File 'lib/oci/functions/models/function.rb', line 67

def image_digest
  @image_digest
end

#invoke_endpoint ⇒ String

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) 


125
126
127
 
# File 'lib/oci/functions/models/function.rb', line 125

def invoke_endpoint
  @invoke_endpoint
end

#lifecycle_state ⇒ String

The current state of the function.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#memory_in_m_bs ⇒ Integer

Maximum usable memory for the function (MiB).

Returns:

  • (Integer) 


79
80
81
 
# File 'lib/oci/functions/models/function.rb', line 79

def memory_in_m_bs
  @memory_in_m_bs
end

#provisioned_concurrency_config ⇒ OCI::Functions::Models::FunctionProvisionedConcurrencyConfig

Returns:



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

def provisioned_concurrency_config
  @provisioned_concurrency_config
end

#shape ⇒ String

The processor shape (GENERIC_X86/GENERIC_ARM) on which to run functions in the application, extracted from the image manifest.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/functions/models/function.rb', line 75

def shape
  @shape
end

#source_details ⇒ OCI::Functions::Models::FunctionSourceDetails

Returns:



70
71
72
 
# File 'lib/oci/functions/models/function.rb', line 70

def source_details
  @source_details
end

#success_destination ⇒ OCI::Functions::Models::SuccessDestinationDetails

Returns:



109
110
111
 
# File 'lib/oci/functions/models/function.rb', line 109

def success_destination
  @success_destination
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


140
141
142
 
# File 'lib/oci/functions/models/function.rb', line 140

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

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

Returns:

  • (DateTime) 


148
149
150
 
# File 'lib/oci/functions/models/function.rb', line 148

def time_updated
  @time_updated
end

#timeout_in_seconds ⇒ Integer

Timeout for executions of the function. Value in seconds.

Returns:

  • (Integer) 


93
94
95
 
# File 'lib/oci/functions/models/function.rb', line 93

def timeout_in_seconds
  @timeout_in_seconds
end

#trace_config ⇒ OCI::Functions::Models::FunctionTraceConfig

Returns:



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

def trace_config
  @trace_config
end

Class Method Details

.attribute_map ⇒ Object

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



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

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',
    'source_details': :'sourceDetails',
    'shape': :'shape',
    'memory_in_m_bs': :'memoryInMBs',
    'config': :'config',
    'timeout_in_seconds': :'timeoutInSeconds',
    'provisioned_concurrency_config': :'provisionedConcurrencyConfig',
    'detached_mode_timeout_in_seconds': :'detachedModeTimeoutInSeconds',
    'failure_destination': :'failureDestination',
    'success_destination': :'successDestination',
    'trace_config': :'traceConfig',
    'freeform_tags': :'freeformTags',
    'invoke_endpoint': :'invokeEndpoint',
    'defined_tags': :'definedTags',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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',
    'source_details': :'OCI::Functions::Models::FunctionSourceDetails',
    'shape': :'String',
    'memory_in_m_bs': :'Integer',
    'config': :'Hash<String, String>',
    'timeout_in_seconds': :'Integer',
    'provisioned_concurrency_config': :'OCI::Functions::Models::FunctionProvisionedConcurrencyConfig',
    'detached_mode_timeout_in_seconds': :'Integer',
    'failure_destination': :'OCI::Functions::Models::FailureDestinationDetails',
    'success_destination': :'OCI::Functions::Models::SuccessDestinationDetails',
    'trace_config': :'OCI::Functions::Models::FunctionTraceConfig',
    '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



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/oci/functions/models/function.rb', line 396

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 &&
    source_details == other.source_details &&
    shape == other.shape &&
    memory_in_m_bs == other.memory_in_m_bs &&
    config == other.config &&
    timeout_in_seconds == other.timeout_in_seconds &&
    provisioned_concurrency_config == other.provisioned_concurrency_config &&
    detached_mode_timeout_in_seconds == other.detached_mode_timeout_in_seconds &&
    failure_destination == other.failure_destination &&
    success_destination == other.success_destination &&
    trace_config == other.trace_config &&
    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



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/oci/functions/models/function.rb', line 447

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


427
428
429
 
# File 'lib/oci/functions/models/function.rb', line 427

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



436
437
438
 
# File 'lib/oci/functions/models/function.rb', line 436

def hash
  [id, display_name, lifecycle_state, application_id, compartment_id, image, image_digest, source_details, shape, memory_in_m_bs, config, timeout_in_seconds, provisioned_concurrency_config, detached_mode_timeout_in_seconds, failure_destination, success_destination, trace_config, freeform_tags, invoke_endpoint, defined_tags, time_created, time_updated].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



480
481
482
483
484
485
486
487
488
489
 
# File 'lib/oci/functions/models/function.rb', line 480

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



474
475
476
 
# File 'lib/oci/functions/models/function.rb', line 474

def to_s
  to_hash.to_s
end