Skip navigation links
A B C D E F G H I J L M N O P Q R S T U V W 

A

AbstractResponse - Class in com.volcengine.model
xuyaming@bytedance.com 2023/7/3 18:09
AbstractResponse() - Constructor for class com.volcengine.model.AbstractResponse
 
addDefaultHeader(String, String) - Method in class com.volcengine.ApiClient
Add a default header.
addPairAndGetServiceInfo(String, List<Pair>, Map<String, String>) - Method in class com.volcengine.ApiClient
 
ApiCallback<T> - Interface in com.volcengine
Callback for asynchronous API call.
ApiClient - Class in com.volcengine
 
ApiClient() - Constructor for class com.volcengine.ApiClient
 
ApiException - Exception in com.volcengine
 
ApiException() - Constructor for exception com.volcengine.ApiException
 
ApiException(Throwable) - Constructor for exception com.volcengine.ApiException
 
ApiException(String) - Constructor for exception com.volcengine.ApiException
 
ApiException(String, Throwable, int, Map<String, List<String>>, String) - Constructor for exception com.volcengine.ApiException
 
ApiException(String, Throwable, int, Map<String, List<String>>, String, ResponseMetadata) - Constructor for exception com.volcengine.ApiException
 
ApiException(String, int, Map<String, List<String>>, String) - Constructor for exception com.volcengine.ApiException
 
ApiException(String, int, Map<String, List<String>>, String, ResponseMetadata) - Constructor for exception com.volcengine.ApiException
 
ApiException(String, Throwable, int, Map<String, List<String>>) - Constructor for exception com.volcengine.ApiException
 
ApiException(int, Map<String, List<String>>, String) - Constructor for exception com.volcengine.ApiException
 
ApiException(int, Map<String, List<String>>, String, ResponseMetadata) - Constructor for exception com.volcengine.ApiException
 
ApiException(int, String) - Constructor for exception com.volcengine.ApiException
 
ApiException(int, String, Map<String, List<String>>, String) - Constructor for exception com.volcengine.ApiException
 
ApiResponse<T> - Class in com.volcengine
API response returned by API call.
ApiResponse(int, Map<String, List<String>>) - Constructor for class com.volcengine.ApiResponse
 
ApiResponse(int, Map<String, List<String>>, T) - Constructor for class com.volcengine.ApiResponse
 
appendRequestInterceptor(RequestInterceptor) - Method in class com.volcengine.interceptor.InterceptorChain
 
appendResponseInterceptor(ResponseInterceptor) - Method in class com.volcengine.interceptor.InterceptorChain
 
applyToParams(List<Pair>, Map<String, String>, String) - Method in interface com.volcengine.auth.Authentication
Apply authentication settings to header and query params.
applyToParams(List<Pair>, Map<String, String>, String) - Method in class com.volcengine.sign.VolcstackSign
 
Authentication - Interface in com.volcengine.auth
 
authNames(String[]) - Method in class com.volcengine.interceptor.InitInterceptorContext.Builder
 

B

body(Object) - Method in class com.volcengine.interceptor.InitInterceptorContext.Builder
 
build() - Method in class com.volcengine.interceptor.InitInterceptorContext.Builder
 
buildCall(String, String, List<Pair>, List<Pair>, Object, Map<String, String>, Map<String, Object>, String[], ProgressRequestBody.ProgressRequestListener, boolean...) - Method in class com.volcengine.ApiClient
Build HTTP call with the given options.
Builder() - Constructor for class com.volcengine.interceptor.InitInterceptorContext.Builder
 
buildQueryParams(String, StringBuilder, List<Pair>) - Method in class com.volcengine.ApiClient
 
buildRequest(String, String, List<Pair>, List<Pair>, Object, Map<String, String>, Map<String, Object>, String[], ProgressRequestBody.ProgressRequestListener, boolean...) - Method in class com.volcengine.ApiClient
Build an HTTP request with the given options.
buildRequest() - Method in class com.volcengine.interceptor.InterceptorContext
 
buildRequestBodyFormEncoding(Map<String, Object>) - Method in class com.volcengine.ApiClient
Build a form-encoding request body with the given form parameters.
buildRequestBodyMultipart(Map<String, Object>) - Method in class com.volcengine.ApiClient
Build a multipart (file uploading) request body with the given form parameters, which could contain text fields and file fields.
BuildRequestInterceptor - Class in com.volcengine.interceptor
 
BuildRequestInterceptor() - Constructor for class com.volcengine.interceptor.BuildRequestInterceptor
 
buildSimpleRequest(Object, List<Pair>, Map<String, String>, StringBuilder, FormEncodingBuilder, String, boolean...) - Method in class com.volcengine.ApiClient
 
buildUrl(String, List<Pair>, List<Pair>) - Method in class com.volcengine.ApiClient
Build full URL by concatenating base path, the given sub path and query parameters.

C

collectionQueryParams(List<Pair>) - Method in class com.volcengine.interceptor.InitInterceptorContext.Builder
 
com.volcengine - package com.volcengine
 
com.volcengine.auth - package com.volcengine.auth
 
com.volcengine.endpoint - package com.volcengine.endpoint
 
com.volcengine.interceptor - package com.volcengine.interceptor
 
com.volcengine.model - package com.volcengine.model
 
com.volcengine.sign - package com.volcengine.sign
 
com.volcengine.version - package com.volcengine.version
 
Configuration - Class in com.volcengine
 
Configuration() - Constructor for class com.volcengine.Configuration
 
containsIgnoreCase(String[], String) - Static method in class com.volcengine.StringUtil
Check if the given array contains the given value (with case-insensitive comparison).
contentLength() - Method in class com.volcengine.ProgressRequestBody
 
contentLength() - Method in class com.volcengine.ProgressResponseBody
 
ContentType - Enum in com.volcengine
xuyaming@bytedance.com 2022/12/23 15:38
contentType() - Method in class com.volcengine.ProgressRequestBody
 
contentType() - Method in class com.volcengine.ProgressResponseBody
 
copy(List<Pair>) - Method in class com.volcengine.interceptor.InterceptorContext
 
copy(Map<String, T>) - Method in class com.volcengine.interceptor.InterceptorContext
 
copy() - Method in class com.volcengine.sign.VolcstackSign
 
createGson() - Static method in class com.volcengine.JSON
 
CredentialProvider - Class in com.volcengine.auth
 
CredentialProvider(Provider) - Constructor for class com.volcengine.auth.CredentialProvider
 
Credentials - Class in com.volcengine.sign
xuyaming@bytedance.com 2022/3/18 13:12
CredentialValue - Class in com.volcengine.auth
 
CredentialValue(String, String, String, String) - Constructor for class com.volcengine.auth.CredentialValue
 

D

DateTypeAdapter() - Constructor for class com.volcengine.JSON.DateTypeAdapter
 
DateTypeAdapter(DateFormat) - Constructor for class com.volcengine.JSON.DateTypeAdapter
 
DefaultEndpointProvider - Class in com.volcengine.endpoint
 
DefaultEndpointProvider() - Constructor for class com.volcengine.endpoint.DefaultEndpointProvider
 
deserialize(Response, Type, boolean...) - Method in class com.volcengine.ApiClient
Deserialize response body to Java object, according to the return type and the Content-Type response header.
deserialize(String, Type) - Method in class com.volcengine.JSON
Deserialize the given JSON string to Java object.
DeserializedResponseInterceptor - Class in com.volcengine.interceptor
 
DeserializedResponseInterceptor() - Constructor for class com.volcengine.interceptor.DeserializedResponseInterceptor
 
doCall(UniversalRequest, Map<String, Object>) - Method in class com.volcengine.UniversalApi
 
doCallWithHttpInfo(UniversalRequest, Map<String, Object>) - Method in class com.volcengine.UniversalApi
 
downloadFileFromResponse(Response) - Method in class com.volcengine.ApiClient
Download file from the given response.

E

endpointFor(ResolveEndpointOption) - Method in class com.volcengine.endpoint.DefaultEndpointProvider
 
endpointFor(ResolveEndpointOption) - Method in interface com.volcengine.endpoint.EndpointResolver
 
EndpointResolver - Interface in com.volcengine.endpoint
 
Error - Class in com.volcengine.model
xuyaming@bytedance.com 2022/3/18 15:22
Error() - Constructor for class com.volcengine.model.Error
 
escapeString(String) - Method in class com.volcengine.ApiClient
Escape the given string to be used as URL query value.
execute(Call) - Method in class com.volcengine.ApiClient
execute(Call, Type, boolean...) - Method in class com.volcengine.ApiClient
Execute HTTP call and deserialize the HTTP response body into the given return type.
executeAsync(Call, ApiCallback<T>) - Method in class com.volcengine.ApiClient
executeAsync(Call, Type, ApiCallback<T>) - Method in class com.volcengine.ApiClient
Execute HTTP call asynchronously.
executeRequest(InterceptorContext) - Method in class com.volcengine.interceptor.InterceptorChain
 
executeResponse(InterceptorContext) - Method in class com.volcengine.interceptor.InterceptorChain
 

F

formParams(Map<String, Object>) - Method in class com.volcengine.interceptor.InitInterceptorContext.Builder
 

G

get() - Method in class com.volcengine.auth.CredentialProvider
 
getAccessKey() - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
getAccessKey() - Method in class com.volcengine.sign.Credentials
 
getAccountId() - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
getAction() - Method in class com.volcengine.model.ResponseMetadata
 
getAction() - Method in class com.volcengine.UniversalRequest
 
getAk() - Method in class com.volcengine.auth.CredentialValue
 
getApiClient() - Method in class com.volcengine.interceptor.InterceptorContext
 
getApiClient() - Method in class com.volcengine.UniversalApi
 
getAuthentication(String) - Method in class com.volcengine.ApiClient
Get authentication for the given name.
getAuthentications() - Method in class com.volcengine.ApiClient
Get authentications (key: authentication name, value: authentication).
getAuthNames() - Method in class com.volcengine.interceptor.InitInterceptorContext
 
getAuthNames() - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
getBody() - Method in class com.volcengine.interceptor.InitInterceptorContext
 
getCall() - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
getCode() - Method in exception com.volcengine.ApiException
Get the HTTP status code.
getCode() - Method in class com.volcengine.model.Error
 
getCodeN() - Method in class com.volcengine.model.Error
 
getCollectionQueryParams() - Method in class com.volcengine.interceptor.InitInterceptorContext
 
getConnectTimeout() - Method in class com.volcengine.ApiClient
Get connection timeout (in milliseconds).
getContentType() - Method in class com.volcengine.UniversalRequest
 
getCredentialProvider() - Method in class com.volcengine.ApiClient
 
getCredentials() - Method in class com.volcengine.ApiClient
Get credentials
getCredentials(String, String) - Static method in class com.volcengine.sign.Credentials
 
getCredentials(String, String, String) - Static method in class com.volcengine.sign.Credentials
 
getCredentials() - Method in class com.volcengine.sign.VolcstackSign
 
getCredentialValue() - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
getCustomBootstrapRegion() - Method in class com.volcengine.ApiClient
Get the custom bootstrapping regions.
getCustomBootstrapRegion() - Method in class com.volcengine.endpoint.ResolveEndpointOption
 
getData() - Method in class com.volcengine.ApiResponse
 
getData() - Method in class com.volcengine.interceptor.ResponseInterceptorContext
 
getDateFormat() - Method in class com.volcengine.ApiClient
 
getDefaultApiClient() - Static method in class com.volcengine.Configuration
Get the default API client, which would be used when creating API instances without providing an API client.
getDefaultContentType(Map<String, String>) - Method in class com.volcengine.ApiClient
 
getDisableSSL() - Method in class com.volcengine.ApiClient
Get disableSSL
getDurationSeconds() - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
getEndpoint() - Method in class com.volcengine.ApiClient
Get base path
getEndpoint() - Method in class com.volcengine.endpoint.ResolvedEndpoint
 
getEndpointResolver() - Method in class com.volcengine.ApiClient
 
getEnvCredentials() - Static method in class com.volcengine.sign.Credentials
 
getError() - Method in class com.volcengine.model.ResponseMetadata
 
getExpirationTime() - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
getExpireBufferSeconds() - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
getFormParams() - Method in class com.volcengine.interceptor.InitInterceptorContext
 
getGson() - Method in class com.volcengine.JSON
Get Gson.
getHeaderParams() - Method in class com.volcengine.interceptor.InitInterceptorContext
 
getHeaderParams() - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
getHeaders() - Method in class com.volcengine.ApiResponse
 
getHeaders() - Method in class com.volcengine.interceptor.ResponseInterceptorContext
 
getHost() - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
getHost() - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
getHttpClient() - Method in class com.volcengine.ApiClient
Get HTTP client
getHttpCode() - Method in class com.volcengine.interceptor.ResponseInterceptorContext
 
getHttpMethod() - Method in class com.volcengine.UniversalRequest
 
getInitInterceptorContext() - Method in class com.volcengine.interceptor.InterceptorContext
 
getJSON() - Method in class com.volcengine.ApiClient
Get JSON
getKeepAliveDurationMs() - Method in class com.volcengine.ApiClient
 
getKeyManagers() - Method in class com.volcengine.ApiClient
 
getMaxIdleConns() - Method in class com.volcengine.ApiClient
 
getMessage() - Method in class com.volcengine.model.Error
 
GetMethod() - Method in enum com.volcengine.HttpMethod
 
getMethod() - Method in class com.volcengine.interceptor.InitInterceptorContext
 
getMethod() - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
getMethod() - Method in class com.volcengine.sign.ServiceInfo
 
getMethod() - Method in class com.volcengine.sign.VolcstackSign
 
getName() - Method in class com.volcengine.Pair
 
getOriginalResponse() - Method in class com.volcengine.interceptor.ResponseInterceptorContext
 
getPath() - Method in class com.volcengine.interceptor.InitInterceptorContext
 
getPath() - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
getProgressRequestListener() - Method in class com.volcengine.interceptor.InitInterceptorContext
 
getProgressRequestListener() - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
getProviderName() - Method in class com.volcengine.auth.CredentialValue
 
getQueryParams() - Method in class com.volcengine.interceptor.InitInterceptorContext
 
getQueryParams() - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
getReadTimeout() - Method in class com.volcengine.ApiClient
Get read timeout (in milliseconds).
getRegion() - Method in class com.volcengine.ApiClient
Get region
getRegion() - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
getRegion() - Method in class com.volcengine.endpoint.ResolveEndpointOption
 
getRegion() - Method in class com.volcengine.model.ResponseMetadata
 
getRegion() - Method in class com.volcengine.sign.VolcstackSign
 
getRequestBody() - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
getRequestContext() - Method in class com.volcengine.interceptor.InterceptorContext
 
getRequestId() - Method in class com.volcengine.model.ResponseMetadata
 
getResponseBody() - Method in exception com.volcengine.ApiException
Get the HTTP response body.
getResponseContext() - Method in class com.volcengine.interceptor.InterceptorContext
 
getResponseHeaders() - Method in exception com.volcengine.ApiException
Get the HTTP response headers.
getResponseMetadata() - Method in exception com.volcengine.ApiException
 
getResponseMetadata() - Method in class com.volcengine.model.AbstractResponse
 
getResponseMetadata() - Method in class com.volcengine.model.VolcstackResponse
 
getResult() - Method in class com.volcengine.model.VolcstackResponse
 
getReturnType() - Method in class com.volcengine.interceptor.ResponseInterceptorContext
 
getRoleName() - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
getSchema() - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
getSchema() - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
getSecretKey() - Method in class com.volcengine.sign.Credentials
 
getSecurityKey() - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
getService() - Method in class com.volcengine.endpoint.ResolveEndpointOption
 
getService() - Method in class com.volcengine.model.ResponseMetadata
 
getService() - Method in class com.volcengine.sign.VolcstackSign
 
getServiceInfo() - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
getServiceName() - Method in class com.volcengine.sign.ServiceInfo
 
getServiceName() - Method in class com.volcengine.UniversalRequest
 
getSessionToken() - Method in class com.volcengine.auth.CredentialValue
 
getSessionToken() - Method in class com.volcengine.sign.Credentials
 
getSk() - Method in class com.volcengine.auth.CredentialValue
 
getSslCaCert() - Method in class com.volcengine.ApiClient
Get SSL CA cert.
getStatusCode() - Method in class com.volcengine.ApiResponse
 
getTempFolderPath() - Method in class com.volcengine.ApiClient
The path of temporary folder used to store downloaded files from endpoints with file response.
getTimeout() - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
getTruePath(String, Map<String, String>) - Method in class com.volcengine.ApiClient
 
GetType() - Method in enum com.volcengine.ContentType
 
getUseDualStack() - Method in class com.volcengine.ApiClient
Get the use dual stack flag.
getUseDualStack() - Method in class com.volcengine.endpoint.ResolveEndpointOption
 
getValue() - Method in class com.volcengine.Pair
 
getVersion() - Method in class com.volcengine.model.ResponseMetadata
 
getVersion() - Method in class com.volcengine.UniversalRequest
 
getWriteTimeout() - Method in class com.volcengine.ApiClient
Get write timeout (in milliseconds).
guessContentTypeFromFile(File) - Method in class com.volcengine.ApiClient
Guess Content-Type header from the given file (defaults to "application/octet-stream").

H

handleResponse(Response, Type, boolean...) - Method in class com.volcengine.ApiClient
Handle the given response, return the deserialized object when the response is successful.
headerParams(Map<String, String>) - Method in class com.volcengine.interceptor.InitInterceptorContext.Builder
 
HttpMethod - Enum in com.volcengine
xuyaming@bytedance.com 2022/12/23 15:34

I

InitInterceptorContext - Class in com.volcengine.interceptor
 
InitInterceptorContext() - Constructor for class com.volcengine.interceptor.InitInterceptorContext
 
initInterceptorContext - Variable in class com.volcengine.interceptor.InterceptorContext
 
InitInterceptorContext.Builder - Class in com.volcengine.interceptor
 
insertRequestInterceptor(RequestInterceptor, String) - Method in class com.volcengine.interceptor.InterceptorChain
 
insertResponseInterceptor(ResponseInterceptor, String) - Method in class com.volcengine.interceptor.InterceptorChain
 
intercept(InterceptorContext) - Method in class com.volcengine.interceptor.BuildRequestInterceptor
 
intercept(InterceptorContext) - Method in class com.volcengine.interceptor.DeserializedResponseInterceptor
 
intercept(InterceptorContext) - Method in interface com.volcengine.interceptor.RequestInterceptor
 
intercept(InterceptorContext) - Method in class com.volcengine.interceptor.ResolveEndpointInterceptor
 
intercept(InterceptorContext) - Method in interface com.volcengine.interceptor.ResponseInterceptor
 
intercept(InterceptorContext) - Method in class com.volcengine.interceptor.SignRequestInterceptor
 
InterceptorChain - Class in com.volcengine.interceptor
 
InterceptorChain() - Constructor for class com.volcengine.interceptor.InterceptorChain
 
InterceptorContext - Class in com.volcengine.interceptor
 
InterceptorContext(OkHttpClient, Request) - Constructor for class com.volcengine.interceptor.InterceptorContext
 
isApplicationJsonBody(Map<String, String>) - Method in class com.volcengine.ApiClient
 
isCommon(boolean) - Method in class com.volcengine.interceptor.InitInterceptorContext.Builder
 
isCommon() - Method in class com.volcengine.interceptor.InitInterceptorContext
 
isCommon() - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
isCommon() - Method in class com.volcengine.interceptor.ResponseInterceptorContext
 
isDebugging() - Method in class com.volcengine.ApiClient
Check that whether debugging is enabled for this API client.
isExpired() - Method in interface com.volcengine.auth.Provider
 
isExpired() - Method in class com.volcengine.auth.StaticCredentialProvider
 
isExpired() - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
isJsonMime(String) - Method in class com.volcengine.ApiClient
Check if the given MIME is a JSON MIME.
isPostBody(Map<String, String>) - Method in class com.volcengine.ApiClient
 
isVerifyingSsl() - Method in class com.volcengine.ApiClient
True if isVerifyingSsl flag is on

J

join(String[], String) - Static method in class com.volcengine.StringUtil
Join an array of strings with the given separator.
JSON - Class in com.volcengine
 
JSON() - Constructor for class com.volcengine.JSON
 
JSON.DateTypeAdapter - Class in com.volcengine
Gson TypeAdapter for java.util.Date type If the dateFormat is null, ISO8601Utils will be used.
JSON.LocalDateTypeAdapter - Class in com.volcengine
Gson TypeAdapter for JSR310 LocalDate type
JSON.OffsetDateTimeTypeAdapter - Class in com.volcengine
Gson TypeAdapter for JSR310 OffsetDateTime type
JSON.SqlDateTypeAdapter - Class in com.volcengine
Gson TypeAdapter for java.sql.Date type If the dateFormat is null, a simple "yyyy-MM-dd" format will be used (more efficient than SimpleDateFormat).

L

LocalDateTypeAdapter() - Constructor for class com.volcengine.JSON.LocalDateTypeAdapter
 
LocalDateTypeAdapter(DateTimeFormatter) - Constructor for class com.volcengine.JSON.LocalDateTypeAdapter
 

M

method(String) - Method in class com.volcengine.interceptor.InitInterceptorContext.Builder
 

N

name - Static variable in class com.volcengine.interceptor.BuildRequestInterceptor
 
name() - Method in class com.volcengine.interceptor.BuildRequestInterceptor
 
name - Static variable in class com.volcengine.interceptor.DeserializedResponseInterceptor
 
name() - Method in class com.volcengine.interceptor.DeserializedResponseInterceptor
 
name() - Method in interface com.volcengine.interceptor.RequestInterceptor
 
name - Static variable in class com.volcengine.interceptor.ResolveEndpointInterceptor
 
name() - Method in class com.volcengine.interceptor.ResolveEndpointInterceptor
 
name() - Method in interface com.volcengine.interceptor.ResponseInterceptor
 
name - Static variable in class com.volcengine.interceptor.SignRequestInterceptor
 
name() - Method in class com.volcengine.interceptor.SignRequestInterceptor
 

O

OffsetDateTimeTypeAdapter() - Constructor for class com.volcengine.JSON.OffsetDateTimeTypeAdapter
 
OffsetDateTimeTypeAdapter(DateTimeFormatter) - Constructor for class com.volcengine.JSON.OffsetDateTimeTypeAdapter
 
onDownloadProgress(long, long, boolean) - Method in interface com.volcengine.ApiCallback
This is called when the API downlond processing.
onFailure(ApiException, int, Map<String, List<String>>) - Method in interface com.volcengine.ApiCallback
This is called when the API call fails.
onRequestProgress(long, long, boolean) - Method in interface com.volcengine.ProgressRequestBody.ProgressRequestListener
 
onSuccess(T, int, Map<String, List<String>>) - Method in interface com.volcengine.ApiCallback
This is called when the API call succeeded.
onUploadProgress(long, long, boolean) - Method in interface com.volcengine.ApiCallback
This is called when the API upload processing.

P

Pair - Class in com.volcengine
 
Pair(String, String) - Constructor for class com.volcengine.Pair
 
parameterToPair(String, Object) - Method in class com.volcengine.ApiClient
Formats the specified query parameter to a list containing a single Pair object.
parameterToPairs(String, String, Collection) - Method in class com.volcengine.ApiClient
Formats the specified collection query parameters to a list of Pair objects.
parameterToString(Object) - Method in class com.volcengine.ApiClient
Format the given parameter object into string.
path(String) - Method in class com.volcengine.interceptor.InitInterceptorContext.Builder
 
prepareDownloadFile(Response) - Method in class com.volcengine.ApiClient
Prepare file for download
processDefaultHeader(Map<String, String>) - Method in class com.volcengine.ApiClient
 
processHeaderParams(Map<String, String>, Request.Builder) - Method in class com.volcengine.ApiClient
Set header parameters to the request builder, including default headers.
ProgressRequestBody - Class in com.volcengine
 
ProgressRequestBody(RequestBody, ProgressRequestBody.ProgressRequestListener) - Constructor for class com.volcengine.ProgressRequestBody
 
ProgressRequestBody.ProgressRequestListener - Interface in com.volcengine
 
progressRequestListener(ProgressRequestBody.ProgressRequestListener) - Method in class com.volcengine.interceptor.InitInterceptorContext.Builder
 
ProgressResponseBody - Class in com.volcengine
 
ProgressResponseBody(ResponseBody, ProgressResponseBody.ProgressListener) - Constructor for class com.volcengine.ProgressResponseBody
 
ProgressResponseBody.ProgressListener - Interface in com.volcengine
 
Provider - Interface in com.volcengine.auth
 

Q

queryParams(List<Pair>) - Method in class com.volcengine.interceptor.InitInterceptorContext.Builder
 

R

read(JsonReader) - Method in class com.volcengine.JSON.DateTypeAdapter
 
read(JsonReader) - Method in class com.volcengine.JSON.LocalDateTypeAdapter
 
read(JsonReader) - Method in class com.volcengine.JSON.OffsetDateTimeTypeAdapter
 
read(JsonReader) - Method in class com.volcengine.JSON.SqlDateTypeAdapter
 
refresh() - Method in interface com.volcengine.auth.Provider
 
refresh() - Method in class com.volcengine.auth.StaticCredentialProvider
 
refresh() - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
REGION_CODE_AP_SOUTH_EAST_2 - Static variable in class com.volcengine.endpoint.DefaultEndpointProvider
 
REGION_CODE_AP_SOUTH_EAST_3 - Static variable in class com.volcengine.endpoint.DefaultEndpointProvider
 
REGION_CODE_CN_BEIJING_AUTODRIVING - Static variable in class com.volcengine.endpoint.DefaultEndpointProvider
 
REGION_CODE_CN_HONGKONG - Static variable in class com.volcengine.endpoint.DefaultEndpointProvider
 
REGION_CODE_CN_SHANGHAI_AUTODRIVING - Static variable in class com.volcengine.endpoint.DefaultEndpointProvider
 
requestContext - Variable in class com.volcengine.interceptor.InterceptorContext
 
RequestInterceptor - Interface in com.volcengine.interceptor
 
RequestInterceptorContext - Class in com.volcengine.interceptor
 
RequestInterceptorContext() - Constructor for class com.volcengine.interceptor.RequestInterceptorContext
 
ResolvedEndpoint - Class in com.volcengine.endpoint
 
ResolvedEndpoint() - Constructor for class com.volcengine.endpoint.ResolvedEndpoint
 
ResolveEndpointInterceptor - Class in com.volcengine.interceptor
 
ResolveEndpointInterceptor() - Constructor for class com.volcengine.interceptor.ResolveEndpointInterceptor
 
ResolveEndpointOption - Class in com.volcengine.endpoint
 
ResolveEndpointOption() - Constructor for class com.volcengine.endpoint.ResolveEndpointOption
 
responseContext - Variable in class com.volcengine.interceptor.InterceptorContext
 
ResponseInterceptor - Interface in com.volcengine.interceptor
 
ResponseInterceptorContext - Class in com.volcengine.interceptor
 
ResponseInterceptorContext() - Constructor for class com.volcengine.interceptor.ResponseInterceptorContext
 
responseMetadata - Variable in class com.volcengine.model.AbstractResponse
 
ResponseMetadata - Class in com.volcengine.model
xuyaming@bytedance.com 2022/3/18 15:20
ResponseMetadata() - Constructor for class com.volcengine.model.ResponseMetadata
 
retrieve() - Method in interface com.volcengine.auth.Provider
 
retrieve() - Method in class com.volcengine.auth.StaticCredentialProvider
 
retrieve() - Method in class com.volcengine.auth.StsAssumeRoleProvider
 

S

sanitizeFilename(String) - Method in class com.volcengine.ApiClient
Sanitize filename by removing path.
SDK_NAME - Static variable in class com.volcengine.version.Version
 
SDK_VERSION - Static variable in class com.volcengine.version.Version
 
selectHeaderAccept(String[]) - Method in class com.volcengine.ApiClient
Select the Accept header's value from the given accepts array: if JSON exists in the given array, use it; otherwise use all of them (joining into a string)
selectHeaderContentType(String[]) - Method in class com.volcengine.ApiClient
Select the Content-Type header's value from the given array: if JSON exists in the given array, use it; otherwise use the first one of the array.
serialize(Object, String) - Method in class com.volcengine.ApiClient
Serialize the given Java object into request body according to the object's class and the request Content-Type.
serialize(Object) - Method in class com.volcengine.JSON
Serialize the given Java object into JSON string.
ServiceInfo - Class in com.volcengine.sign
xuyaming@bytedance.com 2022/3/18 14:08
ServiceInfo(String, String) - Constructor for class com.volcengine.sign.ServiceInfo
 
ServiceInfo() - Constructor for class com.volcengine.sign.ServiceInfo
 
setAccessKey(String) - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
setAccessKey(String) - Method in class com.volcengine.sign.Credentials
 
setAccountId(String) - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
setAction(String) - Method in class com.volcengine.model.ResponseMetadata
 
setAction(String) - Method in class com.volcengine.UniversalRequest
 
setAk(String) - Method in class com.volcengine.auth.CredentialValue
 
setApiClient(ApiClient) - Method in class com.volcengine.interceptor.InterceptorContext
 
setApiClient(ApiClient) - Method in class com.volcengine.UniversalApi
 
setAuthNames(String[]) - Method in class com.volcengine.interceptor.InitInterceptorContext
 
setAuthNames(String[]) - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
setBody(Object) - Method in class com.volcengine.interceptor.InitInterceptorContext
 
setCall(Call) - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
setCode(String) - Method in class com.volcengine.model.Error
 
setCodeN(Integer) - Method in class com.volcengine.model.Error
 
setCollectionQueryParams(List<Pair>) - Method in class com.volcengine.interceptor.InitInterceptorContext
 
setCommon(boolean) - Method in class com.volcengine.interceptor.InitInterceptorContext
 
setCommon(boolean) - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
setCommon(boolean) - Method in class com.volcengine.interceptor.ResponseInterceptorContext
 
setConnectTimeout(int) - Method in class com.volcengine.ApiClient
Sets the connect timeout (in milliseconds).
setContentType(ContentType) - Method in class com.volcengine.UniversalRequest
 
setCredentialProvider(CredentialProvider) - Method in class com.volcengine.ApiClient
 
setCredentials(Credentials) - Method in class com.volcengine.ApiClient
Set credentials
setCredentials(Credentials) - Method in class com.volcengine.sign.VolcstackSign
 
setCredentialValue(CredentialValue) - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
setCustomBootstrapRegion(Set<String>) - Method in class com.volcengine.ApiClient
Set the custom bootstrapping regions.
setCustomBootstrapRegion(Set<String>) - Method in class com.volcengine.endpoint.ResolveEndpointOption
 
setData(Object) - Method in class com.volcengine.interceptor.ResponseInterceptorContext
 
setDateFormat(DateFormat) - Method in class com.volcengine.ApiClient
 
setDateFormat(DateFormat) - Method in class com.volcengine.JSON
 
setDebugging(boolean) - Method in class com.volcengine.ApiClient
Enable/disable debugging for this API client.
setDefaultApiClient(ApiClient) - Static method in class com.volcengine.Configuration
Set the default API client, which would be used when creating API instances without providing an API client.
setDisableSSL(boolean) - Method in class com.volcengine.ApiClient
Set disableSSL
setDurationSeconds(int) - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
setEndpoint(String) - Method in class com.volcengine.ApiClient
Set base path
setEndpoint(String) - Method in class com.volcengine.endpoint.ResolvedEndpoint
 
setEndpointResolver(EndpointResolver) - Method in class com.volcengine.ApiClient
 
setError(Error) - Method in class com.volcengine.model.ResponseMetadata
 
setExpirationTime(long) - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
setExpireBufferSeconds(int) - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
setFormat(DateFormat) - Method in class com.volcengine.JSON.DateTypeAdapter
 
setFormat(DateTimeFormatter) - Method in class com.volcengine.JSON.LocalDateTypeAdapter
 
setFormat(DateTimeFormatter) - Method in class com.volcengine.JSON.OffsetDateTimeTypeAdapter
 
setFormat(DateFormat) - Method in class com.volcengine.JSON.SqlDateTypeAdapter
 
setFormParams(Map<String, Object>) - Method in class com.volcengine.interceptor.InitInterceptorContext
 
setGson(Gson) - Method in class com.volcengine.JSON
Set Gson.
setHeaderParams(Map<String, String>) - Method in class com.volcengine.interceptor.InitInterceptorContext
 
setHeaderParams(Map<String, String>) - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
setHeaders(Headers) - Method in class com.volcengine.interceptor.ResponseInterceptorContext
 
setHost(String) - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
setHost(String) - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
setHttpClient(OkHttpClient) - Method in class com.volcengine.ApiClient
Set HTTP client
setHttpCode(int) - Method in class com.volcengine.interceptor.ResponseInterceptorContext
 
setHttpMethod(HttpMethod) - Method in class com.volcengine.UniversalRequest
 
setInitInterceptorContext(InitInterceptorContext) - Method in class com.volcengine.interceptor.InterceptorContext
 
setJSON(JSON) - Method in class com.volcengine.ApiClient
Set JSON
setKeepAliveDurationMs(Integer) - Method in class com.volcengine.ApiClient
 
setKeyManagers(KeyManager[]) - Method in class com.volcengine.ApiClient
Configure client keys to use for authorization in an SSL session.
setLenientOnJson(boolean) - Method in class com.volcengine.ApiClient
 
setLenientOnJson(boolean) - Method in class com.volcengine.JSON
 
setLocalDateFormat(DateTimeFormatter) - Method in class com.volcengine.ApiClient
 
setLocalDateFormat(DateTimeFormatter) - Method in class com.volcengine.JSON
 
setMaxIdleConns(Integer) - Method in class com.volcengine.ApiClient
 
setMessage(String) - Method in class com.volcengine.model.Error
 
setMethod(String) - Method in class com.volcengine.interceptor.InitInterceptorContext
 
setMethod(String) - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
setMethod(String) - Method in class com.volcengine.sign.ServiceInfo
 
setMethod(String) - Method in class com.volcengine.sign.VolcstackSign
 
setOffsetDateTimeFormat(DateTimeFormatter) - Method in class com.volcengine.ApiClient
 
setOffsetDateTimeFormat(DateTimeFormatter) - Method in class com.volcengine.JSON
 
setOriginalResponse(Response) - Method in class com.volcengine.interceptor.ResponseInterceptorContext
 
setPath(String) - Method in class com.volcengine.interceptor.InitInterceptorContext
 
setPath(String) - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
setProgressRequestListener(ProgressRequestBody.ProgressRequestListener) - Method in class com.volcengine.interceptor.InitInterceptorContext
 
setProgressRequestListener(ProgressRequestBody.ProgressRequestListener) - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
setProviderName(String) - Method in class com.volcengine.auth.CredentialValue
 
setQueryParams(List<Pair>) - Method in class com.volcengine.interceptor.InitInterceptorContext
 
setQueryParams(List<Pair>) - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
setReadTimeout(int) - Method in class com.volcengine.ApiClient
Sets the read timeout (in milliseconds).
setRegion(String) - Method in class com.volcengine.ApiClient
Set region
setRegion(String) - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
setRegion(String) - Method in class com.volcengine.endpoint.ResolveEndpointOption
 
setRegion(String) - Method in class com.volcengine.model.ResponseMetadata
 
setRegion(String) - Method in class com.volcengine.sign.VolcstackSign
 
setRequestBody(RequestBody) - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
setRequestContext(RequestInterceptorContext) - Method in class com.volcengine.interceptor.InterceptorContext
 
setRequestId(String) - Method in class com.volcengine.model.ResponseMetadata
 
setResponseContext(ResponseInterceptorContext) - Method in class com.volcengine.interceptor.InterceptorContext
 
setResponseMetadata(ResponseMetadata) - Method in exception com.volcengine.ApiException
 
setResponseMetadata(ResponseMetadata) - Method in class com.volcengine.model.AbstractResponse
 
setResponseMetadata(ResponseMetadata) - Method in class com.volcengine.model.VolcstackResponse
 
setResult(T) - Method in class com.volcengine.model.VolcstackResponse
 
setReturnType(Type) - Method in class com.volcengine.interceptor.ResponseInterceptorContext
 
setRoleName(String) - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
setSchema(String) - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
setSchema(String) - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
setSecretKey(String) - Method in class com.volcengine.sign.Credentials
 
setSecurityKey(String) - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
setService(String) - Method in class com.volcengine.endpoint.ResolveEndpointOption
 
setService(String) - Method in class com.volcengine.model.ResponseMetadata
 
setService(String) - Method in class com.volcengine.sign.VolcstackSign
 
setServiceInfo(ServiceInfo) - Method in class com.volcengine.interceptor.RequestInterceptorContext
 
setServiceName(String) - Method in class com.volcengine.sign.ServiceInfo
 
setServiceName(String) - Method in class com.volcengine.UniversalRequest
 
setSessionToken(String) - Method in class com.volcengine.auth.CredentialValue
 
setSessionToken(String) - Method in class com.volcengine.sign.Credentials
 
setSk(String) - Method in class com.volcengine.auth.CredentialValue
 
setSqlDateFormat(DateFormat) - Method in class com.volcengine.ApiClient
 
setSqlDateFormat(DateFormat) - Method in class com.volcengine.JSON
 
setSslCaCert(InputStream) - Method in class com.volcengine.ApiClient
Configure the CA certificate to be trusted when making https requests.
setTempFolderPath(String) - Method in class com.volcengine.ApiClient
Set the temporary folder path (for downloading files)
setTimeout(int) - Method in class com.volcengine.auth.StsAssumeRoleProvider
 
setUseDualStack(boolean) - Method in class com.volcengine.ApiClient
Set the use dual stack flag.
setUseDualStack(Boolean) - Method in class com.volcengine.endpoint.ResolveEndpointOption
 
setUserAgent(String) - Method in class com.volcengine.ApiClient
Set the User-Agent header's value (by adding to the default header map).
setVerifyingSsl(boolean) - Method in class com.volcengine.ApiClient
Configure whether to verify certificate and hostname when making https requests.
setVersion(String) - Method in class com.volcengine.model.ResponseMetadata
 
setVersion(String) - Method in class com.volcengine.UniversalRequest
 
setWriteTimeout(int) - Method in class com.volcengine.ApiClient
Sets the write timeout (in milliseconds).
SignRequestInterceptor - Class in com.volcengine.interceptor
 
SignRequestInterceptor() - Constructor for class com.volcengine.interceptor.SignRequestInterceptor
 
source() - Method in class com.volcengine.ProgressResponseBody
 
SqlDateTypeAdapter() - Constructor for class com.volcengine.JSON.SqlDateTypeAdapter
 
SqlDateTypeAdapter(DateFormat) - Constructor for class com.volcengine.JSON.SqlDateTypeAdapter
 
StaticCredentialProvider - Class in com.volcengine.auth
 
StaticCredentialProvider(String, String, String) - Constructor for class com.volcengine.auth.StaticCredentialProvider
 
StringUtil - Class in com.volcengine
 
StringUtil() - Constructor for class com.volcengine.StringUtil
 
StsAssumeRoleProvider - Class in com.volcengine.auth
 
StsAssumeRoleProvider(String, String, String, String) - Constructor for class com.volcengine.auth.StsAssumeRoleProvider
 

T

toString() - Method in exception com.volcengine.ApiException
 

U

UniversalApi - Class in com.volcengine
xuyaming@bytedance.com 2022/12/23 15:21
UniversalApi(ApiClient) - Constructor for class com.volcengine.UniversalApi
 
UniversalApi() - Constructor for class com.volcengine.UniversalApi
 
UniversalRequest - Class in com.volcengine
xuyaming@bytedance.com 2022/12/23 15:33
UniversalRequest(String, String, String, HttpMethod, ContentType) - Constructor for class com.volcengine.UniversalRequest
 
UniversalRequest() - Constructor for class com.volcengine.UniversalRequest
 
UniversalRequest(String, String, String) - Constructor for class com.volcengine.UniversalRequest
 
update(long, long, boolean) - Method in interface com.volcengine.ProgressResponseBody.ProgressListener
 
updateParamsForAuth(String[], List<Pair>, Map<String, String>) - Method in class com.volcengine.ApiClient
Update query and header parameters based on authentication settings.
updateParamsForAuth(String[], List<Pair>, Map<String, String>, ServiceInfo, String) - Method in class com.volcengine.ApiClient
 
updateQueryParams(List<Pair>, String[]) - Method in class com.volcengine.ApiClient
 

V

valueOf(String) - Static method in enum com.volcengine.ContentType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.volcengine.HttpMethod
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.volcengine.ContentType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.volcengine.HttpMethod
Returns an array containing the constants of this enum type, in the order they are declared.
Version - Class in com.volcengine.version
 
Version() - Constructor for class com.volcengine.version.Version
 
VolcstackResponse<T> - Class in com.volcengine.model
xuyaming@bytedance.com 2022/3/18 15:21
VolcstackResponse() - Constructor for class com.volcengine.model.VolcstackResponse
 
VolcstackSign - Class in com.volcengine.sign
xuyaming@bytedance.com 2022/3/18 13:13
VolcstackSign() - Constructor for class com.volcengine.sign.VolcstackSign
 
VolcstackSign(Credentials) - Constructor for class com.volcengine.sign.VolcstackSign
 

W

write(JsonWriter, Date) - Method in class com.volcengine.JSON.DateTypeAdapter
 
write(JsonWriter, LocalDate) - Method in class com.volcengine.JSON.LocalDateTypeAdapter
 
write(JsonWriter, OffsetDateTime) - Method in class com.volcengine.JSON.OffsetDateTimeTypeAdapter
 
write(JsonWriter, Date) - Method in class com.volcengine.JSON.SqlDateTypeAdapter
 
writeTo(BufferedSink) - Method in class com.volcengine.ProgressRequestBody
 
A B C D E F G H I J L M N O P Q R S T U V W 
Skip navigation links

Copyright © 2025. All rights reserved.