Skip to content

README.EN.MD

Latest commit

 

History

History
121 lines (81 loc) · 3.52 KB

README.EN.MD

File metadata and controls

121 lines (81 loc) · 3.52 KB

English | 中文

Volcengine SDK for Java

Welcome to Volcengine SDK for Java. This document explains how to obtain and use the SDK.

Prerequisites

Enable the service

Make sure the service you want to access is enabled. Go to the Volcengine Console, select the service from the left navigation (or search it from the top bar), and complete the activation process in the service console.

Obtain security credentials

Access Key is the credential used to access Volcengine services. It consists of Access Key ID (AK) and Secret Access Key (SK).

Log in to the Volcengine Console, then go to IAM -> Access Keys to create and manage your Access Keys. For more information, see the Access Key documentation.

Install

We recommend using Maven dependencies to integrate Volcengine SDK for Java.

maven

<dependency>
    <groupId>com.volcengine</groupId>
    <artifactId>volc-sdk-java</artifactId>
    <version>latest</version>
</dependency>

If your Java version is Java 9 or later, add javax.annotation-api because it was removed from JDK 9+.

<dependency>
  <groupId>javax.annotation</groupId>
  <artifactId>javax.annotation-api</artifactId>
  <version>1.3.2</version>
</dependency>

SNAPSHOT release notes

Version: 2.0.1-SNAPSHOT

Note: SNAPSHOT versions may have potential issues. The source branch is 2.0.0-SNAPSHOT. If you need support, please submit a ticket and select the corresponding product.

Changes

  1. Use OkHttp as the underlying HTTP component (Android compatible)
  2. Fix potential thread leaks when using many credentials
  3. Abstract some network-related models to avoid conflicts
  4. Business packages are mostly unaffected, so migration should be smooth

How to use the SNAPSHOT version:

  1. Add the SNAPSHOT Maven repository (SNAPSHOT policy settings are up to you)
<repository>
   <id>snapshots-repo</id>
   <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
</repository>
  1. Add dependency
<dependency>
    <groupId>com.volcengine</groupId>
    <artifactId>volc-sdk-java</artifactId>
    <version>2.0.1-SNAPSHOT</version>
</dependency>

Configuration

Credential configuration

Volcengine SDK for Java supports the following credential loading methods.

Note: Replace Your AK and Your SK in the code with your actual AK and SK.

Method 1: Specify AK/SK explicitly on the client (recommended)

iamService.setAccessKey("Your AK");
iamService.setSecretKey("Your SK");

Method 2: Load AK/SK from environment variables

VOLC_ACCESSKEY="Your AK"
VOLC_SECRETKEY="Your SK"

Method 3: Load AK/SK from a file under HOME

Add the following content to ~/.volc/config:

{
  "ak": "Your AK",
  "sk": "Your SK"
}

Release resources

After calling APIs, explicitly call destroy() to release daemon threads.

iamService.destroy()

Other resources

Examples are available under example