All Classes

Class	Description
AbstractToken	This class defines a common base class for tokens returned by a token server.
Authenticator	This interface defines the common methods and constants associated with an Authenticator implementation.
AuthenticatorBase	This is a common base class used with the various Authenticator implementations.
BadRequestException	400 Bad Request (HTTP/1.1 - RFC 2616).
BaseService	Abstracts common functionality of various IBM Cloud services.
BasicAuthenticator	This class implements support for Basic Authentication.
BasicAuthenticator.Builder	This Builder class is used to construct BasicAuthenticator instances.
BearerTokenAuthenticator	This class provides an Authenticator implementation that supports a user-supplied Bear Token value.
BooleanToStringTypeAdapter	This TypeAdapter converts "yes", "no", "true", and "false" to Booleans and vice versa.
ByteArrayTypeAdapter	This class serves as a GSON type adapter for the "byte[]" type.
Clock	Wrapper class for getting the current time.
CloudPakForDataAuthenticator	This class provides an Authenticator implementation for the "CloudPakForData" environment.
CloudPakForDataAuthenticator.Builder	This Builder class is used to construct CloudPakForDataAuthenticator instances.
CloudPakForDataServiceAuthenticator	This class provides an Authenticator implementation for the "CloudPakForData" environment.
CloudPakForDataServiceAuthenticator.Builder	This Builder class is used to construct CloudPakForDataServiceAuthenticator instances.
CloudPakForDataServiceInstanceAuthenticator	This class provides an Authenticator implementation for the "CloudPakForData" environment.
CloudPakForDataServiceInstanceAuthenticator.Builder	This Builder class is used to construct CloudPakForDataServiceInstanceAuthenticator instances.
ConfigBasedAuthenticatorFactory	This class serves as an Authenticator factory.
ConflictException	409 Conflict (HTTP/1.1 - RFC 2616).
ContainerAuthenticator	ContainerAuthenticator implements an IAM-based authentication scheme whereby it retrieves a "compute resource token" from the local compute resource (VM) and uses that to obtain an IAM access token by invoking the IAM "get token" operation with grant-type=cr-token.
ContainerAuthenticator.Builder	This Builder class is used to construct ContainerAuthenticator instances.
Cp4dServiceInstanceTokenResponse	This class models a response received from the CP4D "GET /zen-data/v3/service_instances/serviceInstanceId/token" operation.
Cp4dToken	This class holds relevant info re: a CP4D access token for use by the CloudPakForDataAuthenticator class.
Cp4dTokenResponse	This class models a response received from the CP4D "POST /v1/authorize" operation.
CredentialUtils	CredentialUtils retrieves service credentials from the environment.
CredentialUtils.VcapCredentials	This class is used to unmarshal the contents of the "credentials" field within a vcap service entry.
CredentialUtils.VcapService	This class is used to unmarshal an item in the list of services belonging to a particular service key.
DateTimeTypeAdapter	This class handles the serialization and deserialization of Date instances that should be interpretted as OpenAPI "date-time" values. This is the default type adapter that we register with Gson for handling Date fields.
DateTypeAdapter	This class handles the serialization and deserialization of Date instances that should interpretted as OpenAPI "date" values. This type adapter is used by setting the JsonAdapter annotation on a field of type Date.
DateUtils	This class contains utilities for formatting and parsing Date instances as OpenAPI "date" or "date-time" values.
DefaultRetryStrategy	This is the java core's default retry strategy.
DelegatingSSLSocketFactory	A SSLSocketFactory that delegates calls.
DiscriminatorBasedTypeAdapterFactory	This class is registered with Gson to perform deserialization of classes that have discriminator metadata defined in them.
DiscriminatorBasedTypeAdapterFactory.Adapter<T>	An adapter for serializing/deserializing instances of type T, where T represents a generated model that defines a discriminator to aid in deserialization.
DynamicModel<T>	Abstract model class for a model which supports dynamic (arbitrary) properties of type T.
DynamicModelTypeAdapterFactory	This class is registered with Gson to perform serialization and deserialization for dynamic model classes.
DynamicModelTypeAdapterFactory.Adapter<T>	An adapter for serializing/deserializing instances of type T, where T represents a generated dynamic model class which is a subclass of DynamicModel.
EnvironmentUtils	This is a utility class that contains methods related to environment variables.
FileWithMetadata	A file and its associated metadata.
FileWithMetadata.Builder	Builder.
ForbiddenException	403 Forbidden (HTTP/1.0 - RFC 1945).
GenericModel	Abstract model class to provide a default toString() method in model classes.
GsonSerializationHelper	Deprecated. This class should no longer be needed once users upgrade to a recent version of the package that contains the new DynamicModel pattern.
GsonSingleton	Gson singleton to be use when transforming from JSON to Java Objects and vise versa.
GzipRequestInterceptor	This interceptor compresses the HTTP request body.
Headers	Wrapper class for the internal HTTP headers class.
HttpClientSingleton	This class encapsulate the OkHttpClient instance in a singleton pattern.
HttpConfigOptions	Options class for configuring the HTTP client.
HttpConfigOptions.Builder
HttpConfigOptions.LoggingLevel	Levels of information to log when making HTTP requests, from least (NONE) to most (BODY).
HttpHeaders	HTTP constant headers.
HttpLogger	An okhttp Interceptor that performs custom logging of HTTP request and response messages.
HttpLogging	Deprecated. This class functionality is now handled by HttpConfigOptions and should no longer be needed.
HttpMediaType	An abstraction for a media type.
HttpStatus	Constants enumerating the HTTP status codes.
IamAssumeAuthenticator	The IamAssumeAuthenticator obtains an IAM access token for a user-supplied apikey and a trusted profile using the IAM "get-token" operation's "assume" grant type.
IamAssumeAuthenticator.Builder	This Builder class is used to construct IamAssumeAuthenticator instances.
IamAuthenticator	This class provides an Authenticator implementation for IAM (Identity and Access Management).
IamAuthenticator.Builder	This Builder class is used to construct IamAuthenticator instances.
IamRequestBasedAuthenticator	This class effectively adds some setter functions to the IamRequestBasedAuthenticatorImmutable class in order to allow subclasses (e.g.
IamRequestBasedAuthenticatorImmutable	This class contains code that is common to all authenticators that need to interact with the IAM token service to obtain an access token.
IamToken	Represents response from IAM API.
InputStreamRequestBody	RequestBody that takes an InputStream.
InternalServerErrorException	500 Server Error (HTTP/1.0 - RFC 1945).
InvalidServiceResponseException	This exception class represents an invalid response body received from the server.
IRetryInterceptor	This is a marker interface used to identify retry interceptor implementations within the java core library.
IRetryStrategy	IRetryStrategy is an interface that is implemented by retry interceptor factories.
JsonWebToken	This class is used to decode and parse a JWT (Json Web Token).
LoggingUtils	A collection of utilities used by our logging function.
LongToDateTypeAdapter	This TypeAdapter converts unix timestamps (in numeric or String form) to Java Dates and vice versa.
MapValueObjectTypeAdapter	This class is adapted from the ObjectTypeAdapter from the GSON project.
MCSPAuthenticator	This class provides an Authenticator implementation for the Multi-Cloud Saas Platform (MCSP) environment.
MCSPAuthenticator.Builder	This Builder class is used to construct MCSPAuthenticator instances.
MCSPToken	This class holds the cached information related to an access token received by the Multi-Cloud Saas Platform (MCSP) Authenticator.
MCSPTokenResponse	This class models a response received from the Multi-Cloud Saas Platform token server's "POST /siusermgr/api/1.0/apikeys/token" operation.
NameValue	A name / value pair parameter used as an element of HTTP messages.
NoAuthAuthenticator	This class is a placeholder implementation of the Authenticator interface which performs no authentication of outgoing REST API requests.
NotAcceptableException	406 Not Acceptable (HTTP/1.0 - RFC 1945).
NotFoundException	404 Not Found (HTTP/1.0 - RFC 1945).
ObjectModel	Interface for both generic and dynamic model classes.
RateLimitConstants	Deprecated. As of 9.13.0, use the RetryInterceptor instead.
RateLimitContext	Deprecated. As of 9.13.0, use the RetryInterceptor instead.
RateLimitInterceptor	Deprecated. As of 9.13.0, use the RetryInterceptor instead.
RequestBuilder	Convenience class for constructing HTTP/HTTPS requests.
RequestTooLargeException	413 Request Entity Too Large (HTTP/1.1 - RFC 2616).
RequestUtils	Utility functions to use when creating a RequestBuilder.
Response<T>	Class holding the converted service call result along with some HTTP response data.
ResponseConverter<T>	The Interface ResponseConverter.
ResponseConverterUtils	Utility class to convert service responses into a ResponseConverter.
ResponseUtils	Utility class to manage service responses.
RetryInterceptor	This class is an okhttp Interceptor implementation that will try to automatically retry failed requests, based on the type of failure that occurred.
ServiceCall<T>	Service Call.
ServiceCallback<T>	Callback with the response for an Asynchronous request.
ServiceCookieJar	This is an adapter that uses JavaNetCookieJar.
ServiceResponseException	Generic Service Response Exception.
ServiceUnavailableException	503 Service Unavailable (HTTP/1.0 - RFC 1945).
StringHelper	Helper class used by java code generated by the SDK codegen tool.
TokenRequestBasedAuthenticator<T extends AbstractToken,R extends TokenServerResponse>	This class serves as a common base class for Authenticator implementations that interact with a token service via a REST interface.
TokenRequestBasedAuthenticatorImmutable<T extends AbstractToken,R extends TokenServerResponse>	This class serves as a common base class for Authenticator implementations that interact with a token service via a REST interface.
TokenServerResponse	This interface is used as a marker for classes that model the response received from a Token Server.
TooManyRequestsException	429 Too Many Requests (HTTP/1.1 - RFC 6585).
UnauthorizedException	401 Unauthorized (HTTP/1.0 - RFC 1945).
UnsupportedException	415 Unsupported Media Type (HTTP/1.1 - RFC 2616).
UrlHelper
Validator	This class assists in validating arguments. If an argument value is deemed invalid, an IllegalArgumentException is thrown.
VpcInstanceAuthenticator	VpcInstanceAuthenticator implements an authentication scheme in which it retrieves an "instance identity token" and exchanges that for an IAM access token using the VPC Instance Metadata Service API which is available on a local VPC-managed compute resource (VM).
VpcInstanceAuthenticator.Builder	This Builder class is used to construct IamAuthenticator instances.
VpcTokenResponse	This class models the response received from the VPC "create_access_token" and "create_iam_token" operations.