Class: OCI::Functions::Models::ApplicationSummary

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

Overview

Summary of an application.

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApplicationSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/oci/functions/models/application_summary.rb', line 173

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

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

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

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

  self.network_security_group_ids = attributes[:'networkSecurityGroupIds'] if attributes[:'networkSecurityGroupIds']

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

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

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

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

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

  self.image_policy_config = attributes[:'imagePolicyConfig'] if attributes[:'imagePolicyConfig']

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

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

  self.security_attributes = attributes[:'securityAttributes'] if attributes[:'securityAttributes']

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

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

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment that contains the application.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/functions/models/application_summary.rb', line 28

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\"}}

Returns:

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


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

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\"}

Returns:

  • (Hash<String, String>) 


71
72
73
 
# File 'lib/oci/functions/models/application_summary.rb', line 71

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the application.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/functions/models/application_summary.rb', line 23

def id
  @id
end

#image_policy_config ⇒ OCI::Functions::Models::ImagePolicyConfig

Returns:



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

def image_policy_config
  @image_policy_config
end

#lifecycle_state ⇒ String

The current state of the application.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/functions/models/application_summary.rb', line 38

def lifecycle_state
  @lifecycle_state
end

#logging ⇒ OCI::Functions::Models::ApplicationLoggingConfig

Returns:



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

def logging
  @logging
end

#network_security_group_ids ⇒ Array<String>

The OCID[https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm]s of the Network Security Groups to add the application to.

Returns:

  • (Array<String>) 


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

def network_security_group_ids
  @network_security_group_ids
end

#security_attributes ⇒ Hash<String, Hash<String, Object>>

Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"enforce\"}}}

Returns:

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


104
105
106
 
# File 'lib/oci/functions/models/application_summary.rb', line 104

def security_attributes
  @security_attributes
end

#shape ⇒ String

Valid values are GENERIC_X86, GENERIC_ARM and GENERIC_X86_ARM. Default is GENERIC_X86. Setting this to GENERIC_X86, will run the functions in the application on X86 processor architecture. Setting this to GENERIC_ARM, will run the functions in the application on ARM processor architecture. When set to GENERIC_X86_ARM, functions in the application are run on either X86 or ARM processor architecture. Accepted values are: GENERIC_X86, GENERIC_ARM, GENERIC_X86_ARM

Returns:

  • (String) 


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

def shape
  @shape
end

#subnet_ids ⇒ Array<String>

The OCID[https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm]s of the subnets in which to run functions in the application.

Returns:

  • (Array<String>) 


43
44
45
 
# File 'lib/oci/functions/models/application_summary.rb', line 43

def subnet_ids
  @subnet_ids
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


86
87
88
 
# File 'lib/oci/functions/models/application_summary.rb', line 86

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time the application was updated, expressed in RFC 3339 timestamp format. Example: 2018-09-12T22:47:12.613Z

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

#trace_config ⇒ OCI::Functions::Models::ApplicationTraceConfig

Returns:



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

def trace_config
  @trace_config
end

Class Method Details

.attribute_map ⇒ Object

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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/functions/models/application_summary.rb', line 107

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'lifecycle_state': :'lifecycleState',
    'subnet_ids': :'subnetIds',
    'shape': :'shape',
    'network_security_group_ids': :'networkSecurityGroupIds',
    'trace_config': :'traceConfig',
    'logging': :'logging',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'image_policy_config': :'imagePolicyConfig',
    'security_attributes': :'securityAttributes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/functions/models/application_summary.rb', line 130

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'lifecycle_state': :'String',
    'subnet_ids': :'Array<String>',
    'shape': :'String',
    'network_security_group_ids': :'Array<String>',
    'trace_config': :'OCI::Functions::Models::ApplicationTraceConfig',
    'logging': :'OCI::Functions::Models::ApplicationLoggingConfig',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'image_policy_config': :'OCI::Functions::Models::ImagePolicyConfig',
    'security_attributes': :'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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/oci/functions/models/application_summary.rb', line 278

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    lifecycle_state == other.lifecycle_state &&
    subnet_ids == other.subnet_ids &&
    shape == other.shape &&
    network_security_group_ids == other.network_security_group_ids &&
    trace_config == other.trace_config &&
    logging == other.logging &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    image_policy_config == other.image_policy_config &&
    security_attributes == other.security_attributes
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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/oci/functions/models/application_summary.rb', line 322

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


302
303
304
 
# File 'lib/oci/functions/models/application_summary.rb', line 302

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



311
312
313
 
# File 'lib/oci/functions/models/application_summary.rb', line 311

def hash
  [id, compartment_id, display_name, lifecycle_state, subnet_ids, shape, network_security_group_ids, trace_config, logging, freeform_tags, defined_tags, time_created, time_updated, image_policy_config, security_attributes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



355
356
357
358
359
360
361
362
363
364
 
# File 'lib/oci/functions/models/application_summary.rb', line 355

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



349
350
351
 
# File 'lib/oci/functions/models/application_summary.rb', line 349

def to_s
  to_hash.to_s
end