Class: OCI::Functions::Models::FunctionSummary
- Inherits:
-
Object
- Object
- OCI::Functions::Models::FunctionSummary
- Defined in:
- lib/oci/functions/models/function_summary.rb
Overview
Summary of a function.
Constant Summary collapse
- 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
-
#application_id ⇒ String
The OCID of the application the function belongs to.
-
#compartment_id ⇒ String
The OCID of the compartment that contains the function.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
The display name of the function.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the function.
-
#image ⇒ String
The qualified name of the Docker image to use in the function, including the image tag.
-
#image_digest ⇒ String
The image digest for the version of the image that will be pulled when invoking this function.
-
#invoke_endpoint ⇒ String
The base https invoke URL to set on a client in order to invoke a function.
-
#lifecycle_state ⇒ String
The current state of the function.
-
#memory_in_m_bs ⇒ Integer
Maximum usable memory for the function (MiB).
- #provisioned_concurrency_config ⇒ OCI::Functions::Models::FunctionProvisionedConcurrencyConfig
-
#shape ⇒ String
The processor shape (
GENERIC_X86
/GENERIC_ARM
) on which to run functions in the application, extracted from the image manifest. - #source_details ⇒ OCI::Functions::Models::FunctionSourceDetails
-
#time_created ⇒ DateTime
The time the function was created, expressed in RFC 3339 timestamp format.
-
#time_updated ⇒ DateTime
The time the function was updated, expressed in RFC 3339 timestamp format.
-
#timeout_in_seconds ⇒ Integer
Timeout for executions of the function.
- #trace_config ⇒ OCI::Functions::Models::FunctionTraceConfig
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ FunctionSummary
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ FunctionSummary
Initializes the object
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 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 |
# File 'lib/oci/functions/models/function_summary.rb', line 192 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.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.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.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.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.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. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = 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. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = 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.
32 33 34 |
# File 'lib/oci/functions/models/function_summary.rb', line 32 def application_id @application_id end |
#compartment_id ⇒ String
The OCID of the compartment that contains the function.
37 38 39 |
# File 'lib/oci/functions/models/function_summary.rb', line 37 def compartment_id @compartment_id 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\"}}
98 99 100 |
# File 'lib/oci/functions/models/function_summary.rb', line 98 def @defined_tags end |
#display_name ⇒ String
The display name of the function. The display name is unique within the application containing the function.
28 29 30 |
# File 'lib/oci/functions/models/function_summary.rb', line 28 def display_name @display_name 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\"}
86 87 88 |
# File 'lib/oci/functions/models/function_summary.rb', line 86 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the function.
23 24 25 |
# File 'lib/oci/functions/models/function_summary.rb', line 23 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
49 50 51 |
# File 'lib/oci/functions/models/function_summary.rb', line 49 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
56 57 58 |
# File 'lib/oci/functions/models/function_summary.rb', line 56 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.
91 92 93 |
# File 'lib/oci/functions/models/function_summary.rb', line 91 def invoke_endpoint @invoke_endpoint end |
#lifecycle_state ⇒ String
The current state of the function.
42 43 44 |
# File 'lib/oci/functions/models/function_summary.rb', line 42 def lifecycle_state @lifecycle_state end |
#memory_in_m_bs ⇒ Integer
Maximum usable memory for the function (MiB).
68 69 70 |
# File 'lib/oci/functions/models/function_summary.rb', line 68 def memory_in_m_bs @memory_in_m_bs end |
#provisioned_concurrency_config ⇒ OCI::Functions::Models::FunctionProvisionedConcurrencyConfig
75 76 77 |
# File 'lib/oci/functions/models/function_summary.rb', line 75 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.
64 65 66 |
# File 'lib/oci/functions/models/function_summary.rb', line 64 def shape @shape end |
#source_details ⇒ OCI::Functions::Models::FunctionSourceDetails
59 60 61 |
# File 'lib/oci/functions/models/function_summary.rb', line 59 def source_details @source_details end |
#time_created ⇒ DateTime
The time the function was created, expressed in RFC 3339 timestamp format.
Example: 2018-09-12T22:47:12.613Z
106 107 108 |
# File 'lib/oci/functions/models/function_summary.rb', line 106 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
114 115 116 |
# File 'lib/oci/functions/models/function_summary.rb', line 114 def time_updated @time_updated end |
#timeout_in_seconds ⇒ Integer
Timeout for executions of the function. Value in seconds.
72 73 74 |
# File 'lib/oci/functions/models/function_summary.rb', line 72 def timeout_in_seconds @timeout_in_seconds end |
#trace_config ⇒ OCI::Functions::Models::FunctionTraceConfig
78 79 80 |
# File 'lib/oci/functions/models/function_summary.rb', line 78 def trace_config @trace_config end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/oci/functions/models/function_summary.rb', line 117 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'application_id': :'applicationId', 'compartment_id': :'compartmentId', 'lifecycle_state': :'lifecycleState', 'image': :'image', 'image_digest': :'imageDigest', 'source_details': :'sourceDetails', 'shape': :'shape', 'memory_in_m_bs': :'memoryInMBs', 'timeout_in_seconds': :'timeoutInSeconds', 'provisioned_concurrency_config': :'provisionedConcurrencyConfig', '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.
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
# File 'lib/oci/functions/models/function_summary.rb', line 143 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'application_id': :'String', 'compartment_id': :'String', 'lifecycle_state': :'String', 'image': :'String', 'image_digest': :'String', 'source_details': :'OCI::Functions::Models::FunctionSourceDetails', 'shape': :'String', 'memory_in_m_bs': :'Integer', 'timeout_in_seconds': :'Integer', 'provisioned_concurrency_config': :'OCI::Functions::Models::FunctionProvisionedConcurrencyConfig', '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.
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 |
# File 'lib/oci/functions/models/function_summary.rb', line 317 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && display_name == other.display_name && application_id == other.application_id && compartment_id == other.compartment_id && lifecycle_state == other.lifecycle_state && 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 && timeout_in_seconds == other.timeout_in_seconds && provisioned_concurrency_config == other.provisioned_concurrency_config && trace_config == other.trace_config && == other. && invoke_endpoint == other.invoke_endpoint && == other. && time_created == other.time_created && time_updated == other.time_updated end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/oci/functions/models/function_summary.rb', line 364 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
344 345 346 |
# File 'lib/oci/functions/models/function_summary.rb', line 344 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
353 354 355 |
# File 'lib/oci/functions/models/function_summary.rb', line 353 def hash [id, display_name, application_id, compartment_id, lifecycle_state, image, image_digest, source_details, shape, memory_in_m_bs, timeout_in_seconds, provisioned_concurrency_config, trace_config, , invoke_endpoint, , time_created, time_updated].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
397 398 399 400 401 402 403 404 405 406 |
# File 'lib/oci/functions/models/function_summary.rb', line 397 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
391 392 393 |
# File 'lib/oci/functions/models/function_summary.rb', line 391 def to_s to_hash.to_s end |