Class: Fastly::Http3Api

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/http3_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Http3Api

Returns a new instance of Http3Api.



17
18
19
 
# File 'lib/fastly/api/http3_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/http3_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#create_http3(opts = {}) ⇒ Http3

Enable support for HTTP/3 Enable HTTP/3 (QUIC) support for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :service_id (String)
  • :version (Integer)
  • :created_at (Time) —

    Date and time in ISO 8601 format.

  • :deleted_at (Time) —

    Date and time in ISO 8601 format.

  • :updated_at (Time) —

    Date and time in ISO 8601 format.

  • :feature_revision (Integer) —

    Revision number of the HTTP/3 feature implementation. Defaults to the most recent revision.

Returns:



31
32
33
34
 
# File 'lib/fastly/api/http3_api.rb', line 31

def create_http3(opts = {})
  data, _status_code, _headers = create_http3_with_http_info(opts)
  data
end

#create_http3_with_http_info(opts = {}) ⇒ Array<(Http3, Integer, Hash)>

Enable support for HTTP/3 Enable HTTP/3 (QUIC) support for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :service_id (String)
  • :version (Integer)
  • :created_at (Time) —

    Date and time in ISO 8601 format.

  • :deleted_at (Time) —

    Date and time in ISO 8601 format.

  • :updated_at (Time) —

    Date and time in ISO 8601 format.

  • :feature_revision (Integer) —

    Revision number of the HTTP/3 feature implementation. Defaults to the most recent revision.

Returns:

  • (Array<(Http3, Integer, Hash)>) —

    Http3 data, response status code and response headers



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/fastly/api/http3_api.rb', line 47

def create_http3_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Http3Api.create_http3 ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling Http3Api.create_http3"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling Http3Api.create_http3"
  end
  if @api_client.config.client_side_validation && !opts[:'feature_revision'].nil? && opts[:'feature_revision'] < 1
    fail ArgumentError, 'invalid value for "opts[:"feature_revision"]" when calling Http3Api.create_http3, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/http3'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['service_id'] = opts[:'service_id'] if !opts[:'service_id'].nil?
  form_params['version'] = opts[:'version'] if !opts[:'version'].nil?
  form_params['created_at'] = opts[:'created_at'] if !opts[:'created_at'].nil?
  form_params['deleted_at'] = opts[:'deleted_at'] if !opts[:'deleted_at'].nil?
  form_params['updated_at'] = opts[:'updated_at'] if !opts[:'updated_at'].nil?
  form_params['feature_revision'] = opts[:'feature_revision'] if !opts[:'feature_revision'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Http3'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"Http3Api.create_http3",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Http3Api#create_http3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_http3(opts = {}) ⇒ InlineResponse200

Disable support for HTTP/3 Disable HTTP/3 (QUIC) support for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

Returns:



122
123
124
125
 
# File 'lib/fastly/api/http3_api.rb', line 122

def delete_http3(opts = {})
  data, _status_code, _headers = delete_http3_with_http_info(opts)
  data
end

#delete_http3_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>

Disable support for HTTP/3 Disable HTTP/3 (QUIC) support for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

Returns:

  • (Array<(InlineResponse200, Integer, Hash)>) —

    InlineResponse200 data, response status code and response headers



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
184
185
 
# File 'lib/fastly/api/http3_api.rb', line 132

def delete_http3_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Http3Api.delete_http3 ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling Http3Api.delete_http3"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling Http3Api.delete_http3"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/http3'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InlineResponse200'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"Http3Api.delete_http3",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Http3Api#delete_http3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_http3(opts = {}) ⇒ Http3

Get HTTP/3 status Get the status of HTTP/3 (QUIC) support for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

Returns:



192
193
194
195
 
# File 'lib/fastly/api/http3_api.rb', line 192

def get_http3(opts = {})
  data, _status_code, _headers = get_http3_with_http_info(opts)
  data
end

#get_http3_with_http_info(opts = {}) ⇒ Array<(Http3, Integer, Hash)>

Get HTTP/3 status Get the status of HTTP/3 (QUIC) support for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

Returns:

  • (Array<(Http3, Integer, Hash)>) —

    Http3 data, response status code and response headers



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/fastly/api/http3_api.rb', line 202

def get_http3_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Http3Api.get_http3 ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling Http3Api.get_http3"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling Http3Api.get_http3"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/http3'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Http3'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"Http3Api.get_http3",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Http3Api#get_http3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end