Class: OCI::DataFlow::Models::UpdatePrivateEndpointDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_flow/models/update_private_endpoint_details.rb

Overview

The details required to update a private endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdatePrivateEndpointDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

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

    The value to assign to the #defined_tags property

  • :description (String)

    The value to assign to the #description property

  • :display_name (String)

    The value to assign to the #display_name property

  • :dns_zones (Array<String>)

    The value to assign to the #dns_zones property

  • :freeform_tags (Hash<String, String>)

    The value to assign to the #freeform_tags property

  • :max_host_count (Integer)

    The value to assign to the #max_host_count property

  • :nsg_ids (Array<String>)

    The value to assign to the #nsg_ids property

  • :scan_details (Array<OCI::DataFlow::Models::Scan>)

    The value to assign to the #scan_details property



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
148
149
150
151
152
153
154
155
# File 'lib/oci/data_flow/models/update_private_endpoint_details.rb', line 106

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

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

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

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

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

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

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

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

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

Instance Attribute Details

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


16
17
18
# File 'lib/oci/data_flow/models/update_private_endpoint_details.rb', line 16

def defined_tags
  @defined_tags
end

#descriptionString

A user-friendly description. Avoid entering confidential information.

Returns:

  • (String)


21
22
23
# File 'lib/oci/data_flow/models/update_private_endpoint_details.rb', line 21

def description
  @description
end

#display_nameString

A user-friendly name. It does not have to be unique. Avoid entering confidential information.

Returns:

  • (String)


26
27
28
# File 'lib/oci/data_flow/models/update_private_endpoint_details.rb', line 26

def display_name
  @display_name
end

#dns_zonesArray<String>

An array of DNS zone names. Example: [ \"app.examplecorp.com\", \"app.examplecorp2.com\" ]

Returns:

  • (Array<String>)


32
33
34
# File 'lib/oci/data_flow/models/update_private_endpoint_details.rb', line 32

def dns_zones
  @dns_zones
end

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


39
40
41
# File 'lib/oci/data_flow/models/update_private_endpoint_details.rb', line 39

def freeform_tags
  @freeform_tags
end

#max_host_countInteger

The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.

Returns:

  • (Integer)


47
48
49
# File 'lib/oci/data_flow/models/update_private_endpoint_details.rb', line 47

def max_host_count
  @max_host_count
end

#nsg_idsArray<String>

An array of network security group OCIDs.

Returns:

  • (Array<String>)


52
53
54
# File 'lib/oci/data_flow/models/update_private_endpoint_details.rb', line 52

def nsg_ids
  @nsg_ids
end

#scan_detailsArray<OCI::DataFlow::Models::Scan>

An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]

Returns:



58
59
60
# File 'lib/oci/data_flow/models/update_private_endpoint_details.rb', line 58

def scan_details
  @scan_details
end

Class Method Details

.attribute_mapObject

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
# File 'lib/oci/data_flow/models/update_private_endpoint_details.rb', line 61

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'defined_tags': :'definedTags',
    'description': :'description',
    'display_name': :'displayName',
    'dns_zones': :'dnsZones',
    'freeform_tags': :'freeformTags',
    'max_host_count': :'maxHostCount',
    'nsg_ids': :'nsgIds',
    'scan_details': :'scanDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
# File 'lib/oci/data_flow/models/update_private_endpoint_details.rb', line 77

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'description': :'String',
    'display_name': :'String',
    'dns_zones': :'Array<String>',
    'freeform_tags': :'Hash<String, String>',
    'max_host_count': :'Integer',
    'nsg_ids': :'Array<String>',
    'scan_details': :'Array<OCI::DataFlow::Models::Scan>'
    # 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



164
165
166
167
168
169
170
171
172
173
174
175
176
# File 'lib/oci/data_flow/models/update_private_endpoint_details.rb', line 164

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

  self.class == other.class &&
    defined_tags == other.defined_tags &&
    description == other.description &&
    display_name == other.display_name &&
    dns_zones == other.dns_zones &&
    freeform_tags == other.freeform_tags &&
    max_host_count == other.max_host_count &&
    nsg_ids == other.nsg_ids &&
    scan_details == other.scan_details
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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'lib/oci/data_flow/models/update_private_endpoint_details.rb', line 201

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


181
182
183
# File 'lib/oci/data_flow/models/update_private_endpoint_details.rb', line 181

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



190
191
192
# File 'lib/oci/data_flow/models/update_private_endpoint_details.rb', line 190

def hash
  [defined_tags, description, display_name, dns_zones, freeform_tags, max_host_count, nsg_ids, scan_details].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



234
235
236
237
238
239
240
241
242
243
# File 'lib/oci/data_flow/models/update_private_endpoint_details.rb', line 234

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



228
229
230
# File 'lib/oci/data_flow/models/update_private_endpoint_details.rb', line 228

def to_s
  to_hash.to_s
end