Class: OCI::ServiceMesh::Models::CreateIngressGatewayDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/service_mesh/models/create_ingress_gateway_details.rb

Overview

The information about a new IngressGateway.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateIngressGatewayDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
# File 'lib/oci/service_mesh/models/create_ingress_gateway_details.rb', line 107

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

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

  self.mesh_id = attributes[:'meshId'] if attributes[:'meshId']

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

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

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

  self.access_logging = attributes[:'accessLogging'] if attributes[:'accessLogging']

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

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

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

  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

#access_loggingOCI::ServiceMesh::Models::AccessLoggingConfiguration



36
37
38
# File 'lib/oci/service_mesh/models/create_ingress_gateway_details.rb', line 36

def access_logging
  @access_logging
end

#compartment_idString

[Required] The OCID of the compartment.

Returns:

  • (String)


44
45
46
# File 'lib/oci/service_mesh/models/create_ingress_gateway_details.rb', line 44

def compartment_id
  @compartment_id
end

#defined_tagsHash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


56
57
58
# File 'lib/oci/service_mesh/models/create_ingress_gateway_details.rb', line 56

def defined_tags
  @defined_tags
end

#descriptionString

Description of the resource. It can be changed after creation. Avoid entering confidential information.

Example: This is my new resource

Returns:

  • (String)


25
26
27
# File 'lib/oci/service_mesh/models/create_ingress_gateway_details.rb', line 25

def description
  @description
end

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


50
51
52
# File 'lib/oci/service_mesh/models/create_ingress_gateway_details.rb', line 50

def freeform_tags
  @freeform_tags
end

#hostsArray<OCI::ServiceMesh::Models::IngressGatewayHost>

[Required] An array of hostnames and their listener configuration that this gateway will bind to.



33
34
35
# File 'lib/oci/service_mesh/models/create_ingress_gateway_details.rb', line 33

def hosts
  @hosts
end

#mesh_idString

[Required] The OCID of the service mesh in which this ingress gateway is created.

Returns:

  • (String)


29
30
31
# File 'lib/oci/service_mesh/models/create_ingress_gateway_details.rb', line 29

def mesh_id
  @mesh_id
end

#mtlsOCI::ServiceMesh::Models::IngressGatewayMutualTransportLayerSecurityDetails



39
40
41
# File 'lib/oci/service_mesh/models/create_ingress_gateway_details.rb', line 39

def mtls
  @mtls
end

#nameString

[Required] A user-friendly name. The name has to be unique within the same service mesh and cannot be changed after creation. Avoid entering confidential information.

Example: My unique resource name

Returns:

  • (String)


17
18
19
# File 'lib/oci/service_mesh/models/create_ingress_gateway_details.rb', line 17

def name
  @name
end

Class Method Details

.attribute_mapObject

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# File 'lib/oci/service_mesh/models/create_ingress_gateway_details.rb', line 59

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'description': :'description',
    'mesh_id': :'meshId',
    'hosts': :'hosts',
    'access_logging': :'accessLogging',
    'mtls': :'mtls',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'description': :'String',
    'mesh_id': :'String',
    'hosts': :'Array<OCI::ServiceMesh::Models::IngressGatewayHost>',
    'access_logging': :'OCI::ServiceMesh::Models::AccessLoggingConfiguration',
    'mtls': :'OCI::ServiceMesh::Models::IngressGatewayMutualTransportLayerSecurityDetails',
    '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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'lib/oci/service_mesh/models/create_ingress_gateway_details.rb', line 159

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

  self.class == other.class &&
    name == other.name &&
    description == other.description &&
    mesh_id == other.mesh_id &&
    hosts == other.hosts &&
    access_logging == other.access_logging &&
    mtls == other.mtls &&
    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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/oci/service_mesh/models/create_ingress_gateway_details.rb', line 197

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


177
178
179
# File 'lib/oci/service_mesh/models/create_ingress_gateway_details.rb', line 177

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



186
187
188
# File 'lib/oci/service_mesh/models/create_ingress_gateway_details.rb', line 186

def hash
  [name, description, mesh_id, hosts, access_logging, mtls, compartment_id, freeform_tags, defined_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



230
231
232
233
234
235
236
237
238
239
# File 'lib/oci/service_mesh/models/create_ingress_gateway_details.rb', line 230

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



224
225
226
# File 'lib/oci/service_mesh/models/create_ingress_gateway_details.rb', line 224

def to_s
  to_hash.to_s
end