Class: OCI::Functions::Models::CreateFunctionDetails

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

Overview

Properties to create a new function.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateFunctionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
179
180
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
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
 
# File 'lib/oci/functions/models/create_function_details.rb', line 154

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

Instance Attribute Details

#application_id ⇒ String

[Required] The OCID of the application this function belongs to.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/functions/models/create_function_details.rb', line 19

def application_id
  @application_id
end

#config ⇒ Hash<String, String>

Function configuration. These values are passed on to the function as environment variables, this overrides application configuration values. 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>) 


50
51
52
 
# File 'lib/oci/functions/models/create_function_details.rb', line 50

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


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

def defined_tags
  @defined_tags
end

#detached_mode_timeout_in_seconds ⇒ Integer

Timeout for detached function invocations. Value in seconds.

Returns:

  • (Integer) 


61
62
63
 
# File 'lib/oci/functions/models/create_function_details.rb', line 61

def detached_mode_timeout_in_seconds
  @detached_mode_timeout_in_seconds
end

#display_name ⇒ String

[Required] The display name of the function. The display name must be unique within the application containing the function. Avoid entering confidential information.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/functions/models/create_function_details.rb', line 15

def display_name
  @display_name
end

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

Returns:



64
65
66
 
# File 'lib/oci/functions/models/create_function_details.rb', line 64

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


78
79
80
 
# File 'lib/oci/functions/models/create_function_details.rb', line 78

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


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

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) 


33
34
35
 
# File 'lib/oci/functions/models/create_function_details.rb', line 33

def image_digest
  @image_digest
end

#memory_in_m_bs ⇒ Integer

[Required] Maximum usable memory for the function (MiB).

Returns:

  • (Integer) 


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

def memory_in_m_bs
  @memory_in_m_bs
end

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

Returns:



57
58
59
 
# File 'lib/oci/functions/models/create_function_details.rb', line 57

def provisioned_concurrency_config
  @provisioned_concurrency_config
end

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

Returns:



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

def source_details
  @source_details
end

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

Returns:



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

def success_destination
  @success_destination
end

#timeout_in_seconds ⇒ Integer

Timeout for executions of the function. Value in seconds.

Returns:

  • (Integer) 


54
55
56
 
# File 'lib/oci/functions/models/create_function_details.rb', line 54

def timeout_in_seconds
  @timeout_in_seconds
end

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

Returns:



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

def trace_config
  @trace_config
end

Class Method Details

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/functions/models/create_function_details.rb', line 88

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'application_id': :'applicationId',
    'image': :'image',
    'image_digest': :'imageDigest',
    'source_details': :'sourceDetails',
    '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',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/functions/models/create_function_details.rb', line 111

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'application_id': :'String',
    'image': :'String',
    'image_digest': :'String',
    'source_details': :'OCI::Functions::Models::FunctionSourceDetails',
    '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>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/oci/functions/models/create_function_details.rb', line 252

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

  self.class == other.class &&
    display_name == other.display_name &&
    application_id == other.application_id &&
    image == other.image &&
    image_digest == other.image_digest &&
    source_details == other.source_details &&
    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 &&
    defined_tags == other.defined_tags
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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/oci/functions/models/create_function_details.rb', line 296

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


276
277
278
 
# File 'lib/oci/functions/models/create_function_details.rb', line 276

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



285
286
287
 
# File 'lib/oci/functions/models/create_function_details.rb', line 285

def hash
  [display_name, application_id, image, image_digest, source_details, memory_in_m_bs, config, timeout_in_seconds, provisioned_concurrency_config, detached_mode_timeout_in_seconds, failure_destination, success_destination, trace_config, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



329
330
331
332
333
334
335
336
337
338
 
# File 'lib/oci/functions/models/create_function_details.rb', line 329

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



323
324
325
 
# File 'lib/oci/functions/models/create_function_details.rb', line 323

def to_s
  to_hash.to_s
end