Package api.equinix.javasdk.networkedge.client.implementation

Class SSHUsersImpl

java.lang.Object

api.equinix.javasdk.networkedge.client.implementation.SSHUsersImpl

All Implemented Interfaces:

SSHUsers

public class SSHUsersImpl
extends Object
implements SSHUsers

SSHUsersImpl class.

Version:

$Id: $Id

Author:

ianjones

Constructor Summary

Constructors

Constructor	Description
SSHUsersImpl(SSHUserClient<SSHUser> serviceClient, NetworkEdge serviceManager)	Constructor for SSHUsersImpl.

Method Summary

Modifier and Type	Method	Description
Boolean	checkUsernameAvailability(String username)	Returns true if the username is available, otherwise returns 400 bad request.
SSHUserOperator.SSHUserBuilder	define(String username, String password, String deviceUuid)	Returns an instance of SSHUserBuilder for defining a new SSH User.
SSHUser	getByUuid(String uuid)	Gets the specified SSH User.
PaginatedList<SSHUser>	list()	list.
PaginatedList<SSHUser>	list(RequestBuilder.SSHUser requestBuilder)	Lists SSH Users based on the parameters provided.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SSHUsersImpl

public SSHUsersImpl(SSHUserClient<SSHUser> serviceClient,
 NetworkEdge serviceManager)

Constructor for SSHUsersImpl.

Parameters:

serviceClient - a SSHUserClient object.

serviceManager - a NetworkEdge object.

Method Details

list

public PaginatedList<SSHUser> list()

list.

Specified by:

list in interface SSHUsers

Returns:

a PaginatedList object.

list

public PaginatedList<SSHUser> list(RequestBuilder.SSHUser requestBuilder)

Lists SSH Users based on the parameters provided.

list.

Specified by:

list in interface SSHUsers

Parameters:

requestBuilder - the desired query parameters.

Returns:

PaginatedList

getByUuid

public SSHUser getByUuid(String uuid)

Gets the specified SSH User.

Specified by:

getByUuid in interface SSHUsers

Parameters:

uuid - the unique identifier of the SSH User.

Returns:

SSHUser

define

public SSHUserOperator.SSHUserBuilder define(String username,
 String password,
 String deviceUuid)

Returns an instance of SSHUserBuilder for defining a new SSH User.

Specified by:

define in interface SSHUsers

Parameters:

username - the username for the new SSH User.

password - the password for the new SSH User.

deviceUuid - the unique identifier of the device to add the SSH User to.

Returns:

SSHUserOperator.SSHUserBuilder

checkUsernameAvailability

public Boolean checkUsernameAvailability(String username)

Returns true if the username is available, otherwise returns 400 bad request.

Specified by:

checkUsernameAvailability in interface SSHUsers

Parameters:

username - the username to check the availability of.

Returns:

Boolean