Class: Harbor2Client::ConfigureApi

Inherits:
Object
  • Object
show all
Defined in:
lib/harbor2_client/api/configure_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConfigureApi

Returns a new instance of ConfigureApi.



19
20
21
 
# File 'lib/harbor2_client/api/configure_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/harbor2_client/api/configure_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_configurations(opts = {}) ⇒ ConfigurationsResponse

Get system configurations. This endpoint is for retrieving system configurations that only provides for admin user.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:



27
28
29
30
 
# File 'lib/harbor2_client/api/configure_api.rb', line 27

def get_configurations(opts = {})
  data, _status_code, _headers = get_configurations_with_http_info(opts)
  data
end

#get_configurations_with_http_info(opts = {}) ⇒ Array<(ConfigurationsResponse, Fixnum, Hash)>

Get system configurations. This endpoint is for retrieving system configurations that only provides for admin user.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:

  • (Array<(ConfigurationsResponse, Fixnum, Hash)>) —

    ConfigurationsResponse data, response status code and response headers



37
38
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
 
# File 'lib/harbor2_client/api/configure_api.rb', line 37

def get_configurations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigureApi.get_configurations ...'
  end
  if @api_client.config.client_side_validation && !opts[:'x_request_id'].nil? && opts[:'x_request_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"x_request_id"]" when calling ConfigureApi.get_configurations, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/configurations'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Request-Id'] = opts[:'x_request_id'] if !opts[:'x_request_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ConfigurationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigureApi#get_configurations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_internalconfig(opts = {}) ⇒ InternalConfigurationsResponse

Get internal configurations. This endpoint is for retrieving system configurations that only provides for internal api call.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:



82
83
84
85
 
# File 'lib/harbor2_client/api/configure_api.rb', line 82

def get_internalconfig(opts = {})
  data, _status_code, _headers = get_internalconfig_with_http_info(opts)
  data
end

#get_internalconfig_with_http_info(opts = {}) ⇒ Array<(InternalConfigurationsResponse, Fixnum, Hash)>

Get internal configurations. This endpoint is for retrieving system configurations that only provides for internal api call.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
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
 
# File 'lib/harbor2_client/api/configure_api.rb', line 92

def get_internalconfig_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigureApi.get_internalconfig ...'
  end
  if @api_client.config.client_side_validation && !opts[:'x_request_id'].nil? && opts[:'x_request_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"x_request_id"]" when calling ConfigureApi.get_internalconfig, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/internalconfig'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Request-Id'] = opts[:'x_request_id'] if !opts[:'x_request_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InternalConfigurationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigureApi#get_internalconfig\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_configurations(configurations, opts = {}) ⇒ nil

Modify system configurations. This endpoint is for modifying system configurations that only provides for admin user.

Parameters:

  • configurations —

    The configuration map can contain a subset of the attributes of the schema, which are to be updated.

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:

  • (nil) 


138
139
140
141
 
# File 'lib/harbor2_client/api/configure_api.rb', line 138

def update_configurations(configurations, opts = {})
  update_configurations_with_http_info(configurations, opts)
  nil
end

#update_configurations_with_http_info(configurations, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Modify system configurations. This endpoint is for modifying system configurations that only provides for admin user.

Parameters:

  • configurations —

    The configuration map can contain a subset of the attributes of the schema, which are to be updated.

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
187
188
189
190
191
 
# File 'lib/harbor2_client/api/configure_api.rb', line 149

def update_configurations_with_http_info(configurations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigureApi.update_configurations ...'
  end
  # verify the required parameter 'configurations' is set
  if @api_client.config.client_side_validation && configurations.nil?
    fail ArgumentError, "Missing the required parameter 'configurations' when calling ConfigureApi.update_configurations"
  end
  if @api_client.config.client_side_validation && !opts[:'x_request_id'].nil? && opts[:'x_request_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"x_request_id"]" when calling ConfigureApi.update_configurations, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/configurations'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Request-Id'] = opts[:'x_request_id'] if !opts[:'x_request_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(configurations)
  auth_names = ['basic']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigureApi#update_configurations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end