Class: OCI::VbsInst::Models::VbsInstance

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/vbs_inst/models/vbs_instance.rb

Overview

Visual Builder Studio service instance

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.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 = {}) ⇒ VbsInstance

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

  • :name (String) —

    The value to assign to the #name property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :is_resource_usage_agreement_granted (BOOLEAN) —

    The value to assign to the #is_resource_usage_agreement_granted property

  • :resource_compartment_id (String) —

    The value to assign to the #resource_compartment_id property

  • :vbs_access_url (String) —

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

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecyle_details (String) —

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

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

    The value to assign to the #system_tags property



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
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
 
# File 'lib/oci/vbs_inst/models/vbs_instance.rb', line 148

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

  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.is_resource_usage_agreement_granted = attributes[:'isResourceUsageAgreementGranted'] unless attributes[:'isResourceUsageAgreementGranted'].nil?

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

  self.is_resource_usage_agreement_granted = attributes[:'is_resource_usage_agreement_granted'] unless attributes[:'is_resource_usage_agreement_granted'].nil?

  self.resource_compartment_id = attributes[:'resourceCompartmentId'] if attributes[:'resourceCompartmentId']

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

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

  self.vbs_access_url = attributes[:'vbsAccessUrl'] if attributes[:'vbsAccessUrl']

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

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

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

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

  self.lifecyle_details = attributes[:'lifecyle_details'] if attributes[:'lifecyle_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.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] Compartment of the service instance

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/vbs_inst/models/vbs_instance.rb', line 36

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. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


76
77
78
 
# File 'lib/oci/vbs_inst/models/vbs_instance.rb', line 76

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] Service instance display name

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/vbs_inst/models/vbs_instance.rb', line 32

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


70
71
72
 
# File 'lib/oci/vbs_inst/models/vbs_instance.rb', line 70

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique identifier that is immutable on creation

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/vbs_inst/models/vbs_instance.rb', line 24

def id
  @id
end

#is_resource_usage_agreement_granted ⇒ BOOLEAN

Whether the VBS service instance owner explicitly approved VBS to create and use resources in the customer tenancy

Returns:

  • (BOOLEAN) 


40
41
42
 
# File 'lib/oci/vbs_inst/models/vbs_instance.rb', line 40

def is_resource_usage_agreement_granted
  @is_resource_usage_agreement_granted
end

#lifecycle_state ⇒ String

The current state of the VbsInstance.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/vbs_inst/models/vbs_instance.rb', line 60

def lifecycle_state
  @lifecycle_state
end

#lifecyle_details ⇒ String

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

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/vbs_inst/models/vbs_instance.rb', line 64

def lifecyle_details
  @lifecyle_details
end

#name ⇒ String

[Required] Service instance name (unique identifier)

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/vbs_inst/models/vbs_instance.rb', line 28

def name
  @name
end

#resource_compartment_id ⇒ String

Compartment where VBS may create additional resources for the service instance

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/vbs_inst/models/vbs_instance.rb', line 44

def resource_compartment_id
  @resource_compartment_id
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


82
83
84
 
# File 'lib/oci/vbs_inst/models/vbs_instance.rb', line 82

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The time the the VbsInstance was created. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


52
53
54
 
# File 'lib/oci/vbs_inst/models/vbs_instance.rb', line 52

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time the VbsInstance was updated. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


56
57
58
 
# File 'lib/oci/vbs_inst/models/vbs_instance.rb', line 56

def time_updated
  @time_updated
end

#vbs_access_url ⇒ String

Public web URL for accessing the VBS service instance

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/vbs_inst/models/vbs_instance.rb', line 48

def vbs_access_url
  @vbs_access_url
end

Class Method Details

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/vbs_inst/models/vbs_instance.rb', line 85

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'is_resource_usage_agreement_granted': :'isResourceUsageAgreementGranted',
    'resource_compartment_id': :'resourceCompartmentId',
    'vbs_access_url': :'vbsAccessUrl',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecyle_details': :'lifecyleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'is_resource_usage_agreement_granted': :'BOOLEAN',
    'resource_compartment_id': :'String',
    'vbs_access_url': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecyle_details': :'String',
    '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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/oci/vbs_inst/models/vbs_instance.rb', line 251

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    is_resource_usage_agreement_granted == other.is_resource_usage_agreement_granted &&
    resource_compartment_id == other.resource_compartment_id &&
    vbs_access_url == other.vbs_access_url &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecyle_details == other.lifecyle_details &&
    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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/oci/vbs_inst/models/vbs_instance.rb', line 294

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


274
275
276
 
# File 'lib/oci/vbs_inst/models/vbs_instance.rb', line 274

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



283
284
285
 
# File 'lib/oci/vbs_inst/models/vbs_instance.rb', line 283

def hash
  [id, name, display_name, compartment_id, is_resource_usage_agreement_granted, resource_compartment_id, vbs_access_url, time_created, time_updated, lifecycle_state, lifecyle_details, 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



327
328
329
330
331
332
333
334
335
336
 
# File 'lib/oci/vbs_inst/models/vbs_instance.rb', line 327

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



321
322
323
 
# File 'lib/oci/vbs_inst/models/vbs_instance.rb', line 321

def to_s
  to_hash.to_s
end