ApiClient (microseg Java SDK 4.0.1-alpha-1 API)

java.lang.Object
- com.nutanix.mic.java.client.ApiClient

@Generated(value="com.nutanix.swagger.codegen.generators.JavaClientSDKGenerator",
           date="2023-09-18T22:40:06.153Z[Etc/UTC]")
 @Component(value="com.nutanix.mic.java.client.ApiClient")
public class ApiClient
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ApiClient.CollectionFormat

Nested Classes
Modifier and Type	Class and Description
`static class`	`ApiClient.CollectionFormat`

Constructor Summary

Constructors
Constructor and Description

ApiClient()

ApiClient(org.springframework.web.client.RestTemplate restTemplate)

Constructors
Constructor and Description
`ApiClient()`
`ApiClient(org.springframework.web.client.RestTemplate restTemplate)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ApiClient`	`addDefaultHeader(String name, String value)` Add a default header.
`String`	`formatDate(Date date)` Format the given Date object into string.
`Authentication`	`getAuthentication(String authName)` Get authentication for the given name.
`Map<String,Authentication>`	`getAuthentications()` Get authentications (key: authentication name, value: authentication).
`long`	`getConnectTimeout()` Get the current connection timeout
`DateFormat`	`getDateFormat()` Get the date format used to parse/format date parameters.
`static String`	`getEtag(Object object)` Get ETag from an object if exists.
`String`	`getHost()` Get the current hostname or base URL
`int`	`getMaxRetryAttempts()` Get the number of max retry attempts
`int`	`getPort()` Get the current port for base URL
`long`	`getReadTimeout()` Get the current response read timeout
`org.springframework.util.MultiValueMap<String,String>`	`getResponseHeaders()` Gets the response headers of the previous request
`int`	`getRetryInterval()` Get the delay between each retry attempt
`String`	`getScheme()` Get the current URL scheme for making a connection to the cluster
`org.springframework.http.HttpStatus`	`getStatusCode()` Gets the status code of the previous request
`<T> T`	`invokeAPI(String path, org.springframework.http.HttpMethod method, org.springframework.util.MultiValueMap<String,String> queryParams, Object body, org.springframework.http.HttpHeaders headerParams, org.springframework.util.MultiValueMap<String,Object> formParams, List<org.springframework.http.MediaType> accept, org.springframework.http.MediaType contentType, String[] authNames, org.springframework.core.ParameterizedTypeReference<T> returnType)` Invoke API by sending HTTP request with the given options.
`boolean`	`isDebugging()` Check that whether debugging is enabled for this API client.
`boolean`	`isJsonMime(org.springframework.http.MediaType mediaType)` Check if the given MIME is a JSON MIME.
`boolean`	`isJsonMime(String mediaType)`
`org.springframework.util.MultiValueMap<String,String>`	`parameterToMultiValueMap(ApiClient.CollectionFormat collectionFormat, String name, Object value)` Converts a parameter to a `MultiValueMap` for use in REST requests
`String`	`parameterToString(Object param)` Format the given parameter object into string.
`Date`	`parseDate(String str)` Parse the given string into Date object.
`List<org.springframework.http.MediaType>`	`selectHeaderAccept(String[] accepts)` Select the Accept header's value from the given accepts array: if JSON exists in the given array, use it; otherwise use all of them (joining into a string)
`org.springframework.http.MediaType`	`selectHeaderContentType(String[] contentTypes)` Select the Content-Type header's value from the given array: if JSON exists in the given array, use it; otherwise use the first one of the array.
`ApiClient`	`setConnectTimeout(long connectTimeout)` Set the connection timeout
`ApiClient`	`setDateFormat(DateFormat dateFormat)` Set the date format used to parse/format date parameters.
`void`	`setDebugging(boolean debugging)` Enable or disable debugging
`ApiClient`	`setHost(String host)` Set the hostname for base URL
`ApiClient`	`setMaxRetryAttempts(int maxRetryAttempts)` Set the number of max retry attempts
`void`	`setPassword(String password)` Helper method to set password for the first HTTP basic authentication.
`ApiClient`	`setPort(int port)` Set the port for base URL, which should exclude the semicolon (Default port: 9440)
`ApiClient`	`setReadTimeout(long readTimeout)` Set the response read timeout
`ApiClient`	`setRetryInterval(int retryInterval)` Set the delay between each retry attempt
`ApiClient`	`setScheme(String scheme)` Set a URI scheme for connecting to the cluster (HTTP or HTTPS using SSL/TLS)
`void`	`setUsername(String username)` Helper method to set username for the first HTTP basic authentication.
`ApiClient`	`setVerifySsl(boolean verifySsl)` Enable/Disable SSL Verification

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ApiClient
```
public ApiClient()
```
  - ApiClient
```
@Autowired
public ApiClient(org.springframework.web.client.RestTemplate restTemplate)
```
- Method Detail
  - setVerifySsl
```
public ApiClient setVerifySsl(boolean verifySsl)
                       throws KeyStoreException,
                              NoSuchAlgorithmException
```
    Enable/Disable SSL Verification
    
    Parameters:
    
    verifySsl - flag
    
    Returns:
    
    ApiClient this client
    
    Throws:
    
    KeyStoreException - if key is not found.
    
    NoSuchAlgorithmException - if requested cryptographic algorithm is not found.
  - getScheme
```
public String getScheme()
```
    Get the current URL scheme for making a connection to the cluster
    
    Returns:
    
    String URL scheme
  - setScheme
```
public ApiClient setScheme(String scheme)
```
    Set a URI scheme for connecting to the cluster (HTTP or HTTPS using SSL/TLS)
    
    Parameters:
    
    scheme - URL scheme
    
    Returns:
    
    ApiClient this client
  - getHost
```
public String getHost()
```
    Get the current hostname or base URL
    
    Returns:
    
    String the hostname
  - setHost
```
public ApiClient setHost(String host)
```
    Set the hostname for base URL
    
    Parameters:
    
    host - the hostname
    
    Returns:
    
    ApiClient this client
  - getReadTimeout
```
public long getReadTimeout()
```
    Get the current response read timeout
    
    Returns:
    
    long the response read timeout
  - setReadTimeout
```
public ApiClient setReadTimeout(long readTimeout)
```
    Set the response read timeout
    
    Parameters:
    
    readTimeout - the response read timeout
    
    Returns:
    
    ApiClient this client
  - getConnectTimeout
```
public long getConnectTimeout()
```
    Get the current connection timeout
    
    Returns:
    
    long the connection timeout
  - setConnectTimeout
```
public ApiClient setConnectTimeout(long connectTimeout)
```
    Set the connection timeout
    
    Parameters:
    
    connectTimeout - the connection timeout
    
    Returns:
    
    ApiClient this client
  - getPort
```
public int getPort()
```
    Get the current port for base URL
    
    Returns:
    
    int the port
  - setPort
```
public ApiClient setPort(int port)
```
    Set the port for base URL, which should exclude the semicolon (Default port: 9440)
    
    Parameters:
    
    port - the port
    
    Returns:
    
    ApiClient this client
  - getMaxRetryAttempts
```
public int getMaxRetryAttempts()
```
    Get the number of max retry attempts
    
    Returns:
    
    int number of max retry attempts
  - setMaxRetryAttempts
```
public ApiClient setMaxRetryAttempts(int maxRetryAttempts)
```
    Set the number of max retry attempts
    
    Parameters:
    
    maxRetryAttempts - number of max retry attempts
    
    Returns:
    
    ApiClient this client
  - getRetryInterval
```
public int getRetryInterval()
```
    Get the delay between each retry attempt
    
    Returns:
    
    int back off period in milliseconds
  - setRetryInterval
```
public ApiClient setRetryInterval(int retryInterval)
```
    Set the delay between each retry attempt
    
    Parameters:
    
    retryInterval - delay between each retry attempt in milliseconds
    
    Returns:
    
    ApiClient this client
  - getStatusCode
```
public org.springframework.http.HttpStatus getStatusCode()
```
    Gets the status code of the previous request
    
    Returns:
    
    HttpStatus the status code
  - getResponseHeaders
```
public org.springframework.util.MultiValueMap<String,String> getResponseHeaders()
```
    Gets the response headers of the previous request
    
    Returns:
    
    MultiValueMap a map of response headers
  - getAuthentications
```
public Map<String,Authentication> getAuthentications()
```
    Get authentications (key: authentication name, value: authentication).
    
    Returns:
    
    Map the currently configured authentication types
  - getAuthentication
```
public Authentication getAuthentication(String authName)
```
    Get authentication for the given name.
    
    Parameters:
    
    authName - The authentication name
    
    Returns:
    
    The authentication, null if not found
  - setUsername
```
public void setUsername(String username)
```
    Helper method to set username for the first HTTP basic authentication.
    
    Parameters:
    
    username - the username
  - setPassword
```
public void setPassword(String password)
```
    Helper method to set password for the first HTTP basic authentication.
    
    Parameters:
    
    password - the password
  - addDefaultHeader
```
public ApiClient addDefaultHeader(String name,
                                  String value)
```
    Add a default header.
    
    Parameters:
    
    name - The header's name
    
    value - The header's value
    
    Returns:
    
    ApiClient this client
  - setDebugging
```
public void setDebugging(boolean debugging)
```
    Enable or disable debugging
    
    Parameters:
    
    debugging - debug value true or false
  - isDebugging
```
public boolean isDebugging()
```
    Check that whether debugging is enabled for this API client.
    
    Returns:
    
    boolean true if this client is enabled for debugging, false otherwise
  - getDateFormat
```
public DateFormat getDateFormat()
```
    Get the date format used to parse/format date parameters.
    
    Returns:
    
    DateFormat format
  - setDateFormat
```
public ApiClient setDateFormat(DateFormat dateFormat)
```
    Set the date format used to parse/format date parameters.
    
    Parameters:
    
    dateFormat - Date format
    
    Returns:
    
    ApiClient
  - parseDate
```
public Date parseDate(String str)
```
    Parse the given string into Date object.
    
    Parameters:
    
    str - date to parse
    
    Returns:
    
    Date parsed date
  - formatDate
```
public String formatDate(Date date)
```
    Format the given Date object into string.
    
    Parameters:
    
    date - date to format
    
    Returns:
    
    String formatted date
  - parameterToString
```
public String parameterToString(Object param)
```
    Format the given parameter object into string.
    
    Parameters:
    
    param - the object to convert
    
    Returns:
    
    String the parameter represented as a String
  - parameterToMultiValueMap
```
public org.springframework.util.MultiValueMap<String,String> parameterToMultiValueMap(ApiClient.CollectionFormat collectionFormat,
                                                                                      String name,
                                                                                      Object value)
```
    Converts a parameter to a MultiValueMap for use in REST requests
    
    Parameters:
    
    collectionFormat - The format to convert to
    
    name - The name of the parameter
    
    value - The parameter's value
    
    Returns:
    
    a Map containing the String value(s) of the input parameter
  - isJsonMime
```
public boolean isJsonMime(String mediaType)
```
  - isJsonMime
```
public boolean isJsonMime(org.springframework.http.MediaType mediaType)
```
    Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON
    
    Parameters:
    
    mediaType - the input MediaType
    
    Returns:
    
    boolean true if the MediaType represents JSON, false otherwise
  - selectHeaderAccept
```
public List<org.springframework.http.MediaType> selectHeaderAccept(String[] accepts)
```
    Select the Accept header's value from the given accepts array: if JSON exists in the given array, use it; otherwise use all of them (joining into a string)
    
    Parameters:
    
    accepts - The accepts array to select from
    
    Returns:
    
    List The list of MediaTypes to use for the Accept header
  - selectHeaderContentType
```
public org.springframework.http.MediaType selectHeaderContentType(String[] contentTypes)
```
    Select the Content-Type header's value from the given array: if JSON exists in the given array, use it; otherwise use the first one of the array.
    
    Parameters:
    
    contentTypes - The Content-Type array to select from
    
    Returns:
    
    MediaType The Content-Type header to use. If the given array is empty, JSON will be used.
  - invokeAPI
```
public <T> T invokeAPI(String path,
                       org.springframework.http.HttpMethod method,
                       org.springframework.util.MultiValueMap<String,String> queryParams,
                       Object body,
                       org.springframework.http.HttpHeaders headerParams,
                       org.springframework.util.MultiValueMap<String,Object> formParams,
                       List<org.springframework.http.MediaType> accept,
                       org.springframework.http.MediaType contentType,
                       String[] authNames,
                       org.springframework.core.ParameterizedTypeReference<T> returnType)
                throws org.springframework.web.client.RestClientException
```
    Invoke API by sending HTTP request with the given options.
    
    Type Parameters:
    
    T - the return type to use
    
    Parameters:
    
    path - The sub-path of the HTTP URL
    
    method - The request method
    
    queryParams - The query parameters
    
    body - The request body object
    
    headerParams - The header parameters
    
    formParams - The form parameters
    
    accept - The request's Accept header
    
    contentType - The request's Content-Type header
    
    authNames - The authentications to apply
    
    returnType - The return type into which to deserialize the response
    
    Returns:
    
    The response body in chosen type
    
    Throws:
    
    org.springframework.web.client.RestClientException
  - getEtag
```
public static String getEtag(Object object)
```
    Get ETag from an object if exists. The ETag is usually provided in the response of the GET API calls, which can further be used in other HTTP operations.
    
    Parameters:
    
    object - Object from which ETag needs to be retrieved
    
    Returns:
    
    String ETag header in the object if it's an API response object, otherwise null

Class ApiClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApiClient

ApiClient

Method Detail

setVerifySsl

getScheme

setScheme

getHost

setHost

getReadTimeout

setReadTimeout

getConnectTimeout

setConnectTimeout

getPort

setPort

getMaxRetryAttempts

setMaxRetryAttempts

getRetryInterval

setRetryInterval

getStatusCode

getResponseHeaders

getAuthentications

getAuthentication

setUsername

setPassword

addDefaultHeader

setDebugging

isDebugging

getDateFormat

setDateFormat

parseDate

formatDate

parameterToString

parameterToMultiValueMap

isJsonMime

isJsonMime

selectHeaderAccept

selectHeaderContentType

invokeAPI

getEtag