Class: OCI::Apigateway::Models::Deployment

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

Overview

A deployment deploys an API on a gateway. Avoid entering confidential information. For more information, see API Gateway Concepts.

Constant Summary collapse

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
257
258
 
# File 'lib/oci/apigateway/models/deployment.rb', line 179

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

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

  self.gateway_id = attributes[:'gateway_id'] if attributes[:'gateway_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.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.path_prefix = attributes[:'pathPrefix'] if attributes[:'pathPrefix']

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

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

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment in which the resource is created.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/apigateway/models/deployment.rb', line 47

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


104
105
106
 
# File 'lib/oci/apigateway/models/deployment.rb', line 104

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Example: My new resource

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/apigateway/models/deployment.rb', line 41

def display_name
  @display_name
end

#endpoint ⇒ String

[Required] The endpoint to access this deployment on the gateway.

Returns:

  • (String) 


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

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


95
96
97
 
# File 'lib/oci/apigateway/models/deployment.rb', line 95

def freeform_tags
  @freeform_tags
end

#gateway_id ⇒ String

[Required] The OCID of the resource.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/apigateway/models/deployment.rb', line 33

def gateway_id
  @gateway_id
end

#id ⇒ String

[Required] The OCID of the resource.

Returns:

  • (String) 


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

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) 


82
83
84
 
# File 'lib/oci/apigateway/models/deployment.rb', line 82

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current state of the deployment.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/apigateway/models/deployment.rb', line 75

def lifecycle_state
  @lifecycle_state
end

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

Locks associated with this resource.

Returns:



86
87
88
 
# File 'lib/oci/apigateway/models/deployment.rb', line 86

def locks
  @locks
end

#path_prefix ⇒ String

[Required] A path on which to deploy all routes contained in the API deployment specification. For more information, see Deploying an API on an API Gateway by Creating an API Deployment.

Returns:

  • (String) 


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

def path_prefix
  @path_prefix
end

#specification ⇒ OCI::Apigateway::Models::ApiSpecification

This attribute is required.

Returns:



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

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


110
111
112
 
# File 'lib/oci/apigateway/models/deployment.rb', line 110

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


67
68
69
 
# File 'lib/oci/apigateway/models/deployment.rb', line 67

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


71
72
73
 
# File 'lib/oci/apigateway/models/deployment.rb', line 71

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/apigateway/models/deployment.rb', line 113

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'gateway_id': :'gatewayId',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'path_prefix': :'pathPrefix',
    'endpoint': :'endpoint',
    'specification': :'specification',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'locks': :'locks',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/apigateway/models/deployment.rb', line 136

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'gateway_id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'path_prefix': :'String',
    'endpoint': :'String',
    'specification': :'OCI::Apigateway::Models::ApiSpecification',
    'time_created': :'DateTime',
    'time_updated': :'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>>'
    # 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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/oci/apigateway/models/deployment.rb', line 280

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

  self.class == other.class &&
    id == other.id &&
    gateway_id == other.gateway_id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    path_prefix == other.path_prefix &&
    endpoint == other.endpoint &&
    specification == other.specification &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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
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



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

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


304
305
306
 
# File 'lib/oci/apigateway/models/deployment.rb', line 304

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



313
314
315
 
# File 'lib/oci/apigateway/models/deployment.rb', line 313

def hash
  [id, gateway_id, display_name, compartment_id, path_prefix, endpoint, specification, time_created, time_updated, lifecycle_state, lifecycle_details, locks, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



357
358
359
360
361
362
363
364
365
366
 
# File 'lib/oci/apigateway/models/deployment.rb', line 357

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



351
352
353
 
# File 'lib/oci/apigateway/models/deployment.rb', line 351

def to_s
  to_hash.to_s
end