Class: OCI::Recovery::Models::CreateRecoveryServiceSubnetDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/recovery/models/create_recovery_service_subnet_details.rb

Overview

Describes the parameters required to create a Recovery Service Subnet.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateRecoveryServiceSubnetDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :subnets (Array<String>) —

    The value to assign to the #subnets property

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids property

  • :vcn_id (String) —

    The value to assign to the #vcn_id property

  • :compartment_id (String) —

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



98
99
100
101
102
103
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/recovery/models/create_recovery_service_subnet_details.rb', line 98

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

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

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

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

  self.nsg_ids = attributes[:'nsgIds'] if attributes[:'nsgIds']

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

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

  self.vcn_id = attributes[:'vcnId'] if attributes[:'vcnId']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The compartment OCID.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/recovery/models/create_recovery_service_subnet_details.rb', line 38

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\"}}. For more information, see {Resource Tags}[https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm]

Returns:

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


50
51
52
 
# File 'lib/oci/recovery/models/create_recovery_service_subnet_details.rb', line 50

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-provided name for the recovery service subnet. The 'displayName' does not have to be unique, and it can be modified. Avoid entering confidential information.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/recovery/models/create_recovery_service_subnet_details.rb', line 13

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


44
45
46
 
# File 'lib/oci/recovery/models/create_recovery_service_subnet_details.rb', line 44

def freeform_tags
  @freeform_tags
end

#nsg_ids ⇒ Array<String>

A list of network security group (NSG) OCIDs that are associated with the Recovery Service subnet. You can specify a maximum of 5 unique OCIDs, which implies that you can associate a maximum of 5 NSGs to each Recovery Service subnet. Specify an empty array if you want to remove all the associated NSGs from a Recovery Service subnet. See NetworkSecurityGroup for more information.

Returns:

  • (Array<String>) 


30
31
32
 
# File 'lib/oci/recovery/models/create_recovery_service_subnet_details.rb', line 30

def nsg_ids
  @nsg_ids
end

#subnet_id ⇒ String

Deprecated. One of the subnets associated with the Recovery Service subnet.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/recovery/models/create_recovery_service_subnet_details.rb', line 18

def subnet_id
  @subnet_id
end

#subnets ⇒ Array<String>

A list of OCIDs of the subnets associated with the Recovery Service subnet.

Returns:

  • (Array<String>) 


22
23
24
 
# File 'lib/oci/recovery/models/create_recovery_service_subnet_details.rb', line 22

def subnets
  @subnets
end

#vcn_id ⇒ String

[Required] The OCID of the virtual cloud network (VCN) that contains the recovery service subnet. You can create a single recovery service subnet per VCN.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/recovery/models/create_recovery_service_subnet_details.rb', line 34

def vcn_id
  @vcn_id
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/recovery/models/create_recovery_service_subnet_details.rb', line 53

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'subnet_id': :'subnetId',
    'subnets': :'subnets',
    'nsg_ids': :'nsgIds',
    'vcn_id': :'vcnId',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/recovery/models/create_recovery_service_subnet_details.rb', line 69

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'subnet_id': :'String',
    'subnets': :'Array<String>',
    'nsg_ids': :'Array<String>',
    'vcn_id': :'String',
    'compartment_id': :'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.

Parameters:

  • other (Object) —

    the other object to be compared



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

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

  self.class == other.class &&
    display_name == other.display_name &&
    subnet_id == other.subnet_id &&
    subnets == other.subnets &&
    nsg_ids == other.nsg_ids &&
    vcn_id == other.vcn_id &&
    compartment_id == other.compartment_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



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

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


173
174
175
 
# File 'lib/oci/recovery/models/create_recovery_service_subnet_details.rb', line 173

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



182
183
184
 
# File 'lib/oci/recovery/models/create_recovery_service_subnet_details.rb', line 182

def hash
  [display_name, subnet_id, subnets, nsg_ids, vcn_id, compartment_id, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



226
227
228
229
230
231
232
233
234
235
 
# File 'lib/oci/recovery/models/create_recovery_service_subnet_details.rb', line 226

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



220
221
222
 
# File 'lib/oci/recovery/models/create_recovery_service_subnet_details.rb', line 220

def to_s
  to_hash.to_s
end