A B C D E F G H I J L M N O P Q R S T U V W 
All Classes All Packages

A

AbstractToken - Class in com.ibm.cloud.sdk.core.security
This class defines a common base class for tokens returned by a token server.
AbstractToken() - Constructor for class com.ibm.cloud.sdk.core.security.AbstractToken
 
AbstractToken(Throwable) - Constructor for class com.ibm.cloud.sdk.core.security.AbstractToken
 
ACCEPT - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
ACCEPT_CHARSET - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
ACCEPT_ENCODING - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
ACCEPT_LANGUAGE - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
ACCEPTED - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
202 Accepted (HTTP/1.0 - RFC 1945).
addHeader(String, String) - Method in interface com.ibm.cloud.sdk.core.http.ServiceCall
Add a header to the request before executing.
apikey - Variable in class com.ibm.cloud.sdk.core.util.CredentialUtils.VcapCredentials
 
apikey(String) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataAuthenticator.Builder
Sets the apikey property.
apikey(String) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceInstanceAuthenticator.Builder
Sets the apikey property.
apikey(String) - Method in class com.ibm.cloud.sdk.core.security.IamAuthenticator.Builder
Sets the apikey property.
apikey(String) - Method in class com.ibm.cloud.sdk.core.security.MCSPAuthenticator.Builder
Sets the apikey property.
APPLICATION_ATOM_XML - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field APPLICATION_ATOM_XML.
APPLICATION_FORM_URLENCODED - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field APPLICATION_FORM_URLENCODED.
APPLICATION_JSON - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field APPLICATION_JSON.
APPLICATION_MS_WORD - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field APPLICATION_MS_WORD.
APPLICATION_MS_WORD_DOCX - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field APPLICATION_MS_WORD_DOCX.
APPLICATION_OCTET_STREAM - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field APPLICATION_OCTET_STREAM.
APPLICATION_PDF - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field APPLICATION_PDF.
APPLICATION_SVG_XML - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field APPLICATION_SVG_XML.
APPLICATION_XHTML_XML - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field APPLICATION_XHTML_XML.
APPLICATION_XML - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field APPLICATION_XML.
APPLICATION_ZIP - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field APPLICATION_ZIP.
AUDIO_BASIC - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field AUDIO_BASIC.
AUDIO_FLAC - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field AUDIO_FLAC.
AUDIO_MP3 - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field AUDIO_MP3.
AUDIO_MPEG - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field AUDIO_MPEG.
AUDIO_MULAW - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field AUDIO_MULAW.
AUDIO_OGG - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field AUDIO_OGG.
AUDIO_OGG_VORBIS - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field AUDIO_OGG_VORBIS.
AUDIO_PCM - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field AUDIO_PCM.
AUDIO_RAW - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field AUDIO_RAW.
AUDIO_WAV - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field AUDIO_WAV.
AUDIO_WEBM - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field AUDIO_WEBM.
AUDIO_WEBM_OPUS - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field AUDIO_WEBM_OPUS.
AUDIO_WEBM_VORBIS - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field AUDIO_WEBM_VORBIS.
authenticate(Request.Builder) - Method in interface com.ibm.cloud.sdk.core.security.Authenticator
Perform the necessary authentication steps for the specified request.
authenticate(Request.Builder) - Method in class com.ibm.cloud.sdk.core.security.BasicAuthenticator
This method is called to authenticate an outgoing REST API request.
authenticate(Request.Builder) - Method in class com.ibm.cloud.sdk.core.security.BearerTokenAuthenticator
This method is called to authenticate an outgoing REST API request.
authenticate(Request.Builder) - Method in class com.ibm.cloud.sdk.core.security.NoAuthAuthenticator
 
authenticate(Request.Builder) - Method in class com.ibm.cloud.sdk.core.security.TokenRequestBasedAuthenticator
Authenticate the specified request by adding an Authorization header containing a "Bearer" access token.
authenticationType() - Method in interface com.ibm.cloud.sdk.core.security.Authenticator
Returns the authentication type associated with the Authenticator instance.
authenticationType() - Method in class com.ibm.cloud.sdk.core.security.BasicAuthenticator
 
authenticationType() - Method in class com.ibm.cloud.sdk.core.security.BearerTokenAuthenticator
 
authenticationType() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataAuthenticator
Returns the authentication type associated with this Authenticator.
authenticationType() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator
Returns the authentication type associated with this Authenticator.
authenticationType() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceInstanceAuthenticator
Returns the authentication type associated with this Authenticator.
authenticationType() - Method in class com.ibm.cloud.sdk.core.security.ContainerAuthenticator
 
authenticationType() - Method in class com.ibm.cloud.sdk.core.security.IamAuthenticator
 
authenticationType() - Method in class com.ibm.cloud.sdk.core.security.MCSPAuthenticator
 
authenticationType() - Method in class com.ibm.cloud.sdk.core.security.NoAuthAuthenticator
 
authenticationType() - Method in class com.ibm.cloud.sdk.core.security.TokenRequestBasedAuthenticator
Returns the authentication type associated with this Authenticator.
authenticationType() - Method in class com.ibm.cloud.sdk.core.security.VpcInstanceAuthenticator
Returns the authentication type associated with this Authenticator.
Authenticator - Interface in com.ibm.cloud.sdk.core.security
This interface defines the common methods and constants associated with an Authenticator implementation.
AuthenticatorBase - Class in com.ibm.cloud.sdk.core.security
This is a common base class used with the various Authenticator implementations.
AuthenticatorBase() - Constructor for class com.ibm.cloud.sdk.core.security.AuthenticatorBase
 
AUTHORIZATION - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
AUTHTYPE_BASIC - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
These are the valid authentication types.
AUTHTYPE_BEARER_TOKEN - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
AUTHTYPE_CONTAINER - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
AUTHTYPE_CP4D - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
AUTHTYPE_CP4D_SERVICE - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
AUTHTYPE_CP4D_SERVICE_INSTANCE - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
AUTHTYPE_IAM - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
AUTHTYPE_MCSP - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
AUTHTYPE_NOAUTH - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
AUTHTYPE_VPC - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 

B

BAD_GATEWAY - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
502 Bad Gateway (HTTP/1.0 - RFC 1945).
BAD_REQUEST - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
400 Bad Request (HTTP/1.1 - RFC 2616).
BadRequestException - Exception in com.ibm.cloud.sdk.core.service.exception
400 Bad Request (HTTP/1.1 - RFC 2616).
BadRequestException(Response) - Constructor for exception com.ibm.cloud.sdk.core.service.exception.BadRequestException
Instantiates a new BadRequest Exception.
BaseService - Class in com.ibm.cloud.sdk.core.service
Abstracts common functionality of various IBM Cloud services.
BaseService(String, Authenticator) - Constructor for class com.ibm.cloud.sdk.core.service.BaseService
Instantiates a new IBM Cloud service.
BASIC - com.ibm.cloud.sdk.core.http.HttpConfigOptions.LoggingLevel
 
BasicAuthenticator - Class in com.ibm.cloud.sdk.core.security
This class implements support for Basic Authentication.
BasicAuthenticator(String, String) - Constructor for class com.ibm.cloud.sdk.core.security.BasicAuthenticator
Deprecated.
As of 9.7.0, use the Builder class instead.
BasicAuthenticator(Map<String, String>) - Constructor for class com.ibm.cloud.sdk.core.security.BasicAuthenticator
Deprecated.
As of 9.7.0, use BasicAuthenticator.fromConfiguration() instead.
BasicAuthenticator.Builder - Class in com.ibm.cloud.sdk.core.security
This Builder class is used to construct BasicAuthenticator instances.
BearerTokenAuthenticator - Class in com.ibm.cloud.sdk.core.security
This class provides an Authenticator implementation that supports a user-supplied Bear Token value.
BearerTokenAuthenticator(String) - Constructor for class com.ibm.cloud.sdk.core.security.BearerTokenAuthenticator
Construct a BearerTokenAuthenticator instance with the specified access token.
BearerTokenAuthenticator(Map<String, String>) - Constructor for class com.ibm.cloud.sdk.core.security.BearerTokenAuthenticator
Deprecated.
As of 9.7.0, use BearerTokenAuthenticator.fromConfiguration() instead.
BINARY_FILE - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field BINARY_FILE.
BINARY_OCTET_STREAM - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field BINARY_OCTET_STREAM.
body(RequestBody) - Method in class com.ibm.cloud.sdk.core.http.RequestBuilder
Sets the body.
BODY - com.ibm.cloud.sdk.core.http.HttpConfigOptions.LoggingLevel
 
bodyContent(InputStream, String) - Method in class com.ibm.cloud.sdk.core.http.RequestBuilder
Sets the file content (InputStream) to the request (used with POST/PUT).
bodyContent(String, Object, Object, InputStream) - Method in class com.ibm.cloud.sdk.core.http.RequestBuilder
Sets the request body content from one of three different sources.
bodyContent(String, Object, Object, String) - Method in class com.ibm.cloud.sdk.core.http.RequestBuilder
Sets the request body content from one of three different sources.
bodyContent(String, String) - Method in class com.ibm.cloud.sdk.core.http.RequestBuilder
Sets the string content to the request (used with POST/PUT).
bodyJson(JsonObject) - Method in class com.ibm.cloud.sdk.core.http.RequestBuilder
Adds a JSON content to the request (used with POST/PUT).
bodyJson(JsonObject, String) - Method in class com.ibm.cloud.sdk.core.http.RequestBuilder
Adds a JSON content to the request (used with POST/PUT/PATCH).
BooleanToStringTypeAdapter - Class in com.ibm.cloud.sdk.core.util
This TypeAdapter converts "yes", "no", "true", and "false" to Booleans and vice versa.
BooleanToStringTypeAdapter() - Constructor for class com.ibm.cloud.sdk.core.util.BooleanToStringTypeAdapter
 
build() - Method in class com.ibm.cloud.sdk.core.http.HttpConfigOptions.Builder
 
build() - Method in class com.ibm.cloud.sdk.core.http.RequestBuilder
Builds the request.
build() - Method in class com.ibm.cloud.sdk.core.security.BasicAuthenticator.Builder
Constructs a new instance of BasicAuthenticator from the builder's configuration.
build() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataAuthenticator.Builder
Constructs a new instance of CloudPakForDataAuthenticator from the builder's configuration.
build() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator.Builder
Constructs a new instance of CloudPakForDataServiceAuthenticator from the builder's configuration.
build() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceInstanceAuthenticator.Builder
Constructs a new instance of CloudPakForDataServiceInstanceAuthenticator from the builder's configuration.
build() - Method in class com.ibm.cloud.sdk.core.security.ContainerAuthenticator.Builder
Constructs a new instance of ContainerAuthenticator from the builder's configuration.
build() - Method in class com.ibm.cloud.sdk.core.security.IamAuthenticator.Builder
Constructs a new instance of IamAuthenticator from the builder's configuration.
build() - Method in class com.ibm.cloud.sdk.core.security.MCSPAuthenticator.Builder
Constructs a new instance of MCSPAuthenticator from the builder's configuration.
build() - Method in class com.ibm.cloud.sdk.core.security.VpcInstanceAuthenticator.Builder
Constructs a new instance of IamAuthenticator from the builder's configuration.
build() - Method in class com.ibm.cloud.sdk.core.service.model.FileWithMetadata.Builder
Builds a FileWithMetadata.
Builder() - Constructor for class com.ibm.cloud.sdk.core.http.HttpConfigOptions.Builder
 
Builder() - Constructor for class com.ibm.cloud.sdk.core.security.BasicAuthenticator.Builder
 
Builder() - Constructor for class com.ibm.cloud.sdk.core.security.CloudPakForDataAuthenticator.Builder
 
Builder() - Constructor for class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator.Builder
 
Builder() - Constructor for class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceInstanceAuthenticator.Builder
 
Builder() - Constructor for class com.ibm.cloud.sdk.core.security.ContainerAuthenticator.Builder
 
Builder() - Constructor for class com.ibm.cloud.sdk.core.security.IamAuthenticator.Builder
 
Builder() - Constructor for class com.ibm.cloud.sdk.core.security.MCSPAuthenticator.Builder
Constructs an empty Builder.
Builder() - Constructor for class com.ibm.cloud.sdk.core.security.VpcInstanceAuthenticator.Builder
 
Builder() - Constructor for class com.ibm.cloud.sdk.core.service.model.FileWithMetadata.Builder
Instantiates a new builder.
Builder(File) - Constructor for class com.ibm.cloud.sdk.core.service.model.FileWithMetadata.Builder
Instantiates a new builder with required properties.
Builder(InputStream) - Constructor for class com.ibm.cloud.sdk.core.service.model.FileWithMetadata.Builder
Instantiates a new builder with required properties.
buildUserAgent(String) - Static method in class com.ibm.cloud.sdk.core.util.RequestUtils
Builds the user agent using System properties.
ByteArrayTypeAdapter - Class in com.ibm.cloud.sdk.core.util
This class serves as a GSON type adapter for the "byte[]" type.
ByteArrayTypeAdapter() - Constructor for class com.ibm.cloud.sdk.core.util.ByteArrayTypeAdapter
 

C

CACHE_CONTROL - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
cancel() - Method in interface com.ibm.cloud.sdk.core.http.ServiceCall
Cancel the current request if possible.
clientId(String) - Method in class com.ibm.cloud.sdk.core.security.ContainerAuthenticator.Builder
Sets the clientId property.
clientId(String) - Method in class com.ibm.cloud.sdk.core.security.IamAuthenticator.Builder
Sets the clientId property.
clientSecret(String) - Method in class com.ibm.cloud.sdk.core.security.ContainerAuthenticator.Builder
Sets the clientSecret property.
clientSecret(String) - Method in class com.ibm.cloud.sdk.core.security.IamAuthenticator.Builder
Sets the clientSecret property.
Clock - Class in com.ibm.cloud.sdk.core.util
Wrapper class for getting the current time.
CloudPakForDataAuthenticator - Class in com.ibm.cloud.sdk.core.security
This class provides an Authenticator implementation for the "CloudPakForData" environment.
CloudPakForDataAuthenticator(String, String, String) - Constructor for class com.ibm.cloud.sdk.core.security.CloudPakForDataAuthenticator
Deprecated.
As of 9.7.0, use CloudPakForDataAuthenticator.Builder() instead.
CloudPakForDataAuthenticator(String, String, String, boolean, Map<String, String>) - Constructor for class com.ibm.cloud.sdk.core.security.CloudPakForDataAuthenticator
Deprecated.
As of 9.7.0, use CloudPakForDataAuthenticator.Builder() instead.
CloudPakForDataAuthenticator(Map<String, String>) - Constructor for class com.ibm.cloud.sdk.core.security.CloudPakForDataAuthenticator
Deprecated.
As of 9.7.0, use CloudPakForDataAuthenticator.fromConfiguration() instead.
CloudPakForDataAuthenticator.Builder - Class in com.ibm.cloud.sdk.core.security
This Builder class is used to construct CloudPakForDataAuthenticator instances.
CloudPakForDataServiceAuthenticator - Class in com.ibm.cloud.sdk.core.security
This class provides an Authenticator implementation for the "CloudPakForData" environment.
CloudPakForDataServiceAuthenticator.Builder - Class in com.ibm.cloud.sdk.core.security
This Builder class is used to construct CloudPakForDataServiceAuthenticator instances.
CloudPakForDataServiceInstanceAuthenticator - Class in com.ibm.cloud.sdk.core.security
This class provides an Authenticator implementation for the "CloudPakForData" environment.
CloudPakForDataServiceInstanceAuthenticator.Builder - Class in com.ibm.cloud.sdk.core.security
This Builder class is used to construct CloudPakForDataServiceInstanceAuthenticator instances.
com.ibm.cloud.sdk.core.http - package com.ibm.cloud.sdk.core.http
 
com.ibm.cloud.sdk.core.http.gzip - package com.ibm.cloud.sdk.core.http.gzip
 
com.ibm.cloud.sdk.core.http.ratelimit - package com.ibm.cloud.sdk.core.http.ratelimit
 
com.ibm.cloud.sdk.core.security - package com.ibm.cloud.sdk.core.security
 
com.ibm.cloud.sdk.core.service - package com.ibm.cloud.sdk.core.service
 
com.ibm.cloud.sdk.core.service.exception - package com.ibm.cloud.sdk.core.service.exception
This package contains a collection of runtime exceptions thrown by IBM Cloud services.
com.ibm.cloud.sdk.core.service.model - package com.ibm.cloud.sdk.core.service.model
 
com.ibm.cloud.sdk.core.service.security - package com.ibm.cloud.sdk.core.service.security
 
com.ibm.cloud.sdk.core.util - package com.ibm.cloud.sdk.core.util
Utility classes to detect media types and convert files into input streams.
ConfigBasedAuthenticatorFactory - Class in com.ibm.cloud.sdk.core.security
This class serves as an Authenticator factory.
configureClient(HttpConfigOptions) - Method in class com.ibm.cloud.sdk.core.http.HttpClientSingleton
Configures the current OkHttpClient instance based on the passed-in options, replaces the current instance with the newly-configured instance and returns the new instance.
configureClient(HttpConfigOptions) - Method in class com.ibm.cloud.sdk.core.service.BaseService
Configures the currently-configured OkHttpClient instance based on the passed-in options.
configureClient(OkHttpClient, HttpConfigOptions) - Method in class com.ibm.cloud.sdk.core.http.HttpClientSingleton
Configures the specified OkHttpClient instance based on the passed-in options, and returns a new instance with the requested options applied.
configureService(String) - Method in class com.ibm.cloud.sdk.core.service.BaseService
 
CONFLICT - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
409 Conflict (HTTP/1.1 - RFC 2616).
ConflictException - Exception in com.ibm.cloud.sdk.core.service.exception
409 Conflict (HTTP/1.1 - RFC 2616).
ConflictException(Response) - Constructor for exception com.ibm.cloud.sdk.core.service.exception.ConflictException
Instantiates a new Forbidden Exception.
constructBasicAuthHeader(String, String) - Static method in class com.ibm.cloud.sdk.core.security.AuthenticatorBase
Returns a "Basic" Authorization header value for the specified username and password.
constructBearerTokenAuthHeader(String) - Static method in class com.ibm.cloud.sdk.core.security.AuthenticatorBase
Returns a "Bearer" Authorization header value for the specified bearer token.
constructHttpUrl(String, String[]) - Static method in class com.ibm.cloud.sdk.core.http.RequestBuilder
Creates a properly encoded HttpUrl object with no path parameters.
constructHttpUrl(String, String[], String[]) - Static method in class com.ibm.cloud.sdk.core.http.RequestBuilder
Creates a properly encoded HttpUrl object with path parameters.
constructServiceUrl(String, Map<String, String>, Map<String, String>) - Static method in class com.ibm.cloud.sdk.core.service.BaseService
Constructs a service URL by formatting a parameterized URL.
constructServiceURL(String, Map<String, String>, Map<String, String>) - Static method in class com.ibm.cloud.sdk.core.service.BaseService
Deprecated.
use constructServiceUrl() instead.
ContainerAuthenticator - Class in com.ibm.cloud.sdk.core.security
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 - Class in com.ibm.cloud.sdk.core.security
This Builder class is used to construct ContainerAuthenticator instances.
CONTENT_DISPOSITION - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
CONTENT_ENCODING - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
CONTENT_LANGUAGE - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
CONTENT_LENGTH - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
CONTENT_LOCATION - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
CONTENT_TYPE - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
contentType() - Method in class com.ibm.cloud.sdk.core.http.InputStreamRequestBody
 
contentType() - Method in class com.ibm.cloud.sdk.core.service.model.FileWithMetadata
The content type of file.
contentType(String) - Method in class com.ibm.cloud.sdk.core.service.model.FileWithMetadata.Builder
Set the contentType.
CONTINUE - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
100 Continue (HTTP/1.1 - RFC 2616).
convert(Response) - Method in interface com.ibm.cloud.sdk.core.http.ResponseConverter
Converts a response into a generic type to be defined.
COOKIE - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
Cp4dServiceInstanceTokenResponse - Class in com.ibm.cloud.sdk.core.security
This class models a response received from the CP4D "GET /zen-data/v3/service_instances/serviceInstanceId/token" operation.
Cp4dServiceInstanceTokenResponse() - Constructor for class com.ibm.cloud.sdk.core.security.Cp4dServiceInstanceTokenResponse
 
Cp4dServiceInstanceTokenResponse.Data - Class in com.ibm.cloud.sdk.core.security
 
Cp4dToken - Class in com.ibm.cloud.sdk.core.security
This class holds relevant info re: a CP4D access token for use by the CloudPakForDataAuthenticator class.
Cp4dToken() - Constructor for class com.ibm.cloud.sdk.core.security.Cp4dToken
 
Cp4dToken(Cp4dServiceInstanceTokenResponse) - Constructor for class com.ibm.cloud.sdk.core.security.Cp4dToken
This ctor will extract the ICP4D access token from the specified Cp4dTokenResponse instance, and compute the refresh time as "80% of the timeToLive added to the issued-at time".
Cp4dToken(Cp4dTokenResponse) - Constructor for class com.ibm.cloud.sdk.core.security.Cp4dToken
This ctor will extract the ICP4D access token from the specified Cp4dTokenResponse instance, and compute the refresh time as "80% of the timeToLive added to the issued-at time".
Cp4dToken(String) - Constructor for class com.ibm.cloud.sdk.core.security.Cp4dToken
This ctor is used to store a user-managed access token which will never expire.
Cp4dToken(Throwable) - Constructor for class com.ibm.cloud.sdk.core.security.Cp4dToken
This ctor is used to store an exception which indicates an error with the most recent token server interaction.
Cp4dTokenResponse - Class in com.ibm.cloud.sdk.core.security
This class models a response received from the CP4D "POST /v1/authorize" operation.
Cp4dTokenResponse() - Constructor for class com.ibm.cloud.sdk.core.security.Cp4dTokenResponse
 
create(Gson, TypeToken<T>) - Method in class com.ibm.cloud.sdk.core.util.DiscriminatorBasedTypeAdapterFactory
This method will return a TypeAdapter instance if the specified type is found to contain the expected discriminator metdata, or null otherwise.
create(Gson, TypeToken<T>) - Method in class com.ibm.cloud.sdk.core.util.DynamicModelTypeAdapterFactory
 
create(MediaType, InputStream) - Static method in class com.ibm.cloud.sdk.core.http.InputStreamRequestBody
Creates the @link RequestBody from an @link InputStream.
createAudioRaw(int) - Static method in class com.ibm.cloud.sdk.core.http.HttpMediaType
Creates an audio/l16 media type that includes sample rate.
CREATED - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
201 Created (HTTP/1.0 - RFC 1945).
createHttpClient() - Method in class com.ibm.cloud.sdk.core.http.HttpClientSingleton
Creates a new OkHttpClient instance with a new ServiceCookieJar and a default configuration.
createRetryInterceptor(int, int, Authenticator) - Method in class com.ibm.cloud.sdk.core.http.DefaultRetryStrategy
 
createRetryInterceptor(int, int, Authenticator) - Method in interface com.ibm.cloud.sdk.core.http.IRetryStrategy
Return an implementation of the IRetryInterceptor interface that is capable of retrying failed requests.
createSocket() - Method in class com.ibm.cloud.sdk.core.service.security.DelegatingSSLSocketFactory
 
createSocket(String, int) - Method in class com.ibm.cloud.sdk.core.service.security.DelegatingSSLSocketFactory
 
createSocket(String, int, InetAddress, int) - Method in class com.ibm.cloud.sdk.core.service.security.DelegatingSSLSocketFactory
 
createSocket(InetAddress, int) - Method in class com.ibm.cloud.sdk.core.service.security.DelegatingSSLSocketFactory
 
createSocket(InetAddress, int, InetAddress, int) - Method in class com.ibm.cloud.sdk.core.service.security.DelegatingSSLSocketFactory
 
createSocket(Socket, String, int, boolean) - Method in class com.ibm.cloud.sdk.core.service.security.DelegatingSSLSocketFactory
 
credentials - Variable in class com.ibm.cloud.sdk.core.util.CredentialUtils.VcapService
 
CredentialUtils - Class in com.ibm.cloud.sdk.core.util
CredentialUtils retrieves service credentials from the environment.
CredentialUtils.VcapCredentials - Class in com.ibm.cloud.sdk.core.util
This class is used to unmarshal the contents of the "credentials" field within a vcap service entry.
CredentialUtils.VcapService - Class in com.ibm.cloud.sdk.core.util
This class is used to unmarshal an item in the list of services belonging to a particular service key.
crTokenFilename(String) - Method in class com.ibm.cloud.sdk.core.security.ContainerAuthenticator.Builder
Sets the crTokenFilename property.

D

data() - Method in class com.ibm.cloud.sdk.core.service.model.FileWithMetadata
The data / contents of the file.
data(File) - Method in class com.ibm.cloud.sdk.core.service.model.FileWithMetadata.Builder
Set the data.
data(InputStream) - Method in class com.ibm.cloud.sdk.core.service.model.FileWithMetadata.Builder
Set the data.
Data() - Constructor for class com.ibm.cloud.sdk.core.security.Cp4dServiceInstanceTokenResponse.Data
 
DATE - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
DateTimeTypeAdapter - Class in com.ibm.cloud.sdk.core.util
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.
DateTimeTypeAdapter() - Constructor for class com.ibm.cloud.sdk.core.util.DateTimeTypeAdapter
 
DateTypeAdapter - Class in com.ibm.cloud.sdk.core.util
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.
DateTypeAdapter() - Constructor for class com.ibm.cloud.sdk.core.util.DateTypeAdapter
 
DateUtils - Class in com.ibm.cloud.sdk.core.util
This class contains utilities for formatting and parsing Date instances as OpenAPI "date" or "date-time" values.
decrementAndCheck() - Method in class com.ibm.cloud.sdk.core.http.ratelimit.RateLimitContext
Deprecated.
 
DEFAULT_INTERVAL - Static variable in interface com.ibm.cloud.sdk.core.http.ratelimit.RateLimitConstants
Deprecated.
Time to wait before retrying in absence of information from server.
DefaultRetryStrategy - Class in com.ibm.cloud.sdk.core.http
This is the java core's default retry strategy.
DefaultRetryStrategy() - Constructor for class com.ibm.cloud.sdk.core.http.DefaultRetryStrategy
 
DelegatingSSLSocketFactory - Class in com.ibm.cloud.sdk.core.service.security
A SSLSocketFactory that delegates calls.
DelegatingSSLSocketFactory(SSLSocketFactory) - Constructor for class com.ibm.cloud.sdk.core.service.security.DelegatingSSLSocketFactory
 
delete(HttpUrl) - Static method in class com.ibm.cloud.sdk.core.http.RequestBuilder
The DELETE method requests that the origin server delete the resource identified by the Request-URI.
disableRetries() - Method in class com.ibm.cloud.sdk.core.http.HttpConfigOptions.Builder
Sets the retry specific parameter to zero to disable the retry functionality.
disableRetries() - Method in class com.ibm.cloud.sdk.core.service.BaseService
Disables the retries for the HTTP requests.
disableSslVerification(boolean) - Method in class com.ibm.cloud.sdk.core.http.HttpConfigOptions.Builder
Sets flag to disable any SSL certificate verification during HTTP requests.
disableSSLVerification(boolean) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataAuthenticator.Builder
Sets the disableSSLVerification property.
disableSSLVerification(boolean) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator.Builder
Sets the disableSSLVerification property.
disableSSLVerification(boolean) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceInstanceAuthenticator.Builder
Sets the disableSSLVerification property.
disableSSLVerification(boolean) - Method in class com.ibm.cloud.sdk.core.security.ContainerAuthenticator.Builder
Sets the disableSSLVerification property.
disableSSLVerification(boolean) - Method in class com.ibm.cloud.sdk.core.security.IamAuthenticator.Builder
Sets the disableSSLVerification property.
disableSSLVerification(boolean) - Method in class com.ibm.cloud.sdk.core.security.MCSPAuthenticator.Builder
Sets the disableSSLVerification property.
DiscriminatorBasedTypeAdapterFactory - Class in com.ibm.cloud.sdk.core.util
This class is registered with Gson to perform deserialization of classes that have discriminator metadata defined in them.
DiscriminatorBasedTypeAdapterFactory() - Constructor for class com.ibm.cloud.sdk.core.util.DiscriminatorBasedTypeAdapterFactory
 
DiscriminatorBasedTypeAdapterFactory.Adapter<T> - Class in com.ibm.cloud.sdk.core.util
An adapter for serializing/deserializing instances of type T, where T represents a generated model that defines a discriminator to aid in deserialization.
displayName(String) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator.Builder
Sets the displayName property.
DynamicModel<T> - Class in com.ibm.cloud.sdk.core.service.model
Abstract model class for a model which supports dynamic (arbitrary) properties of type T.
DynamicModel(TypeToken<T>) - Constructor for class com.ibm.cloud.sdk.core.service.model.DynamicModel
This ctor accepts a TypeToken instance that represents the type of values stored in the map.
DynamicModelTypeAdapterFactory - Class in com.ibm.cloud.sdk.core.util
This class is registered with Gson to perform serialization and deserialization for dynamic model classes.
DynamicModelTypeAdapterFactory() - Constructor for class com.ibm.cloud.sdk.core.util.DynamicModelTypeAdapterFactory
 
DynamicModelTypeAdapterFactory.Adapter<T> - Class in com.ibm.cloud.sdk.core.util
An adapter for serializing/deserializing instances of type T, where T represents a generated dynamic model class which is a subclass of DynamicModel.

E

enableGzipCompression(boolean) - Method in class com.ibm.cloud.sdk.core.service.BaseService
Enables gzip compression of requests bodies for the current client.
enableGzipCompression(Boolean) - Method in class com.ibm.cloud.sdk.core.http.HttpConfigOptions.Builder
Sets flag to enable gzip compression of request bodies during HTTP requests.
enableRateLimitRetry(Authenticator, int, int) - Method in class com.ibm.cloud.sdk.core.http.HttpConfigOptions.Builder
Deprecated.
As of 9.13.0, use the HttpConfigOptions.enableRetries() instead.
enableRetries(int, int) - Method in class com.ibm.cloud.sdk.core.service.BaseService
Enables the retries for the HTTP requests.
enableRetries(Authenticator, int, int) - Method in class com.ibm.cloud.sdk.core.http.HttpConfigOptions.Builder
Sets retry specific parameters to enable it.
encode(String) - Static method in class com.ibm.cloud.sdk.core.util.RequestUtils
Encode a string into a valid URL string.
enqueue(ServiceCallback<T>) - Method in interface com.ibm.cloud.sdk.core.http.ServiceCall
Asynchronous request with added HTTP information.
EnvironmentUtils - Class in com.ibm.cloud.sdk.core.util
This is a utility class that contains methods related to environment variables.
equals(Object) - Method in class com.ibm.cloud.sdk.core.http.Headers
Returns true if other is a Headers object with the same headers, with the same casing, in the same order.
equals(Object) - Method in class com.ibm.cloud.sdk.core.http.NameValue
 
equals(Object) - Method in class com.ibm.cloud.sdk.core.service.model.DynamicModel
 
equals(Object) - Method in class com.ibm.cloud.sdk.core.service.model.GenericModel
 
equals(Object) - Method in interface com.ibm.cloud.sdk.core.service.model.ObjectModel
 
ERRORMSG_ATLEAST_ONE_PROP_ERROR - Static variable in class com.ibm.cloud.sdk.core.security.AuthenticatorBase
 
ERRORMSG_ATMOST_ONE_PROP_ERROR - Static variable in class com.ibm.cloud.sdk.core.security.AuthenticatorBase
 
ERRORMSG_AUTHTYPE_UNKNOWN - Static variable in class com.ibm.cloud.sdk.core.security.ConfigBasedAuthenticatorFactory
 
ERRORMSG_EXCLUSIVE_PROP_ERROR - Static variable in class com.ibm.cloud.sdk.core.security.AuthenticatorBase
 
ERRORMSG_PROP_INVALID - Static variable in class com.ibm.cloud.sdk.core.security.AuthenticatorBase
 
ERRORMSG_PROP_INVALID_INTEGER_VALUE - Static variable in class com.ibm.cloud.sdk.core.security.AuthenticatorBase
 
ERRORMSG_PROP_MISSING - Static variable in class com.ibm.cloud.sdk.core.security.AuthenticatorBase
Common error messages.
ERRORMSG_REQ_FAILED - Static variable in class com.ibm.cloud.sdk.core.security.AuthenticatorBase
 
ETAG - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
execute() - Method in interface com.ibm.cloud.sdk.core.http.ServiceCall
Synchronous request.
EXPECTATION_FAILED - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
417 Expectation Failed (HTTP/1.1 - RFC 2616).
expirationTime(String) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator.Builder
Sets the expirationTime property.
EXPIRES - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders

F

FACTORY - Static variable in class com.ibm.cloud.sdk.core.util.DateTimeTypeAdapter
 
FACTORY - Static variable in class com.ibm.cloud.sdk.core.util.DateTypeAdapter
 
FAILED_DEPENDENCY - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
424 Failed Dependency (WebDAV - RFC 2518).
fileBody(File, String) - Static method in class com.ibm.cloud.sdk.core.util.RequestUtils
Returns a request body that encapsulates the specified file qualified with the specified content type.
filename() - Method in class com.ibm.cloud.sdk.core.service.model.FileWithMetadata
The filename for file.
filename(String) - Method in class com.ibm.cloud.sdk.core.service.model.FileWithMetadata.Builder
Set the filename.
FileWithMetadata - Class in com.ibm.cloud.sdk.core.service.model
A file and its associated metadata.
FileWithMetadata.Builder - Class in com.ibm.cloud.sdk.core.service.model
Builder.
FORBIDDEN - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
403 Forbidden (HTTP/1.0 - RFC 1945).
ForbiddenException - Exception in com.ibm.cloud.sdk.core.service.exception
403 Forbidden (HTTP/1.0 - RFC 1945).
ForbiddenException(Response) - Constructor for exception com.ibm.cloud.sdk.core.service.exception.ForbiddenException
Instantiates a new Forbidden Exception.
form(Object...) - Method in class com.ibm.cloud.sdk.core.http.RequestBuilder
Adds form parameters.
formatAsDate(Date) - Static method in class com.ibm.cloud.sdk.core.util.DateUtils
Formats the specified Date instance as an RFC 3339 "full-date" value (yyyy-MM-dd).
The Date instance is assumed to represent the start of the specified day in UTC time.
formatAsDateTime(Date) - Static method in class com.ibm.cloud.sdk.core.util.DateUtils
Formats the specified Date instance as an RFC 3339 "date-time" value (a string of the form "yyyy-MM-dd'T'HH:mm:ss.SSSZ").
The Date instance represents a moment in time (the number of milliseconds since epoch time in UTC).
fromConfiguration(Map<String, String>) - Static method in class com.ibm.cloud.sdk.core.security.BasicAuthenticator
Construct a BasicAuthenticator instance using properties retrieved from the specified Map.
fromConfiguration(Map<String, String>) - Static method in class com.ibm.cloud.sdk.core.security.BearerTokenAuthenticator
Construct a BearerTokenAuthenticator instance using properties retrieved from the specified Map.
fromConfiguration(Map<String, String>) - Static method in class com.ibm.cloud.sdk.core.security.CloudPakForDataAuthenticator
Construct a CloudPakForDataAuthenticator instance using properties retrieved from the specified Map.
fromConfiguration(Map<String, String>) - Static method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator
Construct a CloudPakForDataServiceAuthenticator instance using properties retrieved from the specified Map.
fromConfiguration(Map<String, String>) - Static method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceInstanceAuthenticator
Construct a CloudPakForDataServiceInstanceAuthenticator instance using properties retrieved from the specified Map.
fromConfiguration(Map<String, String>) - Static method in class com.ibm.cloud.sdk.core.security.ContainerAuthenticator
Constructs a ContainerAuthenticator instance using properties contained in the specified Map.
fromConfiguration(Map<String, String>) - Static method in class com.ibm.cloud.sdk.core.security.IamAuthenticator
Construct a IamAuthenticator instance using properties retrieved from the specified Map.
fromConfiguration(Map<String, String>) - Static method in class com.ibm.cloud.sdk.core.security.MCSPAuthenticator
Construct an MCSPAuthenticator instance using properties retrieved from "config".
fromConfiguration(Map<String, String>) - Static method in class com.ibm.cloud.sdk.core.security.VpcInstanceAuthenticator
Constructs a ContainerAuthenticator instance using properties contained in the specified Map.

G

GATEWAY_TIMEOUT - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
504 Gateway Timeout (HTTP/1.1 - RFC 2616).
GenericModel - Class in com.ibm.cloud.sdk.core.service.model
Abstract model class to provide a default toString() method in model classes.
GenericModel() - Constructor for class com.ibm.cloud.sdk.core.service.model.GenericModel
 
get(String) - Method in class com.ibm.cloud.sdk.core.service.model.DynamicModel
Returns the value of the specified property.
get(HttpUrl) - Static method in class com.ibm.cloud.sdk.core.http.RequestBuilder
The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI.
get_messageCode_() - Method in class com.ibm.cloud.sdk.core.security.Cp4dTokenResponse
 
getAccessToken() - Method in class com.ibm.cloud.sdk.core.security.AbstractToken
 
getAccessToken() - Method in class com.ibm.cloud.sdk.core.security.Cp4dToken
 
getAccessToken() - Method in class com.ibm.cloud.sdk.core.security.IamToken
 
getAccessToken() - Method in class com.ibm.cloud.sdk.core.security.MCSPToken
 
getAccessToken() - Method in class com.ibm.cloud.sdk.core.security.VpcTokenResponse
Gets the accessToken.
getAdditionalPropertyTypeToken() - Method in class com.ibm.cloud.sdk.core.service.model.DynamicModel
Returns the TypeToken which describes the type of additional properties stored in the map.
getApikey() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataAuthenticator
 
getApikey() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceInstanceAuthenticator
 
getApiKey() - Method in class com.ibm.cloud.sdk.core.security.IamAuthenticator
 
getApiKey() - Method in class com.ibm.cloud.sdk.core.security.MCSPAuthenticator
 
getAudience() - Method in class com.ibm.cloud.sdk.core.security.JsonWebToken.Payload
Returns the "Audience" ("aud") value with this JsonWebToken.
getAuthenticator() - Method in class com.ibm.cloud.sdk.core.http.HttpConfigOptions
 
getAuthenticator() - Method in class com.ibm.cloud.sdk.core.service.BaseService
Returns the Authenticator instance currently set on this BaseService instance.
getAuthenticator(String) - Static method in class com.ibm.cloud.sdk.core.security.ConfigBasedAuthenticatorFactory
Retrieves authentication configuration information for the specified cloud service, and returns an Authenticator instance, or null if the configuration information could not be found.
getBearerToken() - Method in class com.ibm.cloud.sdk.core.security.BearerTokenAuthenticator
 
getClient() - Method in class com.ibm.cloud.sdk.core.security.TokenRequestBasedAuthenticator
Returns the OkHttpClient instance to be used when interacting with the token service.
getClient() - Method in class com.ibm.cloud.sdk.core.service.BaseService
Returns the currently-configured OkHttpClient instance.
getClientId() - Method in class com.ibm.cloud.sdk.core.security.IamRequestBasedAuthenticator
 
getClientSecret() - Method in class com.ibm.cloud.sdk.core.security.IamRequestBasedAuthenticator
 
getCreatedAt() - Method in class com.ibm.cloud.sdk.core.security.VpcTokenResponse
Gets the createdAt.
getCrTokenFilename() - Method in class com.ibm.cloud.sdk.core.security.ContainerAuthenticator
 
getCurrentTimeInMillis() - Static method in class com.ibm.cloud.sdk.core.util.Clock
 
getCurrentTimeInSeconds() - Static method in class com.ibm.cloud.sdk.core.util.Clock
 
getData() - Method in class com.ibm.cloud.sdk.core.security.Cp4dServiceInstanceTokenResponse
 
getDebuggingInfo() - Method in exception com.ibm.cloud.sdk.core.service.exception.ServiceResponseException
Gets the response information other than the error message.
getDefaultCipherSuites() - Method in class com.ibm.cloud.sdk.core.service.security.DelegatingSSLSocketFactory
 
getDefaultHeaders() - Method in class com.ibm.cloud.sdk.core.service.BaseService
Returns the set of default headers current set on this BaseService instance.
getDefaultRetryInterval() - Method in class com.ibm.cloud.sdk.core.http.HttpConfigOptions
Deprecated.
As of 9.13.0, use HttpConfigOptions.getMaxRetryInterval() instead.
getDisableSSLVerification() - Method in class com.ibm.cloud.sdk.core.security.TokenRequestBasedAuthenticator
 
getDisplayName() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator
 
getEndPoint() - Method in class com.ibm.cloud.sdk.core.service.BaseService
Deprecated.
Use getServiceURL() instead.
getenv() - Static method in class com.ibm.cloud.sdk.core.util.EnvironmentUtils
Wrapper around System.getenv()) to allow us to mock it during testing.
getenv(String) - Static method in class com.ibm.cloud.sdk.core.util.EnvironmentUtils
Wrapper around System.getenv(String) to allow us to mock it during testing.
getException() - Method in class com.ibm.cloud.sdk.core.security.AbstractToken
 
getExpiration() - Method in class com.ibm.cloud.sdk.core.security.IamToken
 
getExpirationTime() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator
 
getExpiresAt() - Method in class com.ibm.cloud.sdk.core.security.JsonWebToken.Payload
Returns the "Expires At" ("exp") value within this JsonWebToken.
getExpiresAt() - Method in class com.ibm.cloud.sdk.core.security.VpcTokenResponse
Gets the expiresAt.
getExpiresIn() - Method in class com.ibm.cloud.sdk.core.security.IamToken
 
getExpiresIn() - Method in class com.ibm.cloud.sdk.core.security.MCSPTokenResponse
 
getExpiresIn() - Method in class com.ibm.cloud.sdk.core.security.VpcTokenResponse
Gets the expiresIn.
getGenericObject(Type, String) - Static method in class com.ibm.cloud.sdk.core.util.ResponseConverterUtils
Creates a generic ResponseConverter for a generic class.
getGson() - Static method in class com.ibm.cloud.sdk.core.util.GsonSingleton
Gets the Gson instance.
getGsonWithoutPrettyPrinting() - Static method in class com.ibm.cloud.sdk.core.util.GsonSingleton
Gets the Gson instance.
getGsonWithSerializeNulls() - Static method in class com.ibm.cloud.sdk.core.util.GsonSingleton
Returns an instance of Gson with the "serialize nulls" config option enabled.
getGzipCompression() - Method in class com.ibm.cloud.sdk.core.http.HttpConfigOptions
 
getHeader() - Method in class com.ibm.cloud.sdk.core.security.JsonWebToken
 
getHeaders() - Method in class com.ibm.cloud.sdk.core.http.Response
 
getHeaders() - Method in class com.ibm.cloud.sdk.core.security.TokenRequestBasedAuthenticator
Returns the set of user-supplied headers configured for this Authenticator.
getHeaders() - Method in exception com.ibm.cloud.sdk.core.service.exception.ServiceResponseException
Gets the headers.
getHttpClient() - Method in class com.ibm.cloud.sdk.core.http.HttpClientSingleton
Returns the current OkHttpClient instance held by this singleton.
getIamProfileCrn() - Method in class com.ibm.cloud.sdk.core.security.VpcInstanceAuthenticator
 
getIamProfileId() - Method in class com.ibm.cloud.sdk.core.security.ContainerAuthenticator
 
getIamProfileId() - Method in class com.ibm.cloud.sdk.core.security.VpcInstanceAuthenticator
 
getIamProfileName() - Method in class com.ibm.cloud.sdk.core.security.ContainerAuthenticator
 
getInputStream() - Static method in class com.ibm.cloud.sdk.core.util.ResponseConverterUtils
Creates an InputStream converter.
getInputStream(Response) - Static method in class com.ibm.cloud.sdk.core.util.ResponseUtils
Returns the HTTP Response InputStream.
getInstance() - Static method in class com.ibm.cloud.sdk.core.http.HttpClientSingleton
Gets the single instance of HttpClientSingleton.
getIssuedAt() - Method in class com.ibm.cloud.sdk.core.security.JsonWebToken.Payload
Returns the "Issued At" ("iat") value within this JsonWebToken.
getIssuer() - Method in class com.ibm.cloud.sdk.core.security.JsonWebToken.Payload
Returns the "Issuer" ("iss") value with this JsonWebToken.
getJsonElement(Response) - Static method in class com.ibm.cloud.sdk.core.util.ResponseUtils
Return a JsonElement representation of the response.
getJsonObject(String) - Static method in class com.ibm.cloud.sdk.core.util.ResponseUtils
Returns a JsonObject representation of the provided JSON String.
getJsonObject(Response) - Static method in class com.ibm.cloud.sdk.core.util.ResponseUtils
Returns a JsonObject representation of the response.
getLoggingInterceptor() - Static method in class com.ibm.cloud.sdk.core.util.HttpLogging
Deprecated.
 
getLoggingLevel() - Method in class com.ibm.cloud.sdk.core.http.HttpConfigOptions
 
getMapValueType(T) - Method in class com.ibm.cloud.sdk.core.util.DynamicModelTypeAdapterFactory.Adapter
Returns a TypeToken which represents the type of values stored in the DynamicModel's inherited map.
getMaxRetries() - Method in class com.ibm.cloud.sdk.core.http.HttpConfigOptions
 
getMaxRetryInterval() - Method in class com.ibm.cloud.sdk.core.http.HttpConfigOptions
 
getMessage() - Method in class com.ibm.cloud.sdk.core.security.Cp4dServiceInstanceTokenResponse
 
getMessage() - Method in class com.ibm.cloud.sdk.core.security.Cp4dTokenResponse
 
getMessage() - Method in exception com.ibm.cloud.sdk.core.service.exception.ServiceResponseException
Gets the error message.
getMessageCode() - Method in class com.ibm.cloud.sdk.core.security.Cp4dServiceInstanceTokenResponse
 
getName() - Method in class com.ibm.cloud.sdk.core.http.NameValue
Gets the name.
getName() - Method in class com.ibm.cloud.sdk.core.service.BaseService
Gets the name.
getObject(Class<? extends T>) - Static method in class com.ibm.cloud.sdk.core.util.ResponseConverterUtils
Creates a generic ResponseConverter for a POJO class that extends ObjectModel.
getObject(Type) - Static method in class com.ibm.cloud.sdk.core.util.ResponseConverterUtils
Creates a generic ResponseConverter for a POJO class.
getObject(Response, Class<? extends T>) - Static method in class com.ibm.cloud.sdk.core.util.ResponseUtils
Parses the Response into the POJO representation.
getObject(Response, Type) - Static method in class com.ibm.cloud.sdk.core.util.ResponseUtils
Parses the Response into the POJO representation.
getPassword() - Method in class com.ibm.cloud.sdk.core.security.BasicAuthenticator
 
getPassword() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataAuthenticator
 
getPassword() - Method in class com.ibm.cloud.sdk.core.security.IamAuthenticator
Deprecated.
As of 9.7.0, use getClientSecret() instead
getPayload() - Method in class com.ibm.cloud.sdk.core.security.JsonWebToken
 
getPermissions() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator
 
getProperties() - Method in class com.ibm.cloud.sdk.core.service.model.DynamicModel
Returns a map containing the arbitrary properties set on this object.
getPropertyNames() - Method in class com.ibm.cloud.sdk.core.service.model.DynamicModel
Returns the names of arbitrary properties set on this object.
getProxy() - Method in class com.ibm.cloud.sdk.core.http.HttpConfigOptions
 
getProxy() - Method in class com.ibm.cloud.sdk.core.security.TokenRequestBasedAuthenticator
 
getProxyAuthenticator() - Method in class com.ibm.cloud.sdk.core.http.HttpConfigOptions
 
getProxyAuthenticator() - Method in class com.ibm.cloud.sdk.core.security.TokenRequestBasedAuthenticator
 
getQueryParam(String, String) - Static method in class com.ibm.cloud.sdk.core.util.UrlHelper
Returns the value of query parameter `param` from urlStr, or null when not found.
getRefreshTime() - Method in class com.ibm.cloud.sdk.core.security.IamToken
 
getRefreshToken() - Method in class com.ibm.cloud.sdk.core.security.IamToken
 
getResponseBody() - Method in exception com.ibm.cloud.sdk.core.service.exception.ServiceResponseException
Gets the error response body as a string.
getResult() - Method in class com.ibm.cloud.sdk.core.http.Response
 
getRetries() - Method in class com.ibm.cloud.sdk.core.http.HttpConfigOptions
 
getRole() - Method in class com.ibm.cloud.sdk.core.security.JsonWebToken.Payload
Returns the "Role" ("role") value with this JsonWebToken.
getScope() - Method in class com.ibm.cloud.sdk.core.security.IamRequestBasedAuthenticator
 
getServiceBrokerSecret() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator
 
getServiceInstanceId() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceInstanceAuthenticator
 
getServiceProperties(String) - Static method in class com.ibm.cloud.sdk.core.util.CredentialUtils
This function will retrieve configuration properties for the specified service from the following external config sources (in priority order): 1) Credential file 2) Environment variables 3) VCAP_SERVICES 4) System properties The properties are returned in a Map.
getServiceUrl() - Method in class com.ibm.cloud.sdk.core.service.BaseService
Returns the service URL value associated with this service instance.
getStatusCode() - Method in class com.ibm.cloud.sdk.core.http.Response
 
getStatusCode() - Method in exception com.ibm.cloud.sdk.core.service.exception.ServiceResponseException
Gets the HTTP status code.
getStatusMessage() - Method in class com.ibm.cloud.sdk.core.http.Response
 
getString() - Static method in class com.ibm.cloud.sdk.core.util.ResponseConverterUtils
Creates a generic ResponseConverter for a String response.
getString(Response) - Static method in class com.ibm.cloud.sdk.core.util.ResponseUtils
Returns a String representation of the response.
getSubject() - Method in class com.ibm.cloud.sdk.core.security.JsonWebToken.Payload
Returns the "Subject" ("sub") value with this JsonWebToken.
getSupportedCipherSuites() - Method in class com.ibm.cloud.sdk.core.service.security.DelegatingSSLSocketFactory
 
getSystemInfo() - Static method in class com.ibm.cloud.sdk.core.util.RequestUtils
Returns the "system info" which consists of the values of system properties whose names are contained in the "properties" list defined above.
getToken() - Method in class com.ibm.cloud.sdk.core.security.Cp4dServiceInstanceTokenResponse.Data
 
getToken() - Method in class com.ibm.cloud.sdk.core.security.Cp4dTokenResponse
 
getToken() - Method in class com.ibm.cloud.sdk.core.security.MCSPTokenResponse
 
getToken() - Method in class com.ibm.cloud.sdk.core.security.TokenRequestBasedAuthenticator
This function returns the access token fetched from the token service.
getTokenType() - Method in class com.ibm.cloud.sdk.core.security.IamToken
 
getTokenType() - Method in class com.ibm.cloud.sdk.core.security.MCSPTokenResponse
 
getUid() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator
 
getURL() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataAuthenticator
 
getURL() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator
 
getURL() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceInstanceAuthenticator
 
getURL() - Method in class com.ibm.cloud.sdk.core.security.IamRequestBasedAuthenticator
 
getURL() - Method in class com.ibm.cloud.sdk.core.security.MCSPAuthenticator
 
getURL() - Method in class com.ibm.cloud.sdk.core.security.VpcInstanceAuthenticator
 
getUserAgent() - Static method in class com.ibm.cloud.sdk.core.util.RequestUtils
Gets the user agent.
getUserId() - Method in class com.ibm.cloud.sdk.core.security.JsonWebToken.Payload
Returns the "Userid" ("uid") value with this JsonWebToken.
getUsername() - Method in class com.ibm.cloud.sdk.core.security.BasicAuthenticator
 
getUsername() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataAuthenticator
 
getUsername() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator
 
getUsername() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceInstanceAuthenticator
 
getUsername() - Method in class com.ibm.cloud.sdk.core.security.IamAuthenticator
Deprecated.
As of 9.7.0, use getClientId() instead
getUsername() - Method in class com.ibm.cloud.sdk.core.security.JsonWebToken.Payload
Returns the "Username" ("username") value with this JsonWebToken.
getValue() - Method in class com.ibm.cloud.sdk.core.http.NameValue
Gets the value.
getValue(Class<? extends T>) - Static method in class com.ibm.cloud.sdk.core.util.ResponseConverterUtils
Creates a generic ResponseConverter for a non-object response.
getValue(Type) - Static method in class com.ibm.cloud.sdk.core.util.ResponseConverterUtils
Creates a generic ResponseConverter for a response with a Type instance that describes the type.
getValue(Response, Class<? extends T>) - Static method in class com.ibm.cloud.sdk.core.util.ResponseUtils
Parses the Response into a value of the specified type.
getValue(Response, Type) - Static method in class com.ibm.cloud.sdk.core.util.ResponseUtils
Parses the Response into a value of the specified type.
getVcapServicesObj() - Static method in class com.ibm.cloud.sdk.core.util.CredentialUtils
Retrieves the VCAP_SERVICES environment variable and unmarshals it.
getVoid() - Static method in class com.ibm.cloud.sdk.core.util.ResponseConverterUtils
Gets the void converter.
GONE - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
410 Gone (HTTP/1.1 - RFC 2616).
GsonSerializationHelper - Class in com.ibm.cloud.sdk.core.util
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 - Class in com.ibm.cloud.sdk.core.util
Gson singleton to be use when transforming from JSON to Java Objects and vise versa.
GzipRequestInterceptor - Class in com.ibm.cloud.sdk.core.http.gzip
This interceptor compresses the HTTP request body.
GzipRequestInterceptor() - Constructor for class com.ibm.cloud.sdk.core.http.gzip.GzipRequestInterceptor
 

H

hasBadStartOrEndChar(String) - Static method in class com.ibm.cloud.sdk.core.util.CredentialUtils
Returns true if the supplied value begins or ends with curly brackets or quotation marks.
hashCode() - Method in class com.ibm.cloud.sdk.core.http.Headers
 
hashCode() - Method in class com.ibm.cloud.sdk.core.http.NameValue
 
hashCode() - Method in class com.ibm.cloud.sdk.core.service.model.DynamicModel
 
hashCode() - Method in class com.ibm.cloud.sdk.core.service.model.GenericModel
 
hashCode() - Method in interface com.ibm.cloud.sdk.core.service.model.ObjectModel
 
head(HttpUrl) - Static method in class com.ibm.cloud.sdk.core.http.RequestBuilder
The HEAD method means retrieve the headers for the resource identified by the Request-URI.
header(Object...) - Method in class com.ibm.cloud.sdk.core.http.RequestBuilder
Adds header parameters.
headers(Map<String, String>) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataAuthenticator.Builder
Sets the headers property.
headers(Map<String, String>) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator.Builder
Sets the headers property.
headers(Map<String, String>) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceInstanceAuthenticator.Builder
Sets the headers property.
headers(Map<String, String>) - Method in class com.ibm.cloud.sdk.core.security.ContainerAuthenticator.Builder
Sets the headers property.
headers(Map<String, String>) - Method in class com.ibm.cloud.sdk.core.security.IamAuthenticator.Builder
Sets the headers property.
headers(Map<String, String>) - Method in class com.ibm.cloud.sdk.core.security.MCSPAuthenticator.Builder
Sets the headers property.
Headers - Class in com.ibm.cloud.sdk.core.http
Wrapper class for the internal HTTP headers class.
Headers(Headers) - Constructor for class com.ibm.cloud.sdk.core.http.Headers
 
HEADERS - com.ibm.cloud.sdk.core.http.HttpConfigOptions.LoggingLevel
 
HOST - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
HTTP_VERSION_NOT_SUPPORTED - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
505 HTTP Version Not Supported (HTTP/1.1 - RFC 2616).
HttpClientSingleton - Class in com.ibm.cloud.sdk.core.http
This class encapsulate the OkHttpClient instance in a singleton pattern.
HttpConfigOptions - Class in com.ibm.cloud.sdk.core.http
Options class for configuring the HTTP client.
HttpConfigOptions.Builder - Class in com.ibm.cloud.sdk.core.http
 
HttpConfigOptions.LoggingLevel - Enum in com.ibm.cloud.sdk.core.http
Levels of information to log when making HTTP requests, from least (NONE) to most (BODY).
HttpHeaders - Interface in com.ibm.cloud.sdk.core.http
HTTP constant headers.
HttpLogging - Class in com.ibm.cloud.sdk.core.util
Deprecated.
This class functionality is now handled by HttpConfigOptions and should no longer be needed.
HttpMediaType - Class in com.ibm.cloud.sdk.core.http
An abstraction for a media type.
HttpStatus - Interface in com.ibm.cloud.sdk.core.http
Constants enumerating the HTTP status codes.

I

iamApiKey - Variable in class com.ibm.cloud.sdk.core.util.CredentialUtils.VcapCredentials
 
iamApikeyDescription - Variable in class com.ibm.cloud.sdk.core.util.CredentialUtils.VcapCredentials
 
iamApikeyName - Variable in class com.ibm.cloud.sdk.core.util.CredentialUtils.VcapCredentials
 
IamAuthenticator - Class in com.ibm.cloud.sdk.core.security
This class provides an Authenticator implementation for IAM (Identity and Access Management).
IamAuthenticator(String) - Constructor for class com.ibm.cloud.sdk.core.security.IamAuthenticator
Deprecated.
As of 9.7.0, use IamAuthenticator.Builder() instead
IamAuthenticator(String, String, String, String, boolean, Map<String, String>) - Constructor for class com.ibm.cloud.sdk.core.security.IamAuthenticator
Deprecated.
As of 9.7.0, use IamAuthenticator.Builder() instead
IamAuthenticator(String, String, String, String, boolean, Map<String, String>, String) - Constructor for class com.ibm.cloud.sdk.core.security.IamAuthenticator
Deprecated.
As of 9.7.0, use IamAuthenticator.Builder() instead
IamAuthenticator(Map<String, String>) - Constructor for class com.ibm.cloud.sdk.core.security.IamAuthenticator
Deprecated.
As of 9.7.0, use IamAuthenticator.Builder() instead
IamAuthenticator.Builder - Class in com.ibm.cloud.sdk.core.security
This Builder class is used to construct IamAuthenticator instances.
IamExpirationWindow - Static variable in class com.ibm.cloud.sdk.core.security.IamToken
 
iamProfileCrn(String) - Method in class com.ibm.cloud.sdk.core.security.VpcInstanceAuthenticator.Builder
Sets the iamProfileCrn property.
iamProfileId(String) - Method in class com.ibm.cloud.sdk.core.security.ContainerAuthenticator.Builder
Sets the iamProfileId property.
iamProfileId(String) - Method in class com.ibm.cloud.sdk.core.security.VpcInstanceAuthenticator.Builder
Sets the iamProfileId property.
iamProfileName(String) - Method in class com.ibm.cloud.sdk.core.security.ContainerAuthenticator.Builder
Sets the iamProfileName property.
IamRequestBasedAuthenticator - Class in com.ibm.cloud.sdk.core.security
This class contains code that is common to all authenticators that need to interact with the IAM tokens service to obtain an access token.
IamRequestBasedAuthenticator() - Constructor for class com.ibm.cloud.sdk.core.security.IamRequestBasedAuthenticator
 
iamRoleCrn - Variable in class com.ibm.cloud.sdk.core.util.CredentialUtils.VcapCredentials
 
iamServiceCrn - Variable in class com.ibm.cloud.sdk.core.util.CredentialUtils.VcapCredentials
 
IamToken - Class in com.ibm.cloud.sdk.core.security
Represents response from IAM API.
IamToken() - Constructor for class com.ibm.cloud.sdk.core.security.IamToken
 
IamToken(VpcTokenResponse) - Constructor for class com.ibm.cloud.sdk.core.security.IamToken
Converts a VpcTokenResponse instance to an IamToken instance.
IamToken(Throwable) - Constructor for class com.ibm.cloud.sdk.core.security.IamToken
 
iamUrl - Variable in class com.ibm.cloud.sdk.core.util.CredentialUtils.VcapCredentials
 
IF_MATCH - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
IF_MODIFIED_SINCE - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
IF_NONE_MATCH - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
IF_UNMODIFIED_SINCE - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
inputStreamBody(InputStream, String) - Static method in class com.ibm.cloud.sdk.core.util.RequestUtils
Returns a request body the encapsulates the specified input stream qualified with the specified content type.
InputStreamRequestBody - Class in com.ibm.cloud.sdk.core.http
RequestBody that takes an InputStream.
INSUFFICIENT_STORAGE - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
507 Insufficient Storage (WebDAV - RFC 2518).
intercept(Interceptor.Chain) - Method in class com.ibm.cloud.sdk.core.http.gzip.GzipRequestInterceptor
 
intercept(Interceptor.Chain) - Method in class com.ibm.cloud.sdk.core.http.ratelimit.RateLimitInterceptor
Deprecated.
Checks response and retries with delay in case of a 429, time between attempts is taken from response, if no valid information is on the response, the default is used.
intercept(Interceptor.Chain) - Method in class com.ibm.cloud.sdk.core.http.RetryInterceptor
The "intercept()" method is the primary method of the interceptor.
INTERNAL_SERVER_ERROR - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
500 Server Error (HTTP/1.0 - RFC 1945).
InternalServerErrorException - Exception in com.ibm.cloud.sdk.core.service.exception
500 Server Error (HTTP/1.0 - RFC 1945).
InternalServerErrorException(Response) - Constructor for exception com.ibm.cloud.sdk.core.service.exception.InternalServerErrorException
Instantiates a new Internal Server Error Exception.
InvalidServiceResponseException - Exception in com.ibm.cloud.sdk.core.service.exception
This exception class represents an invalid response body received from the server.
InvalidServiceResponseException(Response, String, Throwable) - Constructor for exception com.ibm.cloud.sdk.core.service.exception.InvalidServiceResponseException
Instantiates a new exception that indicates a failure while processing the response received from the server for an otherwise successful operation.
IRetryInterceptor - Interface in com.ibm.cloud.sdk.core.http
This is a marker interface used to identify retry interceptor implementations within the java core library.
IRetryStrategy - Interface in com.ibm.cloud.sdk.core.http
IRetryStrategy is an interface that is implemented by retry interceptor factories.
isJsonMimeType(String) - Static method in class com.ibm.cloud.sdk.core.service.BaseService
Returns true iff the specified mimeType indicates a JSON-related content type.
isJsonPatchMimeType(String) - Static method in class com.ibm.cloud.sdk.core.service.BaseService
Returns true iff the specified mimeType indicates a "Json Patch"-related content type.
isNull(Object, String) - Static method in class com.ibm.cloud.sdk.core.util.Validator
Validates that the specified argument is null; otherwise throwing an exception with the specified message.
isTokenValid() - Method in class com.ibm.cloud.sdk.core.security.AbstractToken
 
isTokenValid() - Method in class com.ibm.cloud.sdk.core.security.Cp4dToken
Check if the currently stored access token is valid.
isTokenValid() - Method in class com.ibm.cloud.sdk.core.security.IamToken
Check if the currently stored access token is valid.
isTokenValid() - Method in class com.ibm.cloud.sdk.core.security.MCSPToken
Check if the currently stored access token is valid.
isTrue(boolean, String) - Static method in class com.ibm.cloud.sdk.core.util.Validator
Validates that the argument condition is true; otherwise throwing an exception with the specified message.

J

join(Iterable<?>, String) - Static method in class com.ibm.cloud.sdk.core.util.RequestUtils
Creates a String of all elements of an iterable, separated by a separator.
join(T[], String) - Static method in class com.ibm.cloud.sdk.core.util.RequestUtils
Creates a String of all elements of an array, separated by a separator.
JSON - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field JSON.
JsonWebToken - Class in com.ibm.cloud.sdk.core.security
This class is used to decode and parse a JWT (Json Web Token).
JsonWebToken(String) - Constructor for class com.ibm.cloud.sdk.core.security.JsonWebToken
Ctor which accepts the encoded JWT as a string.
JsonWebToken.Payload - Class in com.ibm.cloud.sdk.core.security
 

L

label - Variable in class com.ibm.cloud.sdk.core.util.CredentialUtils.VcapService
 
LAST_MODIFIED - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
LAZILY_PARSED_NUMBER_ADAPTER - Static variable in class com.ibm.cloud.sdk.core.util.GsonSingleton
 
LENGTH_REQUIRED - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
411 Length Required (HTTP/1.1 - RFC 2616).
loadForRequest(HttpUrl) - Method in class com.ibm.cloud.sdk.core.http.ServiceCookieJar
 
LOCATION - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
LOCKED - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
423 Locked (WebDAV - RFC 2518).
loggingLevel(HttpConfigOptions.LoggingLevel) - Method in class com.ibm.cloud.sdk.core.http.HttpConfigOptions.Builder
Sets HTTP logging level to be used by the current client.
LongToDateTypeAdapter - Class in com.ibm.cloud.sdk.core.util
This TypeAdapter converts unix timestamps (in numeric or String form) to Java Dates and vice versa.
LongToDateTypeAdapter() - Constructor for class com.ibm.cloud.sdk.core.util.LongToDateTypeAdapter
 

M

MapValueObjectTypeAdapter - Class in com.ibm.cloud.sdk.core.util
This class is adapted from the ObjectTypeAdapter from the GSON project.
MAX_RETRIES - Static variable in interface com.ibm.cloud.sdk.core.http.ratelimit.RateLimitConstants
Deprecated.
Maximum amount of times a request will be retried.
MCSPAuthenticator - Class in com.ibm.cloud.sdk.core.security
This class provides an Authenticator implementation for the Multi-Cloud Saas Platform (MCSP) environment.
MCSPAuthenticator.Builder - Class in com.ibm.cloud.sdk.core.security
This Builder class is used to construct MCSPAuthenticator instances.
MCSPToken - Class in com.ibm.cloud.sdk.core.security
This class holds the cached information related to an access token received by the Multi-Cloud Saas Platform (MCSP) Authenticator.
MCSPToken() - Constructor for class com.ibm.cloud.sdk.core.security.MCSPToken
 
MCSPToken(MCSPTokenResponse) - Constructor for class com.ibm.cloud.sdk.core.security.MCSPToken
This ctor will extract the access token from the specified MCSPTokenResponse instance, and compute the refresh time as "80% of the timeToLive added to the issued-at time".
MCSPToken(String) - Constructor for class com.ibm.cloud.sdk.core.security.MCSPToken
This ctor is used to store a user-managed access token which will never expire.
MCSPToken(Throwable) - Constructor for class com.ibm.cloud.sdk.core.security.MCSPToken
This ctor is used to store an exception which indicates an error with the most recent token server interaction.
MCSPTokenResponse - Class in com.ibm.cloud.sdk.core.security
This class models a response received from the Multi-Cloud Saas Platform token server's "POST /siusermgr/api/1.0/apikeys/token" operation.
MCSPTokenResponse() - Constructor for class com.ibm.cloud.sdk.core.security.MCSPTokenResponse
 
MEDIA_TYPE_WILDCARD - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field MEDIA_TYPE_WILDCARD.
METHOD_NOT_ALLOWED - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
405 Method Not Allowed (HTTP/1.1 - RFC 2616).
MOVED_PERMANENTLY - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
301 Moved Permanently (HTTP/1.0 - RFC 1945).
MOVED_TEMPORARILY - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
302 Moved Temporarily (Sometimes Found) (HTTP/1.0 - RFC 1945).
MULTI_STATUS - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
207 Multi-Status (WebDAV - RFC 2518) or 207 Partial Update OK (HTTP/1.1 - draft-ietf-http-v11-spec-rev-01?).
MULTIPART_FORM_DATA - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field MULTIPART_FORM_DATA.
MULTIPLE_CHOICES - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
300 Mutliple Choices (HTTP/1.1 - RFC 2616).

N

name - Variable in class com.ibm.cloud.sdk.core.util.CredentialUtils.VcapService
 
names() - Method in class com.ibm.cloud.sdk.core.http.Headers
Returns an immutable, case-insensitive set of header names.
NameValue - Class in com.ibm.cloud.sdk.core.http
A name / value pair parameter used as an element of HTTP messages.
NameValue(String, String) - Constructor for class com.ibm.cloud.sdk.core.http.NameValue
Default Constructor taking a name and a value.
needsRefresh() - Method in class com.ibm.cloud.sdk.core.security.AbstractToken
 
needsRefresh() - Method in class com.ibm.cloud.sdk.core.security.Cp4dToken
Returns true iff this object does not hold a valid access token or has one which has crossed our refresh time.
needsRefresh() - Method in class com.ibm.cloud.sdk.core.security.IamToken
Returns true iff currently stored access token should be refreshed.
needsRefresh() - Method in class com.ibm.cloud.sdk.core.security.MCSPToken
Returns true iff this object does not hold a valid access token or has one which has crossed our refresh time.
newBuilder() - Method in class com.ibm.cloud.sdk.core.security.BasicAuthenticator
Returns a new Builder instance pre-loaded with the configuration from "this".
newBuilder() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataAuthenticator
Returns a new Builder instance pre-loaded with the configuration from "this".
newBuilder() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator
Returns a new Builder instance pre-loaded with the configuration from "this".
newBuilder() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceInstanceAuthenticator
Returns a new Builder instance pre-loaded with the configuration from "this".
newBuilder() - Method in class com.ibm.cloud.sdk.core.security.ContainerAuthenticator
Returns a new Builder instance pre-loaded with the configuration from "this".
newBuilder() - Method in class com.ibm.cloud.sdk.core.security.IamAuthenticator
Returns a new Builder instance pre-loaded with the configuration from "this".
newBuilder() - Method in class com.ibm.cloud.sdk.core.security.MCSPAuthenticator
Returns a new Builder instance pre-loaded with the configuration from "this".
newBuilder() - Method in class com.ibm.cloud.sdk.core.security.VpcInstanceAuthenticator
Returns a new Builder instance pre-loaded with the configuration from "this".
newBuilder() - Method in class com.ibm.cloud.sdk.core.service.model.FileWithMetadata
New builder.
NO_CONTENT - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
204 No Content (HTTP/1.0 - RFC 1945).
NoAuthAuthenticator - Class in com.ibm.cloud.sdk.core.security
This class is a placeholder implementation of the Authenticator interface which performs no authentication of outgoing REST API requests.
NoAuthAuthenticator() - Constructor for class com.ibm.cloud.sdk.core.security.NoAuthAuthenticator
 
NoAuthAuthenticator(Map<String, String>) - Constructor for class com.ibm.cloud.sdk.core.security.NoAuthAuthenticator
 
NON_AUTHORITATIVE_INFORMATION - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
203 Non Authoritative Information (HTTP/1.1 - RFC 2616).
NONE - com.ibm.cloud.sdk.core.http.HttpConfigOptions.LoggingLevel
 
NOT_ACCEPTABLE - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
406 Not Acceptable (HTTP/1.1 - RFC 2616).
NOT_FOUND - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
404 Not Found (HTTP/1.0 - RFC 1945).
NOT_IMPLEMENTED - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
501 Not Implemented (HTTP/1.0 - RFC 1945).
NOT_MODIFIED - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
304 Not Modified (HTTP/1.0 - RFC 1945).
NotAcceptableException - Exception in com.ibm.cloud.sdk.core.service.exception
406 Not Acceptable (HTTP/1.0 - RFC 1945).
NotAcceptableException(Response) - Constructor for exception com.ibm.cloud.sdk.core.service.exception.NotAcceptableException
Instantiates a new Forbidden Exception.
notEmpty(Object[], String) - Static method in class com.ibm.cloud.sdk.core.util.Validator
Validates that the specified argument array is neither null nor a length of zero (no elements); otherwise throwing an exception with the specified message.
notEmpty(String, String) - Static method in class com.ibm.cloud.sdk.core.util.Validator
Validator that the specified argument string is neither null nor a length of zero (no characters); otherwise throwing an exception with the specified message.
notEmpty(Collection, String) - Static method in class com.ibm.cloud.sdk.core.util.Validator
Validates that the specified argument collection is neither null nor a size of zero (no elements); otherwise throwing an exception with the specified message.
NotFoundException - Exception in com.ibm.cloud.sdk.core.service.exception
404 Not Found (HTTP/1.0 - RFC 1945).
NotFoundException(Response) - Constructor for exception com.ibm.cloud.sdk.core.service.exception.NotFoundException
Instantiates a new not found exception.
notNull(Object, String) - Static method in class com.ibm.cloud.sdk.core.util.Validator
Validates that the specified argument is not null; otherwise throwing an exception with the specified message.

O

ObjectModel - Interface in com.ibm.cloud.sdk.core.service.model
Interface for both generic and dynamic model classes.
OK - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
200 OK (HTTP/1.0 - RFC 1945).
omit(Map<String, Object>, String...) - Static method in class com.ibm.cloud.sdk.core.util.RequestUtils
Return a copy of a Map excluding the given key, or array of keys.
onFailure(Exception) - Method in interface com.ibm.cloud.sdk.core.http.ServiceCallback
Called if there is an error during the request.
onResponse(Response<T>) - Method in interface com.ibm.cloud.sdk.core.http.ServiceCallback
Called with the response.

P

parseAsDate(String) - Static method in class com.ibm.cloud.sdk.core.util.DateUtils
Parses the specified string (assumed to be of the form "yyyy-MM-dd") into a Date instance.
parseAsDateTime(String) - Static method in class com.ibm.cloud.sdk.core.util.DateUtils
Parses the specified string into a Date instance.
PARTIAL_CONTENT - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
206 Partial Content (HTTP/1.1 - RFC 2616).
password - Variable in class com.ibm.cloud.sdk.core.util.CredentialUtils.VcapCredentials
 
password(String) - Method in class com.ibm.cloud.sdk.core.security.BasicAuthenticator.Builder
Sets the password property.
password(String) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataAuthenticator.Builder
Sets the password property.
patch(HttpUrl) - Static method in class com.ibm.cloud.sdk.core.http.RequestBuilder
The PUT method requests that the enclosed entity be stored under the supplied Request-URI.
Payload() - Constructor for class com.ibm.cloud.sdk.core.security.JsonWebToken.Payload
 
PAYMENT_REQUIRED - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
402 Payment Required (HTTP/1.1 - RFC 2616).
permissions(String) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator.Builder
Sets the permissions property.
pick(Map<String, Object>, String...) - Static method in class com.ibm.cloud.sdk.core.util.RequestUtils
Return a copy of a Map with only the specified given key, or array of keys.
plan - Variable in class com.ibm.cloud.sdk.core.util.CredentialUtils.VcapService
 
PLAN_STANDARD - Static variable in class com.ibm.cloud.sdk.core.util.CredentialUtils
 
post(HttpUrl) - Static method in class com.ibm.cloud.sdk.core.http.RequestBuilder
The POST request method is designed to request that a web server accept the data enclosed in the request message's body for storage.
PRECONDITION_FAILED - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
412 Precondition Failed (HTTP/1.1 - RFC 2616).
PROPNAME_APIKEY - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
PROPNAME_AUTH_TYPE - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
Constants which define the names of external config propreties (credential file, environment variable, etc.).
PROPNAME_BEARER_TOKEN - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
PROPNAME_CLIENT_ID - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
PROPNAME_CLIENT_SECRET - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
PROPNAME_CR_TOKEN_FILENAME - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
PROPNAME_DISABLE_SSL - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
PROPNAME_DISABLE_SSL - Static variable in class com.ibm.cloud.sdk.core.service.BaseService
 
PROPNAME_DISPLAY_NAME - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
PROPNAME_ENABLE_GZIP - Static variable in class com.ibm.cloud.sdk.core.service.BaseService
 
PROPNAME_ENABLE_RETRIES - Static variable in class com.ibm.cloud.sdk.core.service.BaseService
 
PROPNAME_EXPIRATION_TIME - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
PROPNAME_IAM_PROFILE_CRN - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
PROPNAME_IAM_PROFILE_ID - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
PROPNAME_IAM_PROFILE_NAME - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
PROPNAME_MAX_RETRIES - Static variable in class com.ibm.cloud.sdk.core.service.BaseService
 
PROPNAME_PASSWORD - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
PROPNAME_PERMISSIONS - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
PROPNAME_RETRY_INTERVAL - Static variable in class com.ibm.cloud.sdk.core.service.BaseService
 
PROPNAME_SCOPE - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
PROPNAME_SERVICE_BROKER_SECRET - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
PROPNAME_SERVICE_INSTANCE_ID - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
PROPNAME_UID - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
PROPNAME_URL - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
PROPNAME_URL - Static variable in class com.ibm.cloud.sdk.core.service.BaseService
 
PROPNAME_USERNAME - Static variable in interface com.ibm.cloud.sdk.core.security.Authenticator
 
proxy(Proxy) - Method in class com.ibm.cloud.sdk.core.http.HttpConfigOptions.Builder
Sets HTTP proxy to be used by connections with the current client.
proxy(Proxy) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataAuthenticator.Builder
Sets the proxy property.
proxy(Proxy) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator.Builder
Sets the proxy property.
proxy(Proxy) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceInstanceAuthenticator.Builder
Sets the proxy property.
proxy(Proxy) - Method in class com.ibm.cloud.sdk.core.security.ContainerAuthenticator.Builder
Sets the proxy property.
proxy(Proxy) - Method in class com.ibm.cloud.sdk.core.security.IamAuthenticator.Builder
Sets the proxy property.
proxy(Proxy) - Method in class com.ibm.cloud.sdk.core.security.MCSPAuthenticator.Builder
Sets the proxy property.
PROXY_AUTHENTICATION_REQUIRED - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
407 Proxy Authentication Required (HTTP/1.1 - RFC 2616).
proxyAuthenticator(Authenticator) - Method in class com.ibm.cloud.sdk.core.http.HttpConfigOptions.Builder
Sets HTTP proxy authentication to be used by connections with the current client.
proxyAuthenticator(Authenticator) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataAuthenticator.Builder
Sets the proxyAuthenticator property.
proxyAuthenticator(Authenticator) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator.Builder
Sets the proxyAuthenticator property.
proxyAuthenticator(Authenticator) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceInstanceAuthenticator.Builder
Sets the proxyAuthenticator property.
proxyAuthenticator(Authenticator) - Method in class com.ibm.cloud.sdk.core.security.ContainerAuthenticator.Builder
Sets the proxyAuthenticator property.
proxyAuthenticator(Authenticator) - Method in class com.ibm.cloud.sdk.core.security.IamAuthenticator.Builder
Sets the proxyAuthenticator property.
proxyAuthenticator(Authenticator) - Method in class com.ibm.cloud.sdk.core.security.MCSPAuthenticator.Builder
Sets the proxyAuthenticator property.
put(String, T) - Method in class com.ibm.cloud.sdk.core.service.model.DynamicModel
Sets an arbitrary property.
put(HttpUrl) - Static method in class com.ibm.cloud.sdk.core.http.RequestBuilder
The PUT method requests that the enclosed entity be stored under the supplied Request-URI.

Q

query(Object...) - Method in class com.ibm.cloud.sdk.core.http.RequestBuilder
Adds query parameters.

R

RateLimitConstants - Interface in com.ibm.cloud.sdk.core.http.ratelimit
Deprecated.
As of 9.13.0, use the RetryInterceptor instead.
RateLimitContext - Class in com.ibm.cloud.sdk.core.http.ratelimit
Deprecated.
As of 9.13.0, use the RetryInterceptor instead.
RateLimitContext(int) - Constructor for class com.ibm.cloud.sdk.core.http.ratelimit.RateLimitContext
Deprecated.
 
RateLimitInterceptor - Class in com.ibm.cloud.sdk.core.http.ratelimit
Deprecated.
As of 9.13.0, use the RetryInterceptor instead.
RateLimitInterceptor(Authenticator, int, int) - Constructor for class com.ibm.cloud.sdk.core.http.ratelimit.RateLimitInterceptor
Deprecated.
 
reactiveRequest() - Method in interface com.ibm.cloud.sdk.core.http.ServiceCall
Reactive request using the RxJava 2 library.
read(JsonReader) - Method in class com.ibm.cloud.sdk.core.util.BooleanToStringTypeAdapter
 
read(JsonReader) - Method in class com.ibm.cloud.sdk.core.util.ByteArrayTypeAdapter
 
read(JsonReader) - Method in class com.ibm.cloud.sdk.core.util.DateTimeTypeAdapter
 
read(JsonReader) - Method in class com.ibm.cloud.sdk.core.util.DateTypeAdapter
 
read(JsonReader) - Method in class com.ibm.cloud.sdk.core.util.DiscriminatorBasedTypeAdapterFactory.Adapter
This method is responsible for deserializing a JSON object into an instance of the class identified by the discriminator mapping information.
read(JsonReader) - Method in class com.ibm.cloud.sdk.core.util.DynamicModelTypeAdapterFactory.Adapter
 
read(JsonReader) - Method in class com.ibm.cloud.sdk.core.util.LongToDateTypeAdapter
 
read(JsonReader) - Method in class com.ibm.cloud.sdk.core.util.MapValueObjectTypeAdapter
 
removeProperties() - Method in class com.ibm.cloud.sdk.core.service.model.DynamicModel
Removes all of the arbitrary properties set on this object.
removeProperty(String) - Method in class com.ibm.cloud.sdk.core.service.model.DynamicModel
Removes the specified property from this object's map of arbitrary properties.
REQUEST_TIMEOUT - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
408 Request Timeout (HTTP/1.1 - RFC 2616).
REQUEST_TOO_LONG - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
413 Request Entity Too Large (HTTP/1.1 - RFC 2616).
REQUEST_URI_TOO_LONG - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
414 Request-URI Too Long (HTTP/1.1 - RFC 2616).
RequestBuilder - Class in com.ibm.cloud.sdk.core.http
Convenience class for constructing HTTP/HTTPS requests.
REQUESTED_RANGE_NOT_SATISFIABLE - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
416 Requested Range Not Satisfiable (HTTP/1.1 - RFC 2616).
requestToken() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataAuthenticator
Obtains a CP4D access token for the configured authenticator.
requestToken() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator
Obtains a CP4D access token for the configured authenticator.
requestToken() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceInstanceAuthenticator
Obtains a CP4D access token for the configured authenticator.
requestToken() - Method in class com.ibm.cloud.sdk.core.security.ContainerAuthenticator
Fetches an IAM access token for the apikey using the configured URL.
requestToken() - Method in class com.ibm.cloud.sdk.core.security.IamAuthenticator
Fetches an IAM access token for the apikey using the configured URL.
requestToken() - Method in class com.ibm.cloud.sdk.core.security.MCSPAuthenticator
Fetches an access token for the apikey using the configured URL.
requestToken() - Method in class com.ibm.cloud.sdk.core.security.TokenRequestBasedAuthenticator
Builds and invokes the REST request to fetch a new token from the token service.
requestToken() - Method in class com.ibm.cloud.sdk.core.security.VpcInstanceAuthenticator
Fetches an IAM access token using the authenticator's configuration.
RequestTooLargeException - Exception in com.ibm.cloud.sdk.core.service.exception
413 Request Entity Too Large (HTTP/1.1 - RFC 2616).
RequestTooLargeException(Response) - Constructor for exception com.ibm.cloud.sdk.core.service.exception.RequestTooLargeException
Instantiates a new Request Too Large Exception.
RequestUtils - Class in com.ibm.cloud.sdk.core.util
Utility functions to use when creating a RequestBuilder.
RESET_CONTENT - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
205 Reset Content (HTTP/1.1 - RFC 2616).
resolveRequestUrl(String, String) - Static method in class com.ibm.cloud.sdk.core.http.RequestBuilder
Similar to the three-arg version of resolveRequestUrl, but supports a "path" parameter with no path param references.
resolveRequestUrl(String, String, Map<String, String>) - Static method in class com.ibm.cloud.sdk.core.http.RequestBuilder
Resolves a request URL by first resolving path parameter references within "path", then it combines the serviceUrl portion with the resolved path string.
Response<T> - Class in com.ibm.cloud.sdk.core.http
Class holding the converted service call result along with some HTTP response data.
Response(T, Response) - Constructor for class com.ibm.cloud.sdk.core.http.Response
 
ResponseConverter<T> - Interface in com.ibm.cloud.sdk.core.http
The Interface ResponseConverter.
ResponseConverterUtils - Class in com.ibm.cloud.sdk.core.util
Utility class to convert service responses into a ResponseConverter.
ResponseUtils - Class in com.ibm.cloud.sdk.core.util
Utility class to manage service responses.
RetryInterceptor - Class in com.ibm.cloud.sdk.core.http
This class is an okhttp Interceptor implementation that will try to automatically retry failed requests, based on the type of failure that occurred.
RetryInterceptor(int, int, Authenticator) - Constructor for class com.ibm.cloud.sdk.core.http.RetryInterceptor
This ctor configures the RetryInterceptor instance with the max retries, retry interval and an authenticator.
RetryInterceptor.RetryContext - Class in com.ibm.cloud.sdk.core.http
 
rfc3339DateTimeFmt - Static variable in class com.ibm.cloud.sdk.core.util.DateUtils
 
rfc3339FullDateFmt - Static variable in class com.ibm.cloud.sdk.core.util.DateUtils
 

S

saveFromResponse(HttpUrl, List<Cookie>) - Method in class com.ibm.cloud.sdk.core.http.ServiceCookieJar
 
scope(String) - Method in class com.ibm.cloud.sdk.core.security.ContainerAuthenticator.Builder
Sets the scope property.
scope(String) - Method in class com.ibm.cloud.sdk.core.security.IamAuthenticator.Builder
Sets the scope property.
SEE_OTHER - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
303 See Other (HTTP/1.1 - RFC 2616).
serializeDynamicModelProperty(Object, Type) - Static method in class com.ibm.cloud.sdk.core.util.GsonSerializationHelper
Deprecated.
Takes a property of an object extending DynamicModel and serializes it to the desired type.
SERVICE_UNAVAILABLE - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
503 Service Unavailable (HTTP/1.0 - RFC 1945).
serviceBrokerSecret(String) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator.Builder
Sets the serviceBrokerSecret property.
ServiceCall<T> - Interface in com.ibm.cloud.sdk.core.http
Service Call.
ServiceCallback<T> - Interface in com.ibm.cloud.sdk.core.http
Callback with the response for an Asynchronous request.
ServiceCookieJar - Class in com.ibm.cloud.sdk.core.http
This is an adapter that uses JavaNetCookieJar.
ServiceCookieJar(CookieHandler) - Constructor for class com.ibm.cloud.sdk.core.http.ServiceCookieJar
Instantiates a new ServiceCookieJar.
serviceInstanceId(String) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceInstanceAuthenticator.Builder
Sets the serviceInstanceId property.
ServiceResponseException - Exception in com.ibm.cloud.sdk.core.service.exception
Generic Service Response Exception.
ServiceResponseException(int, Response) - Constructor for exception com.ibm.cloud.sdk.core.service.exception.ServiceResponseException
Instantiates a new Service Response Exception for a response that resulted in a bad status code.
ServiceResponseException(int, Response, String, Throwable) - Constructor for exception com.ibm.cloud.sdk.core.service.exception.ServiceResponseException
Instantiates a new Service Response Exception when we have a specific exception to wrap.
ServiceUnavailableException - Exception in com.ibm.cloud.sdk.core.service.exception
503 Service Unavailable (HTTP/1.0 - RFC 1945).
ServiceUnavailableException(Response) - Constructor for exception com.ibm.cloud.sdk.core.service.exception.ServiceUnavailableException
Instantiates a new Service Unavailable Exception.
SET_COOKIE - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
set_messageCode_(String) - Method in class com.ibm.cloud.sdk.core.security.Cp4dTokenResponse
 
setBasicAuthInfo(String, String) - Method in class com.ibm.cloud.sdk.core.security.IamAuthenticator
Deprecated.
As of 9.7.0, use IamAuthenticator.setClientIdAndSecret() instead
setBearerToken(String) - Method in class com.ibm.cloud.sdk.core.security.BearerTokenAuthenticator
Sets the bearer token value to be used by this Authenticator.
setClient(OkHttpClient) - Method in class com.ibm.cloud.sdk.core.security.TokenRequestBasedAuthenticator
Sets the OkHttpClient instance to be used when interacting with the token service.
setClient(OkHttpClient) - Method in class com.ibm.cloud.sdk.core.service.BaseService
Sets a new OkHttpClient instance to be used for API invocations by this BaseService instance.
setClientIdAndSecret(String, String) - Method in class com.ibm.cloud.sdk.core.security.IamRequestBasedAuthenticator
Sets the clientId and clientSecret on this Authenticator.
setData(Cp4dServiceInstanceTokenResponse.Data) - Method in class com.ibm.cloud.sdk.core.security.Cp4dServiceInstanceTokenResponse
 
setDefaultHeaders(Map<String, String>) - Method in class com.ibm.cloud.sdk.core.service.BaseService
Set the default headers to be used on every HTTP request.
setDisableSSLVerification(boolean) - Method in class com.ibm.cloud.sdk.core.security.TokenRequestBasedAuthenticator
Sets the disableSSLVerification flag.
setEndPoint(String) - Method in class com.ibm.cloud.sdk.core.service.BaseService
Deprecated.
Use setServiceURL() instead.
setException(Throwable) - Method in class com.ibm.cloud.sdk.core.security.AbstractToken
 
setExpiresIn(Long) - Method in class com.ibm.cloud.sdk.core.security.MCSPTokenResponse
 
setHeaders(Map<String, String>) - Method in class com.ibm.cloud.sdk.core.security.TokenRequestBasedAuthenticator
Sets a Map of key/value pairs which will be sent as HTTP headers in any interactions with the token service.
setHttpClient(OkHttpClient) - Method in class com.ibm.cloud.sdk.core.http.HttpClientSingleton
Sets the current OkHttpClient instance held by this singleton.
setMessage(String) - Method in class com.ibm.cloud.sdk.core.security.Cp4dServiceInstanceTokenResponse
 
setMessage(String) - Method in class com.ibm.cloud.sdk.core.security.Cp4dTokenResponse
 
setMessageCode(String) - Method in class com.ibm.cloud.sdk.core.security.Cp4dServiceInstanceTokenResponse
 
setProperties(Map<String, T>) - Method in class com.ibm.cloud.sdk.core.service.model.DynamicModel
Sets the map containing the arbitrary properties set on this object.
setProxy(Proxy) - Method in class com.ibm.cloud.sdk.core.security.TokenRequestBasedAuthenticator
Sets a Proxy object on this Authenticator.
setProxyAuthenticator(Authenticator) - Method in class com.ibm.cloud.sdk.core.security.TokenRequestBasedAuthenticator
Sets a proxy authenticator on this Authenticator instance.
setRetryStrategy(IRetryStrategy) - Static method in class com.ibm.cloud.sdk.core.http.HttpClientSingleton
Sets the factory to be used to construct retry interceptor instances.
setScope(String) - Method in class com.ibm.cloud.sdk.core.security.IamRequestBasedAuthenticator
Sets the "scope" parameter to use when fetching the bearer token from the IAM token server.
setServiceUrl(String) - Method in class com.ibm.cloud.sdk.core.service.BaseService
Set the service URL (the base URL for the service instance).
setToken(String) - Method in class com.ibm.cloud.sdk.core.security.Cp4dServiceInstanceTokenResponse.Data
 
setToken(String) - Method in class com.ibm.cloud.sdk.core.security.Cp4dTokenResponse
 
setToken(String) - Method in class com.ibm.cloud.sdk.core.security.MCSPTokenResponse
 
setTokenType(String) - Method in class com.ibm.cloud.sdk.core.security.MCSPTokenResponse
 
setupTLSProtocol(OkHttpClient.Builder) - Static method in class com.ibm.cloud.sdk.core.http.HttpClientSingleton
Specifically enable all TLS protocols.
setURL(String) - Method in class com.ibm.cloud.sdk.core.security.IamRequestBasedAuthenticator
Sets the URL on this Authenticator.
shouldDisableSslVerification() - Method in class com.ibm.cloud.sdk.core.http.HttpConfigOptions
 
StringHelper - Class in com.ibm.cloud.sdk.core.util
Helper class used by java code generated by the SDK codegen tool.

T

tags - Variable in class com.ibm.cloud.sdk.core.util.CredentialUtils.VcapService
 
TEMPORARY_REDIRECT - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
307 Temporary Redirect (HTTP/1.1 - RFC 2616).
TEXT - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field TEXT.
TEXT_CSV - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field TEXT_CSV.
TEXT_HTML - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field TEXT_HTML.
TEXT_PLAIN - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field TEXT_PLAIN.
TEXT_XML - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field TEXT_XML.
toInputStream(String) - Static method in class com.ibm.cloud.sdk.core.util.StringHelper
Returns an InputStream that can be used to read the bytes of the specified String.
TokenRequestBasedAuthenticator<T extends AbstractToken,​R extends TokenServerResponse> - Class in com.ibm.cloud.sdk.core.security
This class serves as a common base class for Authenticator implementations that interact with a token service via a REST interface.
TokenRequestBasedAuthenticator() - Constructor for class com.ibm.cloud.sdk.core.security.TokenRequestBasedAuthenticator
 
TokenServerResponse - Interface in com.ibm.cloud.sdk.core.security
This interface is used as a marker for classes that model the response received from a Token Server.
TOO_MANY_REQUESTS - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
429 Too Many Requests.
TooManyRequestsException - Exception in com.ibm.cloud.sdk.core.service.exception
429 Too Many Requests (HTTP/1.1 - RFC 6585).
TooManyRequestsException(Response) - Constructor for exception com.ibm.cloud.sdk.core.service.exception.TooManyRequestsException
Instantiates a new Too Many Requests Exception.
toString() - Method in class com.ibm.cloud.sdk.core.http.Headers
 
toString() - Method in class com.ibm.cloud.sdk.core.http.NameValue
 
toString() - Method in class com.ibm.cloud.sdk.core.http.ratelimit.RateLimitContext
Deprecated.
 
toString() - Method in class com.ibm.cloud.sdk.core.http.RequestBuilder
 
toString() - Method in class com.ibm.cloud.sdk.core.security.IamToken
 
toString() - Method in class com.ibm.cloud.sdk.core.service.BaseService
 
toString() - Method in class com.ibm.cloud.sdk.core.service.model.DynamicModel
 
toString() - Method in class com.ibm.cloud.sdk.core.service.model.GenericModel
 
toString() - Method in interface com.ibm.cloud.sdk.core.service.model.ObjectModel
 
toUrl() - Method in class com.ibm.cloud.sdk.core.http.RequestBuilder
Return the request url including query parameters.

U

uid(String) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator.Builder
Sets the uid property.
UNAUTHORIZED - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
401 Unauthorized (HTTP/1.0 - RFC 1945).
UnauthorizedException - Exception in com.ibm.cloud.sdk.core.service.exception
401 Unauthorized (HTTP/1.0 - RFC 1945).
UnauthorizedException(Response) - Constructor for exception com.ibm.cloud.sdk.core.service.exception.UnauthorizedException
Instantiates a new Unauthorized Exception.
UNPROCESSABLE_ENTITY - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
422 Unprocessable Entity (WebDAV - RFC 2518).
UNSUPPORTED_MEDIA_TYPE - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
415 Unsupported Media Type (HTTP/1.1 - RFC 2616).
UnsupportedException - Exception in com.ibm.cloud.sdk.core.service.exception
415 Unsupported Media Type (HTTP/1.1 - RFC 2616).
UnsupportedException(Response) - Constructor for exception com.ibm.cloud.sdk.core.service.exception.UnsupportedException
Instantiates a new unsupported Exception.
url - Variable in class com.ibm.cloud.sdk.core.util.CredentialUtils.VcapCredentials
 
url(String) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataAuthenticator.Builder
Sets the url property.
url(String) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator.Builder
Sets the url property.
url(String) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceInstanceAuthenticator.Builder
Sets the url property.
url(String) - Method in class com.ibm.cloud.sdk.core.security.ContainerAuthenticator.Builder
Sets the url property.
url(String) - Method in class com.ibm.cloud.sdk.core.security.IamAuthenticator.Builder
Sets the url property.
url(String) - Method in class com.ibm.cloud.sdk.core.security.MCSPAuthenticator.Builder
Sets the url property.
url(String) - Method in class com.ibm.cloud.sdk.core.security.VpcInstanceAuthenticator.Builder
Sets the url property.
UrlHelper - Class in com.ibm.cloud.sdk.core.util
 
USE_PROXY - Static variable in interface com.ibm.cloud.sdk.core.http.HttpStatus
305 Use Proxy (HTTP/1.1 - RFC 2616).
USER_AGENT - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
username - Variable in class com.ibm.cloud.sdk.core.util.CredentialUtils.VcapCredentials
 
username(String) - Method in class com.ibm.cloud.sdk.core.security.BasicAuthenticator.Builder
Sets the username property.
username(String) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataAuthenticator.Builder
Sets the username property.
username(String) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator.Builder
Sets the username property.
username(String) - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceInstanceAuthenticator.Builder
Sets the username property.

V

validate() - Method in interface com.ibm.cloud.sdk.core.security.Authenticator
Validates the current set of configuration information in the Authenticator.
validate() - Method in class com.ibm.cloud.sdk.core.security.BasicAuthenticator
 
validate() - Method in class com.ibm.cloud.sdk.core.security.BearerTokenAuthenticator
 
validate() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataAuthenticator
Validates the configuration of this authenticator.
validate() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceAuthenticator
Validates the configuration of this authenticator.
validate() - Method in class com.ibm.cloud.sdk.core.security.CloudPakForDataServiceInstanceAuthenticator
Validates the configuration of this authenticator.
validate() - Method in class com.ibm.cloud.sdk.core.security.ContainerAuthenticator
 
validate() - Method in class com.ibm.cloud.sdk.core.security.IamAuthenticator
 
validate() - Method in class com.ibm.cloud.sdk.core.security.IamRequestBasedAuthenticator
 
validate() - Method in class com.ibm.cloud.sdk.core.security.MCSPAuthenticator
Validates the configuration.
validate() - Method in class com.ibm.cloud.sdk.core.security.NoAuthAuthenticator
 
validate() - Method in class com.ibm.cloud.sdk.core.security.TokenRequestBasedAuthenticator
Validates the configuration properties associated with the Authenticator.
validate() - Method in class com.ibm.cloud.sdk.core.security.VpcInstanceAuthenticator
Validates the configuration of the authenticator and throws an exception if validation fails.
Validator - Class in com.ibm.cloud.sdk.core.util
This class assists in validating arguments.
If an argument value is deemed invalid, an IllegalArgumentException is thrown.
valueOf(String) - Static method in enum com.ibm.cloud.sdk.core.http.HttpConfigOptions.LoggingLevel
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.ibm.cloud.sdk.core.http.HttpConfigOptions.LoggingLevel
Returns an array containing the constants of this enum type, in the order they are declared.
values(String) - Method in class com.ibm.cloud.sdk.core.http.Headers
Returns an immutable list of the header values for the specified name.
VARY - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
VcapCredentials() - Constructor for class com.ibm.cloud.sdk.core.util.CredentialUtils.VcapCredentials
 
VcapService() - Constructor for class com.ibm.cloud.sdk.core.util.CredentialUtils.VcapService
 
VpcInstanceAuthenticator - Class in com.ibm.cloud.sdk.core.security
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 - Class in com.ibm.cloud.sdk.core.security
This Builder class is used to construct IamAuthenticator instances.
VpcTokenResponse - Class in com.ibm.cloud.sdk.core.security
This class models the response received from the VPC "create_access_token" and "create_iam_token" operations.
VpcTokenResponse() - Constructor for class com.ibm.cloud.sdk.core.security.VpcTokenResponse
 

W

WILDCARD - Static variable in class com.ibm.cloud.sdk.core.http.HttpMediaType
Field WILDCARD.
write(JsonWriter, byte[]) - Method in class com.ibm.cloud.sdk.core.util.ByteArrayTypeAdapter
 
write(JsonWriter, Boolean) - Method in class com.ibm.cloud.sdk.core.util.BooleanToStringTypeAdapter
 
write(JsonWriter, Object) - Method in class com.ibm.cloud.sdk.core.util.MapValueObjectTypeAdapter
 
write(JsonWriter, Date) - Method in class com.ibm.cloud.sdk.core.util.DateTimeTypeAdapter
 
write(JsonWriter, Date) - Method in class com.ibm.cloud.sdk.core.util.DateTypeAdapter
 
write(JsonWriter, Date) - Method in class com.ibm.cloud.sdk.core.util.LongToDateTypeAdapter
 
write(JsonWriter, T) - Method in class com.ibm.cloud.sdk.core.util.DiscriminatorBasedTypeAdapterFactory.Adapter
We wouldn't normally expect Gson to call our write() method because we should never actually have instances of a "oneOf" base class (they are implemented as abstract base classes).
write(JsonWriter, T) - Method in class com.ibm.cloud.sdk.core.util.DynamicModelTypeAdapterFactory.Adapter
 
writeTo(BufferedSink) - Method in class com.ibm.cloud.sdk.core.http.InputStreamRequestBody
 
WWW_AUTHENTICATE - Static variable in interface com.ibm.cloud.sdk.core.http.HttpHeaders
A B C D E F G H I J L M N O P Q R S T U V W 
All Classes All Packages