Class: OCI::ResourceManager::Models::Template
- Inherits:
-
Object
- Object
- OCI::ResourceManager::Models::Template
- Defined in:
- lib/oci/resource_manager/models/template.rb
Overview
The properties that define a template. A template is a pre-built Terraform configuration that provisions a set of resources used in a common scenario.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#category_id ⇒ String
Unique identifier for the category where the template is located.
-
#compartment_id ⇒ String
The OCID of the compartment containing this template.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
Brief description of the template.
-
#display_name ⇒ String
Human-readable name of the template.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags associated with the resource.
-
#id ⇒ String
[Required] Unique identifier (OCID) for the template.
-
#is_free_tier ⇒ BOOLEAN
whether the template will work for free tier tenancy.
-
#lifecycle_state ⇒ String
The current lifecycle state of the template.
-
#long_description ⇒ String
Detailed description of the template.
- #template_config_source ⇒ OCI::ResourceManager::Models::TemplateConfigSource
-
#time_created ⇒ DateTime
The date and time at which the template was created.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Template
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ Template
Initializes the object
135 136 137 138 139 140 141 142 143 144 145 146 147 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 |
# File 'lib/oci/resource_manager/models/template.rb', line 135 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.category_id = attributes[:'categoryId'] if attributes[:'categoryId'] raise 'You cannot provide both :categoryId and :category_id' if attributes.key?(:'categoryId') && attributes.key?(:'category_id') self.category_id = attributes[:'category_id'] if attributes[:'category_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.description = attributes[:'description'] if attributes[:'description'] self.long_description = attributes[:'longDescription'] if attributes[:'longDescription'] raise 'You cannot provide both :longDescription and :long_description' if attributes.key?(:'longDescription') && attributes.key?(:'long_description') self.long_description = attributes[:'long_description'] if attributes[:'long_description'] self.is_free_tier = attributes[:'isFreeTier'] unless attributes[:'isFreeTier'].nil? raise 'You cannot provide both :isFreeTier and :is_free_tier' if attributes.key?(:'isFreeTier') && attributes.key?(:'is_free_tier') self.is_free_tier = attributes[:'is_free_tier'] unless attributes[:'is_free_tier'].nil? 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.template_config_source = attributes[:'templateConfigSource'] if attributes[:'templateConfigSource'] raise 'You cannot provide both :templateConfigSource and :template_config_source' if attributes.key?(:'templateConfigSource') && attributes.key?(:'template_config_source') self.template_config_source = attributes[:'template_config_source'] if attributes[:'template_config_source'] 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. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] end |
Instance Attribute Details
#category_id ⇒ String
Unique identifier for the category where the template is located. Possible values are 0
(Quick Starts), 1
(Service), 2
(Architecture), and 3
(Private).
30 31 32 |
# File 'lib/oci/resource_manager/models/template.rb', line 30 def category_id @category_id end |
#compartment_id ⇒ String
The OCID of the compartment containing this template.
24 25 26 |
# File 'lib/oci/resource_manager/models/template.rb', line 24 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\"}}
75 76 77 |
# File 'lib/oci/resource_manager/models/template.rb', line 75 def @defined_tags end |
#description ⇒ String
Brief description of the template.
38 39 40 |
# File 'lib/oci/resource_manager/models/template.rb', line 38 def description @description end |
#display_name ⇒ String
Human-readable name of the template.
34 35 36 |
# File 'lib/oci/resource_manager/models/template.rb', line 34 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}
68 69 70 |
# File 'lib/oci/resource_manager/models/template.rb', line 68 def @freeform_tags end |
#id ⇒ String
[Required] Unique identifier (OCID) for the template.
20 21 22 |
# File 'lib/oci/resource_manager/models/template.rb', line 20 def id @id end |
#is_free_tier ⇒ BOOLEAN
whether the template will work for free tier tenancy.
46 47 48 |
# File 'lib/oci/resource_manager/models/template.rb', line 46 def is_free_tier @is_free_tier end |
#lifecycle_state ⇒ String
The current lifecycle state of the template.
61 62 63 |
# File 'lib/oci/resource_manager/models/template.rb', line 61 def lifecycle_state @lifecycle_state end |
#long_description ⇒ String
Detailed description of the template. This description is displayed in the Console page listing templates when the template is expanded. Avoid entering confidential information.
42 43 44 |
# File 'lib/oci/resource_manager/models/template.rb', line 42 def long_description @long_description end |
#template_config_source ⇒ OCI::ResourceManager::Models::TemplateConfigSource
56 57 58 |
# File 'lib/oci/resource_manager/models/template.rb', line 56 def template_config_source @template_config_source end |
#time_created ⇒ DateTime
The date and time at which the template was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
53 54 55 |
# File 'lib/oci/resource_manager/models/template.rb', line 53 def time_created @time_created end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'lib/oci/resource_manager/models/template.rb', line 78 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'compartment_id': :'compartmentId', 'category_id': :'categoryId', 'display_name': :'displayName', 'description': :'description', 'long_description': :'longDescription', 'is_free_tier': :'isFreeTier', 'time_created': :'timeCreated', 'template_config_source': :'templateConfigSource', 'lifecycle_state': :'lifecycleState', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/oci/resource_manager/models/template.rb', line 98 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'compartment_id': :'String', 'category_id': :'String', 'display_name': :'String', 'description': :'String', 'long_description': :'String', 'is_free_tier': :'BOOLEAN', 'time_created': :'DateTime', 'template_config_source': :'OCI::ResourceManager::Models::TemplateConfigSource', 'lifecycle_state': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'lib/oci/resource_manager/models/template.rb', line 226 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && compartment_id == other.compartment_id && category_id == other.category_id && display_name == other.display_name && description == other.description && long_description == other.long_description && is_free_tier == other.is_free_tier && time_created == other.time_created && template_config_source == other.template_config_source && lifecycle_state == other.lifecycle_state && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 |
# File 'lib/oci/resource_manager/models/template.rb', line 267 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
247 248 249 |
# File 'lib/oci/resource_manager/models/template.rb', line 247 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
256 257 258 |
# File 'lib/oci/resource_manager/models/template.rb', line 256 def hash [id, compartment_id, category_id, display_name, description, long_description, is_free_tier, time_created, template_config_source, lifecycle_state, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
300 301 302 303 304 305 306 307 308 309 |
# File 'lib/oci/resource_manager/models/template.rb', line 300 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
294 295 296 |
# File 'lib/oci/resource_manager/models/template.rb', line 294 def to_s to_hash.to_s end |