Class: OCI::Integration::Models::CustomEndpointDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/integration/models/custom_endpoint_details.rb

Overview

Details for a custom endpoint for the integration instance.

Constant Summary collapse

MANAGED_TYPE_ENUM = 
[
  MANAGED_TYPE_ORACLE_MANAGED = 'ORACLE_MANAGED'.freeze,
  MANAGED_TYPE_CUSTOMER_MANAGED = 'CUSTOMER_MANAGED'.freeze,
  MANAGED_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DNS_TYPE_ENUM = 
[
  DNS_TYPE_OCI = 'OCI'.freeze,
  DNS_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CustomEndpointDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :hostname (String) —

    The value to assign to the #hostname property

  • :managed_type (String) —

    The value to assign to the #managed_type property

  • :dns_zone_name (String) —

    The value to assign to the #dns_zone_name property

  • :dns_type (String) —

    The value to assign to the #dns_type property

  • :certificate_secret_id (String) —

    The value to assign to the #certificate_secret_id property

  • :certificate_secret_version (Integer) —

    The value to assign to the #certificate_secret_version property

  • :_alias (String) —

    The value to assign to the #_alias property



97
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
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 97

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

  self.managed_type = attributes[:'managedType'] if attributes[:'managedType']

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

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

  self.dns_zone_name = attributes[:'dnsZoneName'] if attributes[:'dnsZoneName']

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

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

  self.dns_type = attributes[:'dnsType'] if attributes[:'dnsType']

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

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

  self.certificate_secret_id = attributes[:'certificateSecretId'] if attributes[:'certificateSecretId']

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

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

  self.certificate_secret_version = attributes[:'certificateSecretVersion'] if attributes[:'certificateSecretVersion']

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

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

  self._alias = attributes[:'alias'] if attributes[:'alias']

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

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

Instance Attribute Details

#_alias ⇒ String

When creating the DNS CNAME record for the custom hostname, this value must be specified in the rdata.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 52

def _alias
  @_alias
end

#certificate_secret_id ⇒ String

Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 42

def certificate_secret_id
  @certificate_secret_id
end

#certificate_secret_version ⇒ Integer

The secret version used for the certificate-secret-id (if certificate-secret-id is specified).

Returns:

  • (Integer) 


47
48
49
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 47

def certificate_secret_version
  @certificate_secret_version
end

#dns_type ⇒ String

Type of DNS.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 37

def dns_type
  @dns_type
end

#dns_zone_name ⇒ String

DNS Zone name

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 33

def dns_zone_name
  @dns_zone_name
end

#hostname ⇒ String

[Required] A custom hostname to be used for the integration instance URL, in FQDN format.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 25

def hostname
  @hostname
end

#managed_type ⇒ String

Indicates if custom endpoint is managed by oracle or customer.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 29

def managed_type
  @managed_type
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 55

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'hostname': :'hostname',
    'managed_type': :'managedType',
    'dns_zone_name': :'dnsZoneName',
    'dns_type': :'dnsType',
    'certificate_secret_id': :'certificateSecretId',
    'certificate_secret_version': :'certificateSecretVersion',
    '_alias': :'alias'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'hostname': :'String',
    'managed_type': :'String',
    'dns_zone_name': :'String',
    'dns_type': :'String',
    'certificate_secret_id': :'String',
    'certificate_secret_version': :'Integer',
    '_alias': :'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



175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 175

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

  self.class == other.class &&
    hostname == other.hostname &&
    managed_type == other.managed_type &&
    dns_zone_name == other.dns_zone_name &&
    dns_type == other.dns_type &&
    certificate_secret_id == other.certificate_secret_id &&
    certificate_secret_version == other.certificate_secret_version &&
    _alias == other._alias
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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 211

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


191
192
193
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 191

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



200
201
202
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 200

def hash
  [hostname, managed_type, dns_zone_name, dns_type, certificate_secret_id, certificate_secret_version, _alias].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



244
245
246
247
248
249
250
251
252
253
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 244

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



238
239
240
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 238

def to_s
  to_hash.to_s
end