Class: OCI::DataFlow::Models::CreatePrivateEndpointDetails

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

Overview

The details required to create a private endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreatePrivateEndpointDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :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

  • :subnet_id (String) —

    The value to assign to the #subnet_id property



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
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
 
# File 'lib/oci/data_flow/models/create_private_endpoint_details.rb', line 122

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.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.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']

  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']
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of a compartment.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/data_flow/models/create_private_endpoint_details.rb', line 15

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\"}}

Returns:

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

A user-friendly description. Avoid entering confidential information.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/data_flow/models/create_private_endpoint_details.rb', line 31

def display_name
  @display_name
end

#dns_zones ⇒ Array<String>

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

Returns:

  • (Array<String>) 


37
38
39
 
# File 'lib/oci/data_flow/models/create_private_endpoint_details.rb', line 37

def dns_zones
  @dns_zones
end

#freeform_tags ⇒ Hash<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>) 


44
45
46
 
# File 'lib/oci/data_flow/models/create_private_endpoint_details.rb', line 44

def freeform_tags
  @freeform_tags
end

#max_host_count ⇒ Integer

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) 


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

def max_host_count
  @max_host_count
end

#nsg_ids ⇒ Array<String>

An array of network security group OCIDs.

Returns:

  • (Array<String>) 


57
58
59
 
# File 'lib/oci/data_flow/models/create_private_endpoint_details.rb', line 57

def nsg_ids
  @nsg_ids
end

#scan_details ⇒ Array<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:



63
64
65
 
# File 'lib/oci/data_flow/models/create_private_endpoint_details.rb', line 63

def scan_details
  @scan_details
end

#subnet_id ⇒ String

[Required] The OCID of a subnet.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/data_flow/models/create_private_endpoint_details.rb', line 68

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/data_flow/models/create_private_endpoint_details.rb', line 71

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

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/data_flow/models/create_private_endpoint_details.rb', line 89

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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/oci/data_flow/models/create_private_endpoint_details.rb', line 192

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    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 &&
    subnet_id == other.subnet_id
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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/oci/data_flow/models/create_private_endpoint_details.rb', line 231

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


211
212
213
 
# File 'lib/oci/data_flow/models/create_private_endpoint_details.rb', line 211

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



220
221
222
 
# File 'lib/oci/data_flow/models/create_private_endpoint_details.rb', line 220

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



264
265
266
267
268
269
270
271
272
273
 
# File 'lib/oci/data_flow/models/create_private_endpoint_details.rb', line 264

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



258
259
260
 
# File 'lib/oci/data_flow/models/create_private_endpoint_details.rb', line 258

def to_s
  to_hash.to_s
end