SuiteApiConnectionInfo 1.0.4 API

All Implemented Interfaces:

@Serializable() 
public final class SuiteApiConnectionInfo

Class to hold Suite API connection information

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`hostname`
`private final String`	`username`
`private final String`	`password`
`private final Integer`	`port`
`private final Boolean`	`verify`

Constructor Summary

Constructors
Constructor	Description
`SuiteApiConnectionInfo(String hostname, String username, String password, Integer port, Boolean verify)`
`SuiteApiConnectionInfo(String hostname, String username, String password, Integer port)`
`SuiteApiConnectionInfo(String hostname, String username, String password)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getHostname()`	The hostname or IP address of the SuiteAPI
`final String`	`getUsername()`	The username to connect with
`final String`	`getPassword()`	The username's password
`final Integer`	`getPort()`	Determines the port to connect to the server with.
`final Boolean`	`getVerify()`	Determines if the SSL Certificate from the server should be verified.
`final String`	`getUrl(String endpoint)`	Given an API endpoint, prepend the protocol and hostname.

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

- Constructor Detail
  - SuiteApiConnectionInfo
```
SuiteApiConnectionInfo(String hostname, String username, String password, Integer port, Boolean verify)
```
  - SuiteApiConnectionInfo
```
SuiteApiConnectionInfo(String hostname, String username, String password, Integer port)
```
  - SuiteApiConnectionInfo
```
SuiteApiConnectionInfo(String hostname, String username, String password)
```
- Method Detail
  - getHostname
```
 final String getHostname()
```
    The hostname or IP address of the SuiteAPI
  - getUsername
```
 final String getUsername()
```
    The username to connect with
  - getPassword
```
 final String getPassword()
```
    The username's password
  - getPort
```
 final Integer getPort()
```
    Determines the port to connect to the server with. Used for testing.
  - getVerify
```
 final Boolean getVerify()
```
    Determines if the SSL Certificate from the server should be verified. Used for testing.
  - getUrl
```
 final String getUrl(String endpoint)
```
    Given an API endpoint, prepend the protocol and hostname. If the endpoint does not include 'suite-api/', that is added between the hostname and endpoint (unless the endpoint is an internal API).
    
    Parameters:
    
    endpoint - Endpoint to turn into a full URL
    
    Returns:
    
    Full URL of the given endpoint