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.

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

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 64

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


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

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) 


18
19
20
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 18

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) 


23
24
25
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 23

def certificate_secret_version
  @certificate_secret_version
end

#hostname ⇒ String

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

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 13

def hostname
  @hostname
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 31

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

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 43

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



98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 98

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

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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 131

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


111
112
113
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 111

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



120
121
122
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 120

def hash
  [hostname, 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



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 164

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



158
159
160
 
# File 'lib/oci/integration/models/custom_endpoint_details.rb', line 158

def to_s
  to_hash.to_s
end