Class: OCI::Devops::Models::CreateDeployEnvironmentDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/devops/models/create_deploy_environment_details.rb

Overview

The information about new deployment environment. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDeployEnvironmentDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :description (String) —

    The value to assign to the #description property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :deploy_environment_type (String) —

    The value to assign to the #deploy_environment_type property

  • :project_id (String) —

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

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

    The value to assign to the #security_attributes property



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/devops/models/create_deploy_environment_details.rb', line 104

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

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

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

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

  self.project_id = attributes[:'projectId'] if attributes[:'projectId']

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

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

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

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

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

Instance Attribute Details

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


34
35
36
 
# File 'lib/oci/devops/models/create_deploy_environment_details.rb', line 34

def defined_tags
  @defined_tags
end

#deploy_environment_type ⇒ String

[Required] Deployment environment type.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/devops/models/create_deploy_environment_details.rb', line 22

def deploy_environment_type
  @deploy_environment_type
end

#description ⇒ String

Optional description about the deployment environment.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/devops/models/create_deploy_environment_details.rb', line 14

def description
  @description
end

#display_name ⇒ String

Deployment environment display name. Avoid entering confidential information.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/devops/models/create_deploy_environment_details.rb', line 18

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. See Resource Tags. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


30
31
32
 
# File 'lib/oci/devops/models/create_deploy_environment_details.rb', line 30

def freeform_tags
  @freeform_tags
end

#project_id ⇒ String

[Required] The OCID of a project.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/devops/models/create_deploy_environment_details.rb', line 26

def project_id
  @project_id
end

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

Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"enforce\"}}}

Returns:

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


42
43
44
 
# File 'lib/oci/devops/models/create_deploy_environment_details.rb', line 42

def security_attributes
  @security_attributes
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/devops/models/create_deploy_environment_details.rb', line 45

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'description',
    'display_name': :'displayName',
    'deploy_environment_type': :'deployEnvironmentType',
    'project_id': :'projectId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'security_attributes': :'securityAttributes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/devops/models/create_deploy_environment_details.rb', line 79

def self.get_subtype(object_hash)
  type = object_hash[:'deployEnvironmentType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Devops::Models::CreateComputeInstanceGroupDeployEnvironmentDetails' if type == 'COMPUTE_INSTANCE_GROUP'
  return 'OCI::Devops::Models::CreateOkeClusterDeployEnvironmentDetails' if type == 'OKE_CLUSTER'
  return 'OCI::Devops::Models::CreateFunctionDeployEnvironmentDetails' if type == 'FUNCTION'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Devops::Models::CreateDeployEnvironmentDetails'
end

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/oci/devops/models/create_deploy_environment_details.rb', line 60

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'String',
    'display_name': :'String',
    'deploy_environment_type': :'String',
    'project_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'security_attributes': :'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



156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/oci/devops/models/create_deploy_environment_details.rb', line 156

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

  self.class == other.class &&
    description == other.description &&
    display_name == other.display_name &&
    deploy_environment_type == other.deploy_environment_type &&
    project_id == other.project_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    security_attributes == other.security_attributes
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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/oci/devops/models/create_deploy_environment_details.rb', line 192

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


172
173
174
 
# File 'lib/oci/devops/models/create_deploy_environment_details.rb', line 172

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



181
182
183
 
# File 'lib/oci/devops/models/create_deploy_environment_details.rb', line 181

def hash
  [description, display_name, deploy_environment_type, project_id, freeform_tags, defined_tags, security_attributes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



225
226
227
228
229
230
231
232
233
234
 
# File 'lib/oci/devops/models/create_deploy_environment_details.rb', line 225

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



219
220
221
 
# File 'lib/oci/devops/models/create_deploy_environment_details.rb', line 219

def to_s
  to_hash.to_s
end