README.md

Equinix Metal API Java Client

END OF LIFE This repository is End of Life meaning that this software is no longer supported nor maintained by Equinix Metal or its community.

Please use https://github.com/equinix-labs/metal-java instead.

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

Getting Started

Equinix Metal API Java Client is available in Maven Central Repo.

Maven dependency

<dependency>
    <groupId>net.packet</groupId>
    <artifactId>java-client</artifactId>
    <version>1.0.0</version>
</dependency>

Gradle/Grails dependency

compile 'net.packet:java-client:1.0.0'

Groovy Grape

@Grapes(
@Grab(group='net.packet', module='java-client', version='1.0.0')
)

Scala SBT

libraryDependencies += "net.packet" % "java-client" % "1.0.0"

Note: For Android projects, kindly include the httpclient-android library explicitly in your project dependencies.

Getting Help

• API Javadoc: Equinix Metal API Java Client
• Example usage: have a look at PacketIntegrationTest

How to create Equinix Metal API Java Client?

Simply you will have to call constructors!

// Passing authToken and version
Packet apiClient = new PacketClient("authToken", "1");

// Passing authToken, version and HTTP Client. Create a http client with custom settings
CloseableHttpClient httpClient = HttpClients.createDefault();
Packet apiClient = new PacketClient("authToken", "1", httpClient);

Then, call appropriate methods as per your need!

Reporting Issues

Equinix Metal API Java Client uses GitHub’s integrated issue tracking system to record bugs and feature requests. If you need to paste code, or include a stack trace use Markdown ``` escapes before and after your text.

Client Library Changelog

Refer CHANGELOG.md

Contributing

1. Fork it
2. Create your feature branch - git checkout -b my-new-feature
3. Implement your changes and apply Google Java Code Formatter
4. Add integration test cases for your implementation
5. Commit your changes - git commit -am 'Added feature'
6. Push to the branch - git push origin my-new-feature
7. Create new Pull Request

License