Class: IonoscloudContainerRegistry::NamesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ionoscloud-container-registry/api/names_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ NamesApi

Returns a new instance of NamesApi.



19
20
21
 
# File 'lib/ionoscloud-container-registry/api/names_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/ionoscloud-container-registry/api/names_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#names_check_usage(name, opts = {}) ⇒ nil

Get container registry name availability Validate that the name is suitable to use for a new registry: - it uses only the characters "a-z", "0-9", or "-" - and starts with a letter and ends with a letter or number - and is between 3 to 63 characters in length - and is available

Parameters:

  • name (String) —

    The desired registry name

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/ionoscloud-container-registry/api/names_api.rb', line 27

def names_check_usage(name, opts = {})
  names_check_usage_with_http_info(name, opts)
  nil
end

#names_check_usage_with_http_info(name, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get container registry name availability Validate that the name is suitable to use for a new registry: - it uses only the characters &quot;a-z&quot;, &quot;0-9&quot;, or &quot;-&quot; - and starts with a letter and ends with a letter or number - and is between 3 to 63 characters in length - and is available

Parameters:

  • name (String) —

    The desired registry name

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

    the optional parameters

Returns:

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

    nil, 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
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/ionoscloud-container-registry/api/names_api.rb', line 37

def names_check_usage_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NamesApi.names_check_usage ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling NamesApi.names_check_usage"
  end
  pattern = Regexp.new(/^[a-z][-a-z0-9]{1,61}[a-z0-9]$/)
  if @api_client.config.client_side_validation && name !~ pattern
    fail ArgumentError, "invalid value for 'name' when calling NamesApi.names_check_usage, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/names/{name}'.sub('{' + 'name' + '}', CGI.escape(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]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth', 'tokenAuth']

  new_options = opts.merge(
    :operation => :"NamesApi.names_check_usage",
    :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(:HEAD, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NamesApi#names_check_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end