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

  • :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

  • :parameters (Hash<String, String>)

    The value to assign to the #parameters property



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
244
245
246
247
248
249
250
251
252
253
# File 'lib/oci/apigateway/models/sdk.rb', line 172

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

Instance Attribute Details

#api_idString

[Required] The OCID of API resource

Returns:

  • (String)


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

def api_id
  @api_id
end

#artifact_urlString

File location for generated SDK.

Returns:

  • (String)


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

def artifact_url
  @artifact_url
end

#compartment_idString

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

Returns:

  • (String)


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

def compartment_id
  @compartment_id
end

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


98
99
100
# File 'lib/oci/apigateway/models/sdk.rb', line 98

def defined_tags
  @defined_tags
end

#display_nameString

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


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

def display_name
  @display_name
end

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


89
90
91
# File 'lib/oci/apigateway/models/sdk.rb', line 89

def freeform_tags
  @freeform_tags
end

#idString

[Required] The OCID of the resource.

Returns:

  • (String)


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

def id
  @id
end

#lifecycle_detailsString

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)


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_stateString

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)


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

def lifecycle_state
  @lifecycle_state
end

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


106
107
108
# File 'lib/oci/apigateway/models/sdk.rb', line 106

def parameters
  @parameters
end

#target_languageString

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

Returns:

  • (String)


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

def target_language
  @target_language
end

#time_artifact_url_expires_atDateTime

Expiry of artifact url.

Returns:

  • (DateTime)


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

def time_artifact_url_expires_at
  @time_artifact_url_expires_at
end

#time_createdDateTime

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

Returns:

  • (DateTime)


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

def time_created
  @time_created
end

#time_updatedDateTime

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

Returns:

  • (DateTime)


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_mapObject

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



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

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',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'parameters': :'parameters'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

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',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
# File 'lib/oci/apigateway/models/sdk.rb', line 275

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 &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
# File 'lib/oci/apigateway/models/sdk.rb', line 318

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


298
299
300
# File 'lib/oci/apigateway/models/sdk.rb', line 298

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



307
308
309
# File 'lib/oci/apigateway/models/sdk.rb', line 307

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, freeform_tags, defined_tags, parameters].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



351
352
353
354
355
356
357
358
359
360
# File 'lib/oci/apigateway/models/sdk.rb', line 351

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



345
346
347
# File 'lib/oci/apigateway/models/sdk.rb', line 345

def to_s
  to_hash.to_s
end