Class: OCI::LogAnalytics::Models::EndpointRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/log_analytics/models/endpoint_request.rb

Overview

An object containing details to make a REST request.

Constant Summary collapse

METHOD_ENUM = 
[
  METHOD_GET = 'GET'.freeze,
  METHOD_POST = 'POST'.freeze,
  METHOD_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EndpointRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/oci/log_analytics/models/endpoint_request.rb', line 82

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.method = attributes[:'method'] if attributes[:'method']
  self.method = "GET" if method.nil? && !attributes.key?(:'method') # rubocop:disable Style/StringLiterals

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

  self.content_type = attributes[:'contentType'] if attributes[:'contentType']
  self.content_type = "application/json" if content_type.nil? && !attributes.key?(:'contentType') # rubocop:disable Style/StringLiterals

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

  self.content_type = attributes[:'content_type'] if attributes[:'content_type']
  self.content_type = "application/json" if content_type.nil? && !attributes.key?(:'contentType') && !attributes.key?(:'content_type') # rubocop:disable Style/StringLiterals

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

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

  self.form_parameters = attributes[:'formParameters'] if attributes[:'formParameters']

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

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

Instance Attribute Details

#content_type ⇒ String

The request content type.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/log_analytics/models/endpoint_request.rb', line 28

def content_type
  @content_type
end

#form_parameters ⇒ Array<OCI::LogAnalytics::Models::NameValuePair>

The request form parameters represented as a list of name-value pairs.

Returns:



40
41
42
 
# File 'lib/oci/log_analytics/models/endpoint_request.rb', line 40

def form_parameters
  @form_parameters
end

#headers ⇒ Array<OCI::LogAnalytics::Models::NameValuePair>

The request headers represented as a list of name-value pairs.

Returns:



36
37
38
 
# File 'lib/oci/log_analytics/models/endpoint_request.rb', line 36

def headers
  @headers
end

#method ⇒ String

The endpoint method - GET or POST.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/log_analytics/models/endpoint_request.rb', line 20

def method
  @method
end

#payload ⇒ String

The request payload, applicable for POST requests.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/log_analytics/models/endpoint_request.rb', line 32

def payload
  @payload
end

#url ⇒ String

[Required] The request URL.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/log_analytics/models/endpoint_request.rb', line 24

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/oci/log_analytics/models/endpoint_request.rb', line 43

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'method': :'method',
    'url': :'url',
    'content_type': :'contentType',
    'payload': :'payload',
    'headers': :'headers',
    'form_parameters': :'formParameters'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/log_analytics/models/endpoint_request.rb', line 57

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'method': :'String',
    'url': :'String',
    'content_type': :'String',
    'payload': :'String',
    'headers': :'Array<OCI::LogAnalytics::Models::NameValuePair>',
    'form_parameters': :'Array<OCI::LogAnalytics::Models::NameValuePair>'
    # 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



132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/oci/log_analytics/models/endpoint_request.rb', line 132

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

  self.class == other.class &&
    method == other.method &&
    url == other.url &&
    content_type == other.content_type &&
    payload == other.payload &&
    headers == other.headers &&
    form_parameters == other.form_parameters
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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/oci/log_analytics/models/endpoint_request.rb', line 167

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


147
148
149
 
# File 'lib/oci/log_analytics/models/endpoint_request.rb', line 147

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



156
157
158
 
# File 'lib/oci/log_analytics/models/endpoint_request.rb', line 156

def hash
  [method, url, content_type, payload, headers, form_parameters].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



200
201
202
203
204
205
206
207
208
209
 
# File 'lib/oci/log_analytics/models/endpoint_request.rb', line 200

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



194
195
196
 
# File 'lib/oci/log_analytics/models/endpoint_request.rb', line 194

def to_s
  to_hash.to_s
end