Class: OCI::Apigateway::Models::Sdk

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apigateway/models/sdk.rb

Overview

Information about the SDK.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.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 = {}) ⇒ Sdk

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

  • :api_id (String) —

    The value to assign to the #api_id property

  • :compartment_id (String) —

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :target_language (String) —

    The value to assign to the #target_language property

  • :artifact_url (String) —

    The value to assign to the #artifact_url property

  • :time_artifact_url_expires_at (DateTime) —

    The value to assign to the #time_artifact_url_expires_at property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :locks (Array<OCI::Apigateway::Models::ResourceLock>) —

    The value to assign to the #locks property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

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

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property

  • :parameters (Hash<String, String>) —

    The value to assign to the #parameters property



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
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/oci/apigateway/models/sdk.rb', line 189

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

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

  self.api_id = attributes[:'api_id'] if attributes[:'api_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.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.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.target_language = attributes[:'targetLanguage'] if attributes[:'targetLanguage']

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

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

  self.artifact_url = attributes[:'artifactUrl'] if attributes[:'artifactUrl']

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

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

  self.time_artifact_url_expires_at = attributes[:'timeArtifactUrlExpiresAt'] if attributes[:'timeArtifactUrlExpiresAt']

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#api_id ⇒ String

[Required] The OCID of API resource

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/apigateway/models/sdk.rb', line 29

def api_id
  @api_id
end

#artifact_url ⇒ String

File location for generated SDK.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/apigateway/models/sdk.rb', line 60

def artifact_url
  @artifact_url
end

#compartment_id ⇒ String

The OCID of the compartment in which the resource is created.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/apigateway/models/sdk.rb', line 35

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


103
104
105
 
# File 'lib/oci/apigateway/models/sdk.rb', line 103

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Example: My new resource

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/apigateway/models/sdk.rb', line 51

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


94
95
96
 
# File 'lib/oci/apigateway/models/sdk.rb', line 94

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the resource.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/apigateway/models/sdk.rb', line 24

def id
  @id
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/apigateway/models/sdk.rb', line 81

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current state of the SDK. - The SDK will be in CREATING state if the SDK creation is in progress. - The SDK will be in ACTIVE state if create is successful. - The SDK will be in FAILED state if the create, or delete fails. - The SDK will be in DELETING state if the deletion in in progress. - The SDK will be in DELETED state if the delete is successful.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/apigateway/models/sdk.rb', line 74

def lifecycle_state
  @lifecycle_state
end

#locks ⇒ Array<OCI::Apigateway::Models::ResourceLock>

Locks associated with this resource.

Returns:



85
86
87
 
# File 'lib/oci/apigateway/models/sdk.rb', line 85

def locks
  @locks
end

#parameters ⇒ Hash<String, String>

Additional optional configurations passed. The applicable config keys are listed under "parameters" when "/sdkLanguageTypes" is called.

Example: {\"configName\": \"configValue\"}

Returns:

  • (Hash<String, String>) 


117
118
119
 
# File 'lib/oci/apigateway/models/sdk.rb', line 117

def parameters
  @parameters
end

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

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


109
110
111
 
# File 'lib/oci/apigateway/models/sdk.rb', line 109

def system_tags
  @system_tags
end

#target_language ⇒ String

[Required] The string representing the target programming language for generating the SDK.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/apigateway/models/sdk.rb', line 56

def target_language
  @target_language
end

#time_artifact_url_expires_at ⇒ DateTime

Expiry of artifact url.

Returns:

  • (DateTime) 


64
65
66
 
# File 'lib/oci/apigateway/models/sdk.rb', line 64

def time_artifact_url_expires_at
  @time_artifact_url_expires_at
end

#time_created ⇒ DateTime

The time this resource was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


39
40
41
 
# File 'lib/oci/apigateway/models/sdk.rb', line 39

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time this resource was last updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


43
44
45
 
# File 'lib/oci/apigateway/models/sdk.rb', line 43

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/apigateway/models/sdk.rb', line 120

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'api_id': :'apiId',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'display_name': :'displayName',
    'target_language': :'targetLanguage',
    'artifact_url': :'artifactUrl',
    'time_artifact_url_expires_at': :'timeArtifactUrlExpiresAt',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'locks': :'locks',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'parameters': :'parameters'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/apigateway/models/sdk.rb', line 144

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'api_id': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'display_name': :'String',
    'target_language': :'String',
    'artifact_url': :'String',
    'time_artifact_url_expires_at': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'locks': :'Array<OCI::Apigateway::Models::ResourceLock>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'parameters': :'Hash<String, String>'
    # 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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/oci/apigateway/models/sdk.rb', line 300

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

  self.class == other.class &&
    id == other.id &&
    api_id == other.api_id &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    display_name == other.display_name &&
    target_language == other.target_language &&
    artifact_url == other.artifact_url &&
    time_artifact_url_expires_at == other.time_artifact_url_expires_at &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    locks == other.locks &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    parameters == other.parameters
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



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/oci/apigateway/models/sdk.rb', line 345

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


325
326
327
 
# File 'lib/oci/apigateway/models/sdk.rb', line 325

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



334
335
336
 
# File 'lib/oci/apigateway/models/sdk.rb', line 334

def hash
  [id, api_id, compartment_id, time_created, time_updated, display_name, target_language, artifact_url, time_artifact_url_expires_at, lifecycle_state, lifecycle_details, locks, freeform_tags, defined_tags, system_tags, parameters].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



378
379
380
381
382
383
384
385
386
387
 
# File 'lib/oci/apigateway/models/sdk.rb', line 378

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



372
373
374
 
# File 'lib/oci/apigateway/models/sdk.rb', line 372

def to_s
  to_hash.to_s
end