net.packet

Interface Packet

All Known Implementing Classes:

PacketClient

public interface Packet

Packet API client interface of REST APIs.

Lightweight API client library for accessing Packet REST APIs with project based (JVM hosted languages) on Java, Groovy, Scala, Clojure, etc.

Since:

v1.0.0

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	acceptInvite(java.lang.String invitationId) To accept user invitation.
java.lang.Boolean	acceptTransfer(java.lang.String transferId) To accept project ownership transfer.
Email	addEmailAddress(Email email) Add email address to current user profile.
Device	createDevice(java.lang.String projectId, Device device) Creating new device on packet project.
Project	createProject(Project project) Create a project on your packet account.
SshKey	createSshKey(SshKey sshKey) To create a new SSH key on packet account.
java.lang.Boolean	declineInvite(java.lang.String invitationId) To decline user invitation.
java.lang.Boolean	declineTransfer(java.lang.String transferId) To decline project ownership transfer.
java.lang.Boolean	deleteDevice(java.lang.String deviceId) To delete a device from Packet project and deprovisions it in packet datacenter.
java.lang.Boolean	deleteEmailAddress(java.lang.String emailId) To delete email address from current user profile.
java.lang.Boolean	deleteIpAddress(java.lang.String ipAddressId) To remove an IP reservation from the project.
java.lang.Boolean	deleteMembership(java.lang.String membershipId) To deletes a membership record and also it will remove the user from the project.
java.lang.Boolean	deleteProject(java.lang.String projectId) Deletes a device and de-provisions it in our datacenter.
java.lang.Boolean	deleteSshKey(java.lang.String sshKeyId) To delete SSH key from packet account.
Metrics	deviceTraffic(java.lang.String deviceId, TrafficDirection direction, java.util.Date timeframeStart, java.util.Date timeframeEnd) To get traffic information for device.
Metrics	deviceTraffic(java.lang.String deviceId, TrafficDirection direction, java.util.Date timeframeStart, java.util.Date timeframeEnd, MetricInterval interval, TrafficBucket bucket) To get traffic information for device.
User	getCurrentUser() To get current user information.
Device	getDevice(java.lang.String deviceId) To get single device information.
Events	getDeviceEvents(java.lang.String deviceId, java.lang.Integer pageNo, java.lang.Integer perPage) To fetch all the events belongs to particular device.
Devices	getDevices(java.lang.String projectId, java.lang.Integer pageNo, java.lang.Integer perPage) To get all available devices from your packet account on particular project.
Email	getEmailAddress(java.lang.String emailId) To fetch one email address information.
Event	getEvent(java.lang.String eventId) To get single event details.
Events	getEvents(java.util.Date since, java.lang.Integer pageNo, java.lang.Integer perPage) Provides all the events from since date.
Facilities	getFacilites(java.lang.Integer pageNo, java.lang.Integer perPage) Provides a listing of available datacenters where you can provision Packet devices.
Invitation	getInvite(java.lang.String invitationId) To get particular invite details.
IpAddress	getIpAddress(java.lang.String ipAddressId) To get particular IP Address details.
IpAddresses	getIpAddresses(java.lang.String projectId) To get all available IP Addresses form packet project.
Membership	getMembership(java.lang.String membershipId) To get project membership details.
Notification	getNotification(java.lang.String notificationId) To get single notification details.
Notifications	getNotifications(java.util.Date since, java.lang.Boolean all, java.lang.Integer pageNo, java.lang.Integer perPage) To fetch all the notification from packet account.
OperatingSystems	getOperatingSystems(java.lang.Integer pageNo, java.lang.Integer perPage) Provides a listing of available operating systems to provision your new device with.
Plans	getPlans(java.lang.Integer pageNo, java.lang.Integer perPage) Provides a listing of available services plans available to provision your device on.
Project	getProject(java.lang.String projectId) Provides single project object.
Events	getProjectEvents(java.lang.String projectId, java.lang.Integer pageNo, java.lang.Integer perPage) To fetch all the events belongs to particular project.
Projects	getProjects(java.lang.Integer pageNo, java.lang.Integer perPage) Projects are a way to group devices and grant users access to them.
SshKey	getSshKey(java.lang.String sshKeyId) To get single SSH key details.
SshKeys	getSshKeys(java.lang.Integer pageNo, java.lang.Integer perPage) To get all the available SSH keys from packet account.
Transfer	getTransferInfo(java.lang.String transferId) Get the project transfer information.
User	getUser(java.lang.String userId) To get single user information.
Users	getUsers(java.lang.Integer pageNo, java.lang.Integer perPage) To get all the available users information.
Invitation	invite(java.lang.String projectId, Invitation invitation) Inviting a user to the project or adding user to the project.
java.lang.Boolean	powerOffDevice(java.lang.String deviceId) To turn-off power on your device.
java.lang.Boolean	powerOnDevice(java.lang.String deviceId) To power on your device.
java.lang.Boolean	rebootDevice(java.lang.String deviceId) To reboot device normally.
java.lang.Boolean	rescueDevice(java.lang.String deviceId) To reboot the device into rescue OS.
java.lang.Boolean	reserveIpAddress(java.lang.String projectId, ReserveIpAddress reserveIpAddress) Reserve/Request more IP address for a project.
Transfer	transferProject(java.lang.String projectId, java.lang.String membershipId) Project owners can transfer ownership of their projects to other members.
User	updateCurrentUser(User user) To update current user information.
Device	updateDevice(Device device) To update device details on packet project.
Email	updateEmailAddress(Email email) To update email address to default address or non-default.
Membership	updateMembership(Membership membership) To update membership details.
Notification	updateNotification(Notification notification) To update single notification.
Project	updateProject(Project project) Updates a project information.
SshKey	updateSshKey(SshKey sshKey) To update existing SSH key on packet account.

Method Detail

getFacilites

Facilities getFacilites(java.lang.Integer pageNo,
                        java.lang.Integer perPage)
                 throws PacketException

Provides a listing of available datacenters where you can provision Packet devices.

Parameters:

pageNo - for pagination

perPage - no. of items per page (optional, can pass null)

Returns:

Facilities

Throws:

PacketException - for HTTP status code >= 400 && < 510

getOperatingSystems

OperatingSystems getOperatingSystems(java.lang.Integer pageNo,
                                     java.lang.Integer perPage)
                              throws PacketException

Provides a listing of available operating systems to provision your new device with.

Parameters:

pageNo - for pagination

perPage - no. of items per page (optional, can pass null)

Returns:

OperatingSystems

Throws:

PacketException - for HTTP status code >= 400 && < 510

getPlans

Plans getPlans(java.lang.Integer pageNo,
               java.lang.Integer perPage)
        throws PacketException

Provides a listing of available services plans available to provision your device on.

Parameters:

pageNo - for pagination

perPage - no. of items per page (optional, can pass null)

Returns:

Plans

Throws:

PacketException - for HTTP status code >= 400 && < 510

getProjects

Projects getProjects(java.lang.Integer pageNo,
                     java.lang.Integer perPage)
              throws PacketException

Projects are a way to group devices and grant users access to them. A collection of projects that the current user is a member of.

Parameters:

pageNo - for pagination

perPage - no. of items per page (optional, can pass null)

Returns:

Projects

Throws:

PacketException - for HTTP status code >= 400 && < 510

getProject

Project getProject(java.lang.String projectId)
            throws PacketException

Provides single project object.

Parameters:

projectId - a packet project id

Returns:

Project

Throws:

PacketException - for HTTP status code >= 400 && < 510

createProject

Project createProject(Project project)
               throws PacketException

Create a project on your packet account.

Parameters:

project - a Project instance

Returns:

Project

Throws:

PacketException - for HTTP status code >= 400 && < 510

updateProject

Project updateProject(Project project)
               throws PacketException

Updates a project information. Like name, payment methods.

Parameters:

project - a Project instance

Returns:

Project

Throws:

PacketException - for HTTP status code >= 400 && < 510

deleteProject

java.lang.Boolean deleteProject(java.lang.String projectId)
                         throws PacketException

Deletes a device and de-provisions it in our datacenter.

Parameters:

projectId - a packet project id

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

transferProject

Transfer transferProject(java.lang.String projectId,
                         java.lang.String membershipId)
                  throws PacketException

Project owners can transfer ownership of their projects to other members.

Parameters:

projectId - a packet project id

membershipId - a packet membership id

Returns:

Transfer

Throws:

PacketException - for HTTP status code >= 400 && < 510

getTransferInfo

Transfer getTransferInfo(java.lang.String transferId)
                  throws PacketException

Get the project transfer information.

Parameters:

transferId - project transfer id

Returns:

Transfer

Throws:

PacketException - for HTTP status code >= 400 && < 510

acceptTransfer

java.lang.Boolean acceptTransfer(java.lang.String transferId)
                          throws PacketException

To accept project ownership transfer.

Parameters:

transferId - project transfer id

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

declineTransfer

java.lang.Boolean declineTransfer(java.lang.String transferId)
                           throws PacketException

To decline project ownership transfer.

Parameters:

transferId - project transfer id

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

getDevices

Devices getDevices(java.lang.String projectId,
                   java.lang.Integer pageNo,
                   java.lang.Integer perPage)
            throws PacketException

To get all available devices from your packet account on particular project.

Parameters:

projectId - a packet project id

pageNo - for pagination

perPage - no. of items per page (optional, can pass null)

Returns:

Devices

Throws:

PacketException - for HTTP status code >= 400 && < 510

getDevice

Device getDevice(java.lang.String deviceId)
          throws PacketException

To get single device information.

Parameters:

deviceId - a packet device id

Returns:

Device

Throws:

PacketException - for HTTP status code >= 400 && < 510

createDevice

Device createDevice(java.lang.String projectId,
                    Device device)
             throws PacketException

Creating new device on packet project.

Parameters:

projectId - a packet project id

device - a Device instance

Returns:

Device

Throws:

PacketException - for HTTP status code >= 400 && < 510

updateDevice

Device updateDevice(Device device)
             throws PacketException

To update device details on packet project.

Parameters:

device - a Device instance

Returns:

Device

Throws:

PacketException - for HTTP status code >= 400 && < 510

deleteDevice

java.lang.Boolean deleteDevice(java.lang.String deviceId)
                        throws PacketException

To delete a device from Packet project and deprovisions it in packet datacenter.

Parameters:

deviceId - a packet device id

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

powerOnDevice

java.lang.Boolean powerOnDevice(java.lang.String deviceId)
                         throws PacketException

To power on your device.

Parameters:

deviceId - a packet device id

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

powerOffDevice

java.lang.Boolean powerOffDevice(java.lang.String deviceId)
                          throws PacketException

To turn-off power on your device.

Parameters:

deviceId - a packet device id

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

rebootDevice

java.lang.Boolean rebootDevice(java.lang.String deviceId)
                        throws PacketException

To reboot device normally.

Parameters:

deviceId - a packet device id

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

rescueDevice

java.lang.Boolean rescueDevice(java.lang.String deviceId)
                        throws PacketException

To reboot the device into rescue OS.

Parameters:

deviceId - a packet device id

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

deviceTraffic

Metrics deviceTraffic(java.lang.String deviceId,
                      TrafficDirection direction,
                      java.util.Date timeframeStart,
                      java.util.Date timeframeEnd)
               throws PacketException

To get traffic information for device.

Parameters:

deviceId - a packet device id

direction - a value of TrafficDirection

timeframeStart - a starting date time

timeframeEnd - a end date time

Returns:

Metrics

Throws:

PacketException - for HTTP status code >= 400 && < 510

deviceTraffic

Metrics deviceTraffic(java.lang.String deviceId,
                      TrafficDirection direction,
                      java.util.Date timeframeStart,
                      java.util.Date timeframeEnd,
                      MetricInterval interval,
                      TrafficBucket bucket)
               throws PacketException

To get traffic information for device.

Parameters:

deviceId - a packet device id

direction - a value of TrafficDirection

timeframeStart - a starting date time

timeframeEnd - a end date time

interval - a value of MetricInterval

bucket - a value of TrafficBucket

Returns:

Metrics

Throws:

PacketException - for HTTP status code >= 400 && < 510

getIpAddresses

IpAddresses getIpAddresses(java.lang.String projectId)
                    throws PacketException

To get all available IP Addresses form packet project.

Parameters:

projectId - a packet project id

Returns:

IpAddresses

Throws:

PacketException - for HTTP status code >= 400 && < 510

reserveIpAddress

java.lang.Boolean reserveIpAddress(java.lang.String projectId,
                                   ReserveIpAddress reserveIpAddress)
                            throws PacketException

Reserve/Request more IP address for a project.

Parameters:

projectId - a packet project id

reserveIpAddress - a instance of ReserveIpAddress

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

getIpAddress

IpAddress getIpAddress(java.lang.String ipAddressId)
                throws PacketException

To get particular IP Address details.

Parameters:

ipAddressId - id of the IP address

Returns:

IpAddress

Throws:

PacketException - for HTTP status code >= 400 && < 510

deleteIpAddress

java.lang.Boolean deleteIpAddress(java.lang.String ipAddressId)
                           throws PacketException

To remove an IP reservation from the project.

Parameters:

ipAddressId - id of the IP address

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

getUsers

Users getUsers(java.lang.Integer pageNo,
               java.lang.Integer perPage)
        throws PacketException

To get all the available users information.

Parameters:

pageNo - for pagination

perPage - no. of items per page (optional, can pass null)

Returns:

Users

Throws:

PacketException - for HTTP status code >= 400 && < 510

getUser

User getUser(java.lang.String userId)
      throws PacketException

To get single user information.

Parameters:

userId - packet user id

Returns:

User

Throws:

PacketException - for HTTP status code >= 400 && < 510

getCurrentUser

User getCurrentUser()
             throws PacketException

To get current user information.

Returns:

User

Throws:

PacketException - for HTTP status code >= 400 && < 510

updateCurrentUser

User updateCurrentUser(User user)
                throws PacketException

To update current user information.

Parameters:

user - a instance of User

Returns:

User

Throws:

PacketException - for HTTP status code >= 400 && < 510

getMembership

Membership getMembership(java.lang.String membershipId)
                  throws PacketException

To get project membership details.

Parameters:

membershipId - project membership id

Returns:

Membership

Throws:

PacketException - for HTTP status code >= 400 && < 510

updateMembership

Membership updateMembership(Membership membership)
                     throws PacketException

To update membership details.

Parameters:

membership - a instance of Membership

Returns:

Membership

Throws:

PacketException - for HTTP status code >= 400 && < 510

deleteMembership

java.lang.Boolean deleteMembership(java.lang.String membershipId)
                            throws PacketException

To deletes a membership record and also it will remove the user from the project.

Parameters:

membershipId - project membership id

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

getSshKeys

SshKeys getSshKeys(java.lang.Integer pageNo,
                   java.lang.Integer perPage)
            throws PacketException

To get all the available SSH keys from packet account.

Parameters:

pageNo - for pagination

perPage - no. of items per page (optional, can pass null)

Returns:

SshKeys

Throws:

PacketException - for HTTP status code >= 400 && < 510

getSshKey

SshKey getSshKey(java.lang.String sshKeyId)
          throws PacketException

To get single SSH key details.

Parameters:

sshKeyId - id of the SSH key

Returns:

SshKey

Throws:

PacketException - for HTTP status code >= 400 && < 510

createSshKey

SshKey createSshKey(SshKey sshKey)
             throws PacketException

To create a new SSH key on packet account.

Parameters:

sshKey - a instance of SshKey

Returns:

SshKey

Throws:

PacketException - for HTTP status code >= 400 && < 510

updateSshKey

SshKey updateSshKey(SshKey sshKey)
             throws PacketException

To update existing SSH key on packet account.

Parameters:

sshKey - a instance of SshKey

Returns:

SshKey

Throws:

PacketException - for HTTP status code >= 400 && < 510

deleteSshKey

java.lang.Boolean deleteSshKey(java.lang.String sshKeyId)
                        throws PacketException

To delete SSH key from packet account.

Parameters:

sshKeyId - a instance of SshKey

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510

invite

Invitation invite(java.lang.String projectId,
                  Invitation invitation)
           throws PacketException

Inviting a user to the project or adding user to the project.

Parameters:

projectId - a packet project id

invitation - a instance of Invitation

Returns:

Invitation

Throws:

PacketException - for HTTP status code >= 400 && < 510

getInvite

Invitation getInvite(java.lang.String invitationId)
              throws PacketException

To get particular invite details.

Parameters:

invitationId - a user invitation id

Returns:

Invitation

Throws:

PacketException - for HTTP status code >= 400 && < 510

acceptInvite

java.lang.Boolean acceptInvite(java.lang.String invitationId)
                        throws PacketException

To accept user invitation.

Parameters:

invitationId - a user invitation id

Returns:

Invitation

Throws:

PacketException - for HTTP status code >= 400 && < 510

declineInvite

java.lang.Boolean declineInvite(java.lang.String invitationId)
                         throws PacketException

To decline user invitation.

Parameters:

invitationId - a user invitation id

Returns:

Invitation

Throws:

PacketException - for HTTP status code >= 400 && < 510

getEvents

Events getEvents(java.util.Date since,
                 java.lang.Integer pageNo,
                 java.lang.Integer perPage)
          throws PacketException

Provides all the events from since date. This method returns event details regardless of projects, devices.

Parameters:

since - date time of events to fetch

pageNo - for pagination

perPage - no. of items per page (optional, can pass null)

Returns:

Events

Throws:

PacketException - for HTTP status code >= 400 && < 510

getProjectEvents

Events getProjectEvents(java.lang.String projectId,
                        java.lang.Integer pageNo,
                        java.lang.Integer perPage)
                 throws PacketException

To fetch all the events belongs to particular project.

Parameters:

projectId - packet project id

pageNo - for pagination

perPage - no. of items per page (optional, can pass null)

Returns:

Events

Throws:

PacketException - for HTTP status code >= 400 && < 510

getDeviceEvents

Events getDeviceEvents(java.lang.String deviceId,
                       java.lang.Integer pageNo,
                       java.lang.Integer perPage)
                throws PacketException

To fetch all the events belongs to particular device.

Parameters:

deviceId - packet device id

pageNo - for pagination

perPage - no. of items per page (optional, can pass null)

Returns:

Events

Throws:

PacketException - for HTTP status code >= 400 && < 510

getEvent

Event getEvent(java.lang.String eventId)
        throws PacketException

To get single event details.

Parameters:

eventId - id of project or device event id

Returns:

Event

Throws:

PacketException - for HTTP status code >= 400 && < 510

getNotifications

Notifications getNotifications(java.util.Date since,
                               java.lang.Boolean all,
                               java.lang.Integer pageNo,
                               java.lang.Integer perPage)
                        throws PacketException

To fetch all the notification from packet account.

Parameters:

since - date time of notifications to fetch

all - to include read notification too

pageNo - for pagination

perPage - no. of items per page (optional, can pass null)

Returns:

Notifications

Throws:

PacketException - for HTTP status code >= 400 && < 510

getNotification

Notification getNotification(java.lang.String notificationId)
                      throws PacketException

To get single notification details.

Parameters:

notificationId - id of the packet notifications

Returns:

Notification

Throws:

PacketException - for HTTP status code >= 400 && < 510

updateNotification

Notification updateNotification(Notification notification)
                         throws PacketException

To update single notification. Currently you can only mark as read.

Parameters:

notification - a instance of the Notification

Returns:

Notification

Throws:

PacketException - for HTTP status code >= 400 && < 510

addEmailAddress

Email addEmailAddress(Email email)
               throws PacketException

Add email address to current user profile.

Parameters:

email - a valid email address

Returns:

Email

Throws:

PacketException - for HTTP status code >= 400 && < 510

getEmailAddress

Email getEmailAddress(java.lang.String emailId)
               throws PacketException

To fetch one email address information.

Parameters:

emailId - id of the email address record

Returns:

Email

Throws:

PacketException - for HTTP status code >= 400 && < 510

updateEmailAddress

Email updateEmailAddress(Email email)
                  throws PacketException

To update email address to default address or non-default.

Parameters:

email - a instance of Email

Returns:

Email

Throws:

PacketException - for HTTP status code >= 400 && < 510

deleteEmailAddress

java.lang.Boolean deleteEmailAddress(java.lang.String emailId)
                              throws PacketException

To delete email address from current user profile.

Parameters:

emailId - id of the email address record

Returns:

Boolean

Throws:

PacketException - for HTTP status code >= 400 && < 510