Torch Object Storage
Torch Object Storage
Torch Object Storage
Document
What's New
Announcements
Billing
Billable items
Billing method
Getting Started
User Guide
Working with buckets
Basic configurations
Managing lifecycle
Back-to-origin rules
Event notification
Intelligent Tiering
Permissions
Domain management
Fault tolerance and disaster recovery
Cross-region replication
Same-region replication
Data redundancy
Image processing
ObjectSet
Working with objects
Managing folders
Monitoring and alerting
Metric monitoring
Access control
Bucket policies
Common configuration scenarios
Authorizing IAM users of the current account
Authorizing other accounts
Managing access via tools and SDKs
Managing public read access
Data security
Access points
Multi-region access points (MRAP)
Single-region access points (SRAP)
Converged access points (CAP)
DevMind
TOS accelerator
SenseFlow
TOS Agent
Data processing
Basic concepts
Image processing
Media processing
Document preview
Task processing
Data subscription
Flow control management
Quality of Service (QoS) policies
Hierarchical namespace (HNS)
User guide
Tool reference
Best practices
TOS Vectors
User guide
API reference
Vector bucket
Vector index
SDK reference
Python-Vectors
Vector bucket
Vector index
Java-Vectors
Vector bucket
Vector index
Node.js-Vectors
Vector bucket
Vector index
Tool Guide
tosutil
Common commands
Upload, download, and copy objects
Share objects
Auxiliary commands
Common examples
TOS Browser
FSX
FSX best practices
TOS PyTorch Connector
tosfsspec
API Reference
Signature Mechanism
The header contains a signature
Bucket
Basic Bucket Operations
Bucket Lifecycle
Access Monitor
Bucket ACL
Bucket CORS
Bucket Policy
Back-to-origin Rules
Bucket Replication
Versioning
Static Website
Event Notification
Custom Domain
Server-side encryption
Transfer Acceleration
Data Processing
Image processing
Media processing
Video transcoding
Audio transcoding
video to GIF
Document preview
File decompression
Log Storage
Retention Policy
Requester pays
TLS version
Object
Basic Object Operations
Object ACL
Fetch Object
Symbolic Link
WORM object
Multipart Upload
SDK Reference
Java
Pre-signing Mechanism
Bucket Interface
Basic Bucket Interface
Manage Bucket Configuration
Object Interface
Upload Object
Download Object
Upload and Download Speed Limit
Copy Object
List Object
Data Processing
Image Processing
Video Processing
Audio Processing
Log Configuration
Hierarchical Namespace
Bucket base interface
Introduction to Typical Scenes
Python
Data processing
Pre-signature mechanism
Bucket interface
Basic bucket interface
Manage bucket configuration
Object interface
Upload object
Download object
Copy object
List objects
Introduction to typical scenes
C
Object Interface
Upload object
C++
Pre-signature Mechanism
Bucket Interface
Basic Bucket Interface
Manage Bucket Configuration
Object Interface
Upload Object
Download Object
Copy Object
List Objects
Data Processing
Go
Object Interface
Upload Object
Download Object
Copy Object
List Objects
Manage Objects
Bucket Interface
Manage Bucket Configuration
Data Processing
Log Configuration
Introduction to Typical Scenes
Pre-signature Mechanism
Node.js
Pre-signature Mechanism
Bucket Interface
Basic Bucket Interface
Manage Bucket Configuration
Object Interface
Upload object
Download object
Copy object
List objects
Data Processing
Image Processing
Introduction to Typical Scenes
Browser.js
Pre-signature Mechanism
Upload Object
Download Object
Copy Object
List Objects
Manage Objects
Data Processing
.NET
Bucket Interface
Object Interface
Upload Object
Download Object
List Objects
Introduction to Typical Scenes
PHP
Bucket Interface
Object Interface
Download Object
Data Processing
Exception Handling
Android
Bucket Interface
Object Interface
Upload Object
Download Object
Exception Handling
iOS
Bucket Interface
Object Interface
Upload Object
Download Object
Harmony
Pre-signature Mechanism
Bucket Interface
Object Interface
Upload Object
Download Object
List Objects v2
Introduction to Typical Scenarios
Rust
Pre-signing mechanism
Bucket interface
Basic bucket operations
Lifecycle rules
Bucket ACLs
Cross-origin resource sharing
Bucket inventory
Back-to-origin rules
Bucket replication
Static website hosting
Event notification
Custom domain
Server-side encryption
Object interface
Basic operation
Access control
Error Codes
01-SERVICE_ERROR
02-AUTH
03-ACCESS_CONTROL
04-QOS
05-REQUEST
06-BUCKET
07-LIFECYCLE
08-ACL
09-CORS
10-POLICY
11-MIRROR
12-REPLICATION
13-WEBSITE
14-NOTIFICATION
15-ENCRYPT
16-CUSTOMDOMAIN
17-OBJECT
18-TAG
19-MULTIPART
20-STORAGE_CLASS
21-CALLBACK
22-DATA_PROCESS
23-BATCH
24-STORAGE_LENS
25-INVENTORY
26-DIRECTORY_BUCKET
FAQ
Best Practices
AIGC-Doubao LLMs
Accessing TOS with third-party tools
Granting temporary access
Data migration
Data processing
Checking data integrity
Performance optimization
- Documentation
Torch Object StorageSDK ReferenceJavaData ProcessingWorkflowCreate workflow (Java SDK)
Copy page
Download PDFWorkflow
Create workflow (Java SDK)
Copy pageDownload PDFCreate workflow (Java SDK)
This article explains how to create workflows using the TOS Java SDK.
Notes
Only Java SDK version 2.9.8 and above support workflow creation.
Code examples
Create video transcoding workflow
// Create a video transcoding workflow
package org.example.PutConvertWorkflow;
import com.volcengine.tos.TOSV2;
import com.volcengine.tos.TOSV2ClientBuilder;
import com.volcengine.tos.TosClientException;
import com.volcengine.tos.TosServerException;
import com.volcengine.tos.comm.common.*;
import com.volcengine.tos.model.bucket.*;
import com.volcengine.tos.model.object.*;
public class PutConvertWorkflowExample {
public static void main(String[] args) {
String endpoint = System.getenv("TOS_ENDPOINT");
String region = System.getenv("TOS_REGION");
String accessKey = System.getenv("TOS_ACCESS_KEY");
String secretKey = System.getenv("TOS_SECRET_KEY");
// Enter BucketName
String bucketName = System.getenv("TOS_BUCKET");
// Initialize client
TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey);
try {
// Scenario Description: Create a video transcoding workflow that automatically triggers a transcoding task when an mp4 file with the `videos/` prefix is uploaded to a specified bucket.
// 1. Create a video transcoding template and configure parameters such as container, video, audio, and time range.
// Set the time interval: starting from 0ms and lasting for 60 seconds.
TimeInterval timeInterval = TimeInterval.builder()
.start(0)
.duration(60_000)
.build();
// Configure the output container: Use MP4 format and set a short clip duration (10 seconds in the example).
ClipConfig clipConfig = ClipConfig.builder()
// Segment duration, in milliseconds
.duration(10_000)
.build();
Container container = Container.builder()
.format(ContainerFormatType.MP4)
.clipConfig(clipConfig)
.build();
// Configure video encoding parameters; here, we use the common H.264 encoding.
Video video = Video.builder()
.codec("h264")
.width(1920)
.height(1080)// - Resolution: 1920x1080
.crf(23) // - CRF：23
.pixFmt("yuv420p") // - Pixel format: yuv420p
.bitRate(4_000_000) // - Video bitrate: 4 Mbps
.fps(25) // - Frame rate: 25 fps
.remove(false)
.build();
// Configure audio encoding parameters; AAC encoding is used here.
Audio audio = Audio.builder()
.codec("aac")
.bitRate(128_000) // - Bitrate: 128 kbps
.sampleFormat("fltp")
.sampleRate(44_100) // - Sampling rate: 44100 Hz
.channels(2) // - Number of channels: 2 (stereo)
.remove(false)
.build();
// Summary of video transcoding configurations
Transcode transcode = Transcode.builder()
.timeInterval(timeInterval)
.container(container)
.video(video)
.audio(audio)
.build();
// Create a video transcoding template; the template name can be customized according to your business needs.
PutVideoConvertTemplateInput putVideoTemplateInput = PutVideoConvertTemplateInput.builder()
.bucket(bucketName)
.name("example-video-convert-workflow-template")
.transcodeConfig(transcode)
.build();
PutVideoConvertTemplateOutput putVideoTemplateOutput = tos.putVideoConvertTemplate(putVideoTemplateInput);
// 2. Transcoding operations in constructing a transcoding workflow
// Configure the transcoding output location; this example writes it to output/video.mp4 within the same bucket.
ConvertJobOutput videoOutput = ConvertJobOutput.builder()
.region(region)
.bucket(bucketName)
.object("output/video.mp4")
.build();
// OperationID This operation is used to reference the topology; here it's named "transcode".
OperationsTranscode videoTranscodeOperation = OperationsTranscode.builder()
.operationID("transcode")
.templateID(putVideoTemplateOutput.getId())
.output(videoOutput)
.build();
// WorkflowOperations only contains video transcoding operations.
WorkflowOperations workflowOperations = WorkflowOperations.builder()
.transcode(java.util.Arrays.asList(videoTranscodeOperation))
.build();
// 3. Set an extension filter to only apply to video files with the .mp4 extension.
WorkflowExtFilter extFilter = WorkflowExtFilter.builder()
.videoExts(java.util.Arrays.asList("mp4"))
.build();
// 4. Construct transcoding workflow rules
// Rule IDs should ideally be globally unique; here, we simply use the current timestamp concatenated with a prefix.
String ruleId = "video-convert-workflow-" + System.currentTimeMillis();
// Topology configuration: Only one node indicates that a transcode operation is being performed.
java.util.List<java.util.List<String>> topology = java.util.Arrays.asList(
java.util.Arrays.asList("transcode")
);
ConvertWorkflowRule rule = ConvertWorkflowRule.builder()
.id(ruleId)
// Rules enabled
.enabled(true)
// Match only objects with the prefix "videos/".
.prefix("videos/")
.extFilter(extFilter)
.topology(topology)
.operations(workflowOperations)
.build();
// 5. Create a workflow by calling the putConvertWorkflow interface.
PutConvertWorkflowInput putWorkflowInput = PutConvertWorkflowInput.builder()
.bucket(bucketName)
.rules(java.util.Arrays.asList(rule))
.build();
PutConvertWorkflowOutput putWorkflowOutput = tos.putConvertWorkflow(putWorkflowInput);
// Print key return fields and rule summary information
System.out.println("Video transcoding workflow created successfully");
System.out.println("RequestID: " + putWorkflowOutput.getRequestInfo().getRequestId());
System.out.println("StatusCode: " + putWorkflowOutput.getRequestInfo().getStatusCode());
System.out.println("Rule ID: " + ruleId);
System.out.println("Video transcoding output location: " + videoOutput.getBucket() + "/" + videoOutput.getObject());
} catch (TosClientException e) {
// Operation failed, and a client-side exception was caught. This usually indicates an incorrect request parameter, meaning the request was never sent.
System.out.println("Operation failed");
System.out.println("Message: " + e.getMessage());
if (e.getCause() != null) {
e.getCause().printStackTrace();
}
} catch (TosServerException e) {
// If the operation fails, a server-side exception can be captured, allowing you to obtain detailed error information returned from the server.
System.out.println("Operation failed");
System.out.println("StatusCode: " + e.getStatusCode());
System.out.println("Code: " + e.getCode());
System.out.println("Message: " + e.getMessage());
System.out.println("RequestID: " + e.getRequestID());
} catch (Throwable t) {
// As a fallback to catch other exceptions, execution usually doesn't stop here.
System.out.println("Operation failed");
System.out.println("unexpected exception, message: " + t.getMessage());
}
}
}
Create audio transcoding workflow
// Creating an audio transcoding workflow
package org.example.PutConvertWorkflow;
import com.volcengine.tos.TOSV2;
import com.volcengine.tos.TOSV2ClientBuilder;
import com.volcengine.tos.TosClientException;
import com.volcengine.tos.TosServerException;
import com.volcengine.tos.comm.common.*;
import com.volcengine.tos.model.bucket.*;
import com.volcengine.tos.model.object.*;
public class PutConvertWorkflowExample2 {
public static void main(String[] args) {
String endpoint = System.getenv("TOS_ENDPOINT");
String region = System.getenv("TOS_REGION");
String accessKey = System.getenv("TOS_ACCESS_KEY");
String secretKey = System.getenv("TOS_SECRET_KEY");
// Fill in BucketName
String bucketName = System.getenv("TOS_BUCKET");
// Initialize client
TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey);
try {
// Scenario Description: Create an audio transcoding workflow that automatically triggers an audio transcoding task when an mp3 file with the prefix "audis/" under a specified bucket is uploaded.
// 1. Create an audio transcoding template and configure the container format, bitrate, sample rate, number of channels, and time interval.
// Set the time interval: starting from 0ms and continuing for 5 minutes.
TimeInterval timeInterval = TimeInterval.builder()
.start(0)
.duration(300_000)
.build();
// Configure audio transcoding parameters
AudioConvertConfig audioConvertConfig = AudioConvertConfig.builder()
.timeInterval(timeInterval)
// - Container format: MP3
.containerFormat(AudioContainerFormatType.MP3)
// - Bitrate: 128 kbps
.bitRate(128_000)
.bitRateOpt(1)
// - Sampling format: fltp
.sampleFormat("fltp")
// - Sampling rate: 44100 Hz
.sampleRate(44_100)
// - Number of channels: 2 (stereo)
.channels(2)
.build();
// Create an audio transcoding template
PutAudioConvertTemplateInput putAudioTemplateInput = PutAudioConvertTemplateInput.builder()
.bucket(bucketName)
.name("example-audio-convert-workflow-template")
.audioConvertConfig(audioConvertConfig)
.build();
PutAudioConvertTemplateOutput putAudioTemplateOutput = tos.putAudioConvertTemplate(putAudioTemplateInput);
// 2. Audio transcoding operations in constructing a transcoding workflow
// Configure the transcoding output location; this example writes it to output/audio.mp3 within the same bucket.
ConvertJobOutput audioOutput = ConvertJobOutput.builder()
.region(region)
.bucket(bucketName)
.object("output/audio.mp3")
.build();
// OperationID this operation is used to reference the topology; here it's named "audio-transcode".
OperationsAudioTranscode audioTranscodeOperation = OperationsAudioTranscode.builder()
.operationID("audio-transcode")
.templateID(putAudioTemplateOutput.getId())
.output(audioOutput)
.build();
// WorkflowOperations contains only audio transcoding operations.
WorkflowOperations workflowOperations = WorkflowOperations.builder()
.audioTranscode(java.util.Arrays.asList(audioTranscodeOperation))
.build();
// 3. Set the file extension filter to only apply to mp3 audio files.
WorkflowExtFilter extFilter = WorkflowExtFilter.builder()
.audioExts(java.util.Arrays.asList("mp3"))
.build();
// 4. Constructing audio transcoding workflow rules
String ruleId = "audio-convert-workflow-" + System.currentTimeMillis();
// Topology configuration: Only one node indicates that an audio-transcode operation is being performed.
java.util.List<java.util.List<String>> topology = java.util.Arrays.asList(
java.util.Arrays.asList("audio-transcode")
);
ConvertWorkflowRule rule = ConvertWorkflowRule.builder()
.id(ruleId)
// Rules enabled
.enabled(true)
// Match only objects with the audios/ prefix.
.prefix("audios/")
.extFilter(extFilter)
.topology(topology)
.operations(workflowOperations)
.build();
// 5.Call the putConvertWorkflow interface to create an audio transcoding workflow
PutConvertWorkflowInput putWorkflowInput = PutConvertWorkflowInput.builder()
.bucket(bucketName)
.rules(java.util.Arrays.asList(rule))
.build();
PutConvertWorkflowOutput putWorkflowOutput = tos.putConvertWorkflow(putWorkflowInput);
// Print key return fields and rule summary information
System.out.println("Audio transcoding workflow created successfully");
System.out.println("RequestID: " + putWorkflowOutput.getRequestInfo().getRequestId());
System.out.println("StatusCode: " + putWorkflowOutput.getRequestInfo().getStatusCode());
System.out.println("Rule ID: " + ruleId);
System.out.println("Audio transcoding output location: " + audioOutput.getBucket() + "/" + audioOutput.getObject());
} catch (TosClientException e) {
// Operation failed, and a client-side exception was caught. This usually indicates an incorrect request parameter, meaning the request was never sent.
System.out.println("Operation failed");
System.out.println("Message: " + e.getMessage());
if (e.getCause() != null) {
e.getCause().printStackTrace();
}
} catch (TosServerException e) {
// Operation failed，By capturing server-side exceptions, you can obtain detailed error information returned by the server.
System.out.println("Operation failed");
System.out.println("StatusCode: " + e.getStatusCode());
System.out.println("Code: " + e.getCode());
System.out.println("Message: " + e.getMessage());
System.out.println("RequestID: " + e.getRequestID());
} catch (Throwable t) {
// As a fallback to catch other exceptions, execution usually doesn't stop here.
System.out.println("Operation failed");
System.out.println("unexpected exception, message: " + t.getMessage());
}
}
}
Related documentation
Last updated: 2026.04.17 16:59:17
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
