Class: Fastly::DirectorBackendApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DirectorBackendApi

Returns a new instance of DirectorBackendApi.



17
18
19
 
# File 'lib/fastly/api/director_backend_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/director_backend_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#create_director_backend(opts = {}) ⇒ DirectorBackend

Create a director-backend relationship Establishes a relationship between a Backend and a Director. The Backend is then considered a member of the Director and can be used to balance traffic onto.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :director_name (String) —

    Name for the Director. (required)

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :backend_name (String) —

    The name of the backend. (required)

Returns:



27
28
29
30
 
# File 'lib/fastly/api/director_backend_api.rb', line 27

def create_director_backend(opts = {})
  data, _status_code, _headers = create_director_backend_with_http_info(opts)
  data
end

#create_director_backend_with_http_info(opts = {}) ⇒ Array<(DirectorBackend, Integer, Hash)>

Create a director-backend relationship Establishes a relationship between a Backend and a Director. The Backend is then considered a member of the Director and can be used to balance traffic onto.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :director_name (String) —

    Name for the Director. (required)

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :backend_name (String) —

    The name of the backend. (required)

Returns:

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

    DirectorBackend data, response status code and response headers



39
40
41
42
43
44
45
46
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
 
# File 'lib/fastly/api/director_backend_api.rb', line 39

def create_director_backend_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DirectorBackendApi.create_director_backend ...'
  end
  # unbox the parameters from the hash
  director_name = opts[:'director_name']
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  backend_name = opts[:'backend_name']
  # verify the required parameter 'director_name' is set
  if @api_client.config.client_side_validation && director_name.nil?
    fail ArgumentError, "Missing the required parameter 'director_name' when calling DirectorBackendApi.create_director_backend"
  end
  # 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 DirectorBackendApi.create_director_backend"
  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 DirectorBackendApi.create_director_backend"
  end
  # verify the required parameter 'backend_name' is set
  if @api_client.config.client_side_validation && backend_name.nil?
    fail ArgumentError, "Missing the required parameter 'backend_name' when calling DirectorBackendApi.create_director_backend"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/director/{director_name}/backend/{backend_name}'.sub('{' + 'director_name' + '}', CGI.escape(director_name.to_s)).sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'backend_name' + '}', CGI.escape(backend_name.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] || 'DirectorBackend'

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

  new_options = opts.merge(
    :operation => :"DirectorBackendApi.create_director_backend",
    :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: DirectorBackendApi#create_director_backend\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_director_backend(opts = {}) ⇒ InlineResponse200

Delete a director-backend relationship Deletes the relationship between a Backend and a Director. The Backend is no longer considered a member of the Director and thus will not have traffic balanced onto it from this Director.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :director_name (String) —

    Name for the Director. (required)

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :backend_name (String) —

    The name of the backend. (required)

Returns:



111
112
113
114
 
# File 'lib/fastly/api/director_backend_api.rb', line 111

def delete_director_backend(opts = {})
  data, _status_code, _headers = delete_director_backend_with_http_info(opts)
  data
end

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

Delete a director-backend relationship Deletes the relationship between a Backend and a Director. The Backend is no longer considered a member of the Director and thus will not have traffic balanced onto it from this Director.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :director_name (String) —

    Name for the Director. (required)

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :backend_name (String) —

    The name of the backend. (required)

Returns:

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

    InlineResponse200 data, response status code and response headers



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
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
186
 
# File 'lib/fastly/api/director_backend_api.rb', line 123

def delete_director_backend_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DirectorBackendApi.delete_director_backend ...'
  end
  # unbox the parameters from the hash
  director_name = opts[:'director_name']
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  backend_name = opts[:'backend_name']
  # verify the required parameter 'director_name' is set
  if @api_client.config.client_side_validation && director_name.nil?
    fail ArgumentError, "Missing the required parameter 'director_name' when calling DirectorBackendApi.delete_director_backend"
  end
  # 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 DirectorBackendApi.delete_director_backend"
  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 DirectorBackendApi.delete_director_backend"
  end
  # verify the required parameter 'backend_name' is set
  if @api_client.config.client_side_validation && backend_name.nil?
    fail ArgumentError, "Missing the required parameter 'backend_name' when calling DirectorBackendApi.delete_director_backend"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/director/{director_name}/backend/{backend_name}'.sub('{' + 'director_name' + '}', CGI.escape(director_name.to_s)).sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'backend_name' + '}', CGI.escape(backend_name.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 => :"DirectorBackendApi.delete_director_backend",
    :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: DirectorBackendApi#delete_director_backend\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_director_backend(opts = {}) ⇒ DirectorBackend

Get a director-backend relationship Returns the relationship between a Backend and a Director. If the Backend has been associated with the Director, it returns a simple record indicating this. Otherwise, returns a 404.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :director_name (String) —

    Name for the Director. (required)

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :backend_name (String) —

    The name of the backend. (required)

Returns:



195
196
197
198
 
# File 'lib/fastly/api/director_backend_api.rb', line 195

def get_director_backend(opts = {})
  data, _status_code, _headers = get_director_backend_with_http_info(opts)
  data
end

#get_director_backend_with_http_info(opts = {}) ⇒ Array<(DirectorBackend, Integer, Hash)>

Get a director-backend relationship Returns the relationship between a Backend and a Director. If the Backend has been associated with the Director, it returns a simple record indicating this. Otherwise, returns a 404.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :director_name (String) —

    Name for the Director. (required)

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :backend_name (String) —

    The name of the backend. (required)

Returns:

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

    DirectorBackend data, response status code and response headers



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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/fastly/api/director_backend_api.rb', line 207

def get_director_backend_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DirectorBackendApi.get_director_backend ...'
  end
  # unbox the parameters from the hash
  director_name = opts[:'director_name']
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  backend_name = opts[:'backend_name']
  # verify the required parameter 'director_name' is set
  if @api_client.config.client_side_validation && director_name.nil?
    fail ArgumentError, "Missing the required parameter 'director_name' when calling DirectorBackendApi.get_director_backend"
  end
  # 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 DirectorBackendApi.get_director_backend"
  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 DirectorBackendApi.get_director_backend"
  end
  # verify the required parameter 'backend_name' is set
  if @api_client.config.client_side_validation && backend_name.nil?
    fail ArgumentError, "Missing the required parameter 'backend_name' when calling DirectorBackendApi.get_director_backend"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/director/{director_name}/backend/{backend_name}'.sub('{' + 'director_name' + '}', CGI.escape(director_name.to_s)).sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'backend_name' + '}', CGI.escape(backend_name.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] || 'DirectorBackend'

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

  new_options = opts.merge(
    :operation => :"DirectorBackendApi.get_director_backend",
    :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: DirectorBackendApi#get_director_backend\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end