public class Endpoint extends ResourceBase
client, id, properties
dateFormat
Constructor and Description |
---|
Endpoint(BandwidthClient client,
org.json.simple.JSONObject jsonObject) |
Modifier and Type | Method and Description |
---|---|
static Endpoint |
create(BandwidthClient client,
java.lang.String domainId,
java.util.Map<java.lang.String,java.lang.Object> params)
Convenience factory method to create a Endpoint object from a map of parameters
|
static Endpoint |
create(BandwidthClient client,
java.lang.String domainId,
java.lang.String name,
java.lang.String password)
Convenience factory method for Endpoint, returns a created Endpoint object from a name
|
static Endpoint |
create(BandwidthClient client,
java.lang.String domainId,
java.lang.String name,
java.lang.String password,
boolean isEnabled)
Convenience factory method for Endpoint, returns a created Endpoint object from a name
|
static Endpoint |
create(BandwidthClient client,
java.lang.String domainId,
java.lang.String name,
java.lang.String password,
java.lang.String description)
Convenience factory method for Endpoint, returns a created Endpoint object from a name
|
static Endpoint |
create(BandwidthClient client,
java.lang.String domainId,
java.lang.String name,
java.lang.String password,
java.lang.String description,
boolean enabled)
Convenience factory method for Endpoint, returns a created Endpoint object from a name
|
static Endpoint |
create(BandwidthClient client,
java.lang.String domainId,
java.lang.String name,
java.lang.String password,
java.lang.String description,
boolean enabled,
java.lang.String applicationId)
Convenience factory method for Endpoint, returns a created Endpoint object from a name
|
static Endpoint |
create(java.lang.String domainId,
java.lang.String name,
java.lang.String password)
Convenience factory method for Endpoint, returns a created Endpoint object from a name
|
static Endpoint |
create(java.lang.String domainId,
java.lang.String name,
java.lang.String password,
boolean enabled)
Convenience factory method for Endpoint, returns a created Endpoint object from a name
|
static Endpoint |
create(java.lang.String domainId,
java.lang.String name,
java.lang.String password,
boolean enabled,
java.lang.String description)
Convenience factory method for Endpoint, returns a created Endpoint object from a name
|
static Endpoint |
create(java.lang.String domainId,
java.lang.String name,
java.lang.String password,
java.lang.String description)
Convenience factory method for Endpoint, returns a created Endpoint object from a name
|
static Endpoint |
create(java.lang.String domainId,
java.lang.String name,
java.lang.String password,
java.lang.String description,
boolean enabled)
Convenience factory method for Endpoint, returns a created Endpoint object from a name
|
static void |
delete(BandwidthClient client,
java.lang.String domainId,
java.lang.String endpointId)
Permanently deletes the Endpoint.
|
static void |
delete(java.lang.String domainId,
java.lang.String endpointId)
Permanently deletes the Endpoint.
|
static Endpoint |
get(BandwidthClient client,
java.lang.String domainId,
java.lang.String endpointId)
Convenience method to get information about a specific Endpoint.
|
static Endpoint |
get(java.lang.String domainId,
java.lang.String endpointId)
Convenience method to get information about a specific Endpoint.
|
java.lang.String |
getApplicationId() |
Credentials |
getCredentials() |
java.lang.String |
getDescription() |
java.lang.String |
getDomainId() |
java.lang.String |
getName() |
java.lang.String |
getSipUri() |
boolean |
isEnabled() |
static ResourceList<Endpoint> |
list(BandwidthClient client,
java.lang.String domainId)
Factory method for Endpoint list
|
static ResourceList<Endpoint> |
list(BandwidthClient client,
java.lang.String domainId,
int page,
int size)
Factory method for Endpoint list
|
static ResourceList<Endpoint> |
list(java.lang.String domainId)
Factory method for Endpoint list
|
static ResourceList<Endpoint> |
list(java.lang.String domainId,
int page,
int size)
Factory method for Endpoint list
|
protected void |
setUp(org.json.simple.JSONObject jsonObject) |
static org.json.simple.JSONObject |
toJSONObject(RestResponse response) |
java.lang.String |
toString() |
static Endpoint |
update(java.lang.String domainId,
java.lang.String endpointId,
java.lang.String endpointPassword)
Convenience method to update information about a specific Endpoint
|
static Endpoint |
update(java.lang.String domainId,
java.lang.String endpointId,
java.lang.String endpointPassword,
boolean enabled)
Convenience method to update information about a specific Endpoint
|
static Endpoint |
update(java.lang.String domainId,
java.lang.String endpointId,
java.lang.String endpointPassword,
java.lang.String applicationId,
boolean enabled)
Convenience method to update information about a specific Endpoint
|
static Endpoint |
update(java.lang.String domainId,
java.lang.String endpointId,
java.lang.String password,
java.lang.String applicationId,
java.lang.String description,
boolean enabled)
Convenience method to update information about a specific Endpoint
|
getClient, getId, getProperties, setId, toJSONArray
getProperty, getPropertyAsBoolean, getPropertyAsDate, getPropertyAsDouble, getPropertyAsLong, getPropertyAsString, getPropertyAsStringArray, putProperty, toMap, updateProperties
public Endpoint(BandwidthClient client, org.json.simple.JSONObject jsonObject)
protected void setUp(org.json.simple.JSONObject jsonObject)
setUp
in class ResourceBase
public static org.json.simple.JSONObject toJSONObject(RestResponse response) throws org.json.simple.parser.ParseException
org.json.simple.parser.ParseException
public static Endpoint create(BandwidthClient client, java.lang.String domainId, java.lang.String name, java.lang.String password) throws AppPlatformException, org.json.simple.parser.ParseException, java.lang.Exception
client
- the bandwidth client configuration.domainId
- the domain id.name
- the endpoint name.password
- the endpoint passwordAppPlatformException
- API Exceptionorg.json.simple.parser.ParseException
- Error parsing datajava.lang.Exception
- errorpublic static Endpoint create(BandwidthClient client, java.lang.String domainId, java.lang.String name, java.lang.String password, boolean isEnabled) throws AppPlatformException, org.json.simple.parser.ParseException, java.lang.Exception
client
- the bandwidth client configuration.domainId
- the domain id.name
- the endpoint name.password
- the endpoint passwordisEnabled
- if the endpoint should be enabled.AppPlatformException
- API Exceptionorg.json.simple.parser.ParseException
- Error parsing datajava.lang.Exception
- errorpublic static Endpoint create(BandwidthClient client, java.lang.String domainId, java.lang.String name, java.lang.String password, java.lang.String description) throws AppPlatformException, org.json.simple.parser.ParseException, java.lang.Exception
client
- the bandwidth client configuration.domainId
- the domain id.name
- the endpoint name.password
- the endpoint passworddescription
- the endpoint description.AppPlatformException
- API Exceptionorg.json.simple.parser.ParseException
- Error parsing datajava.lang.Exception
- errorpublic static Endpoint create(BandwidthClient client, java.lang.String domainId, java.lang.String name, java.lang.String password, java.lang.String description, boolean enabled) throws AppPlatformException, org.json.simple.parser.ParseException, java.lang.Exception
client
- the bandwidth client configuration.domainId
- the domain id.name
- the endpoint name.password
- the endpoint passwordenabled
- indicates if the endpoint is active or not.description
- the endpoint description.AppPlatformException
- API Exceptionorg.json.simple.parser.ParseException
- Error parsing datajava.lang.Exception
- errorpublic static Endpoint create(java.lang.String domainId, java.lang.String name, java.lang.String password) throws AppPlatformException, org.json.simple.parser.ParseException, java.lang.Exception
domainId
- the domain id.name
- the endpoint name.password
- the endpoint passwordAppPlatformException
- API Exceptionorg.json.simple.parser.ParseException
- Error parsing datajava.lang.Exception
- errorpublic static Endpoint create(java.lang.String domainId, java.lang.String name, java.lang.String password, boolean enabled) throws AppPlatformException, org.json.simple.parser.ParseException, java.lang.Exception
domainId
- the domain id.name
- the endpoint name.password
- the endpoint passwordenabled
- indicates if the endpoint is active or notAppPlatformException
- API Exceptionorg.json.simple.parser.ParseException
- Error parsing datajava.lang.Exception
- errorpublic static Endpoint create(java.lang.String domainId, java.lang.String name, java.lang.String password, java.lang.String description) throws AppPlatformException, org.json.simple.parser.ParseException, java.lang.Exception
domainId
- the domain id.name
- the endpoint name.password
- the endpoint passworddescription
- the endpoint description.AppPlatformException
- API Exceptionorg.json.simple.parser.ParseException
- Error parsing datajava.lang.Exception
- errorpublic static Endpoint create(java.lang.String domainId, java.lang.String name, java.lang.String password, java.lang.String description, boolean enabled) throws AppPlatformException, org.json.simple.parser.ParseException, java.lang.Exception
domainId
- the domain id.name
- the endpoint name.password
- the endpoint passwordenabled
- indicates if the endpoint is active or notdescription
- the endpoint description.AppPlatformException
- API Exceptionorg.json.simple.parser.ParseException
- Error parsing datajava.lang.Exception
- errorpublic static Endpoint create(java.lang.String domainId, java.lang.String name, java.lang.String password, boolean enabled, java.lang.String description) throws AppPlatformException, org.json.simple.parser.ParseException, java.lang.Exception
domainId
- the domain id.name
- the endpoint name.password
- the endpoint passwordenabled
- indicates if the endpoint is active or not.description
- the endpoint description.AppPlatformException
- API Exceptionorg.json.simple.parser.ParseException
- Error parsing datajava.lang.Exception
- errorpublic static Endpoint create(BandwidthClient client, java.lang.String domainId, java.lang.String name, java.lang.String password, java.lang.String description, boolean enabled, java.lang.String applicationId) throws AppPlatformException, org.json.simple.parser.ParseException, java.lang.Exception
client
- the bandwidth client configuration.domainId
- the domain id.name
- the endpoint name.password
- the endpoint passwordenabled
- indicates if the endpoint is active or notdescription
- the endpoint description.applicationId
- the applicationId.AppPlatformException
- API Exceptionorg.json.simple.parser.ParseException
- Error parsing datajava.lang.Exception
- errorpublic static Endpoint create(BandwidthClient client, java.lang.String domainId, java.util.Map<java.lang.String,java.lang.Object> params) throws AppPlatformException, org.json.simple.parser.ParseException, java.lang.Exception
client
- the bandwidth client configuration.domainId
- the domain id.params
- the request parameters.AppPlatformException
- API Exceptionorg.json.simple.parser.ParseException
- Error parsing datajava.lang.Exception
- errorpublic static Endpoint get(java.lang.String domainId, java.lang.String endpointId) throws org.json.simple.parser.ParseException, java.lang.Exception
domainId
- the domain id.endpointId
- the Endpoint id.org.json.simple.parser.ParseException
- Error parsing datajava.lang.Exception
- errorpublic static Endpoint get(BandwidthClient client, java.lang.String domainId, java.lang.String endpointId) throws org.json.simple.parser.ParseException, java.lang.Exception
client
- the user client.domainId
- the domain id.endpointId
- the Endpoint id.org.json.simple.parser.ParseException
- Error parsing datajava.lang.Exception
- errorpublic static ResourceList<Endpoint> list(BandwidthClient client, java.lang.String domainId)
client
- the user client.domainId
- the domain id.public static ResourceList<Endpoint> list(java.lang.String domainId)
domainId
- the domain id.public static ResourceList<Endpoint> list(java.lang.String domainId, int page, int size)
domainId
- the domain id.page
- the starting page.size
- the page size.public static ResourceList<Endpoint> list(BandwidthClient client, java.lang.String domainId, int page, int size)
client
- the user clientdomainId
- the domain id.page
- the starting page.size
- the page size.public static Endpoint update(java.lang.String domainId, java.lang.String endpointId, java.lang.String endpointPassword) throws AppPlatformException, org.json.simple.parser.ParseException, java.lang.Exception
domainId
- the domain id.endpointId
- the endpoint id.endpointPassword
- the endpoint password.AppPlatformException
- API Exceptionorg.json.simple.parser.ParseException
- Error parsing datajava.lang.Exception
- errorpublic static Endpoint update(java.lang.String domainId, java.lang.String endpointId, java.lang.String endpointPassword, boolean enabled) throws AppPlatformException, org.json.simple.parser.ParseException, java.lang.Exception
domainId
- the domain id.endpointId
- the endpoint id.endpointPassword
- the endpoint password.enabled
- indicates if the endpoint is active or not.AppPlatformException
- API Exceptionorg.json.simple.parser.ParseException
- Error parsing datajava.lang.Exception
- errorpublic static Endpoint update(java.lang.String domainId, java.lang.String endpointId, java.lang.String endpointPassword, java.lang.String applicationId, boolean enabled) throws AppPlatformException, org.json.simple.parser.ParseException, java.lang.Exception
domainId
- the domain id.endpointId
- the endpoint id.endpointPassword
- the endpoint password.applicationId
- the application id.enabled
- indicates if the endpoint is active or not.AppPlatformException
- API Exceptionorg.json.simple.parser.ParseException
- Error parsing datajava.lang.Exception
- errorpublic static Endpoint update(java.lang.String domainId, java.lang.String endpointId, java.lang.String password, java.lang.String applicationId, java.lang.String description, boolean enabled) throws AppPlatformException, org.json.simple.parser.ParseException, java.lang.Exception
domainId
- the domain id.endpointId
- the endpoint id.password
- the endpoint password.applicationId
- the application id.description
- the endpoint description.enabled
- indicates if the endpoint is active or not.AppPlatformException
- API Exceptionorg.json.simple.parser.ParseException
- Error parsing datajava.lang.Exception
- errorpublic static void delete(java.lang.String domainId, java.lang.String endpointId) throws AppPlatformException, java.io.IOException
domainId
- the domain id.endpointId
- the Endpoint id.AppPlatformException
- API Exceptionjava.io.IOException
- unexpected errorpublic static void delete(BandwidthClient client, java.lang.String domainId, java.lang.String endpointId) throws AppPlatformException, java.io.IOException
client
- the bandwidth client configuration.domainId
- the domain id.endpointId
- the Endpoint id.AppPlatformException
- API Exceptionjava.io.IOException
- unexpected errorpublic java.lang.String getName()
public java.lang.String getDomainId()
public boolean isEnabled()
public java.lang.String getSipUri()
public java.lang.String getDescription()
public java.lang.String getApplicationId()
public Credentials getCredentials()
public java.lang.String toString()
toString
in class java.lang.Object
Copyright © 2019. All Rights Reserved.