A B C D E F G H I J L N R S T U V W

A

addHeader(String, String) - Method in class com.microsoft.rest.interceptors.CustomHeadersInterceptor

Add a single header key-value pair.

addHeaderMap(Map<String, String>) - Method in class com.microsoft.rest.interceptors.CustomHeadersInterceptor

Add all headers in a header map.

addHeaderMultimap(Map<String, List<String>>) - Method in class com.microsoft.rest.interceptors.CustomHeadersInterceptor

Add all headers in a header multimap.

addHeaders(Headers) - Method in class com.microsoft.rest.interceptors.CustomHeadersInterceptor

Add all headers in a Headers object.

appendUserAgent(String) - Method in class com.microsoft.rest.interceptors.UserAgentInterceptor

Append a text to the User-Agent header.

applyCredentialsFilter(OkHttpClient.Builder) - Method in class com.microsoft.rest.credentials.BasicAuthenticationCredentials

applyCredentialsFilter(OkHttpClient.Builder) - Method in interface com.microsoft.rest.credentials.ServiceClientCredentials

Apply the credentials to the HTTP client builder.

applyCredentialsFilter(OkHttpClient.Builder) - Method in class com.microsoft.rest.credentials.TokenCredentials

B

Base64Url - Class in com.microsoft.rest

Simple wrapper over Base64Url encoded byte array used during serialization/deserialization.

Base64UrlSerializer - Class in com.microsoft.rest.serializer

Custom serializer for serializing Byte[] objects into Base64 strings.

Base64UrlSerializer() - Constructor for class com.microsoft.rest.serializer.Base64UrlSerializer

BaseUrlHandler - Class in com.microsoft.rest.interceptors

Handles dynamic replacements on base URL.

BaseUrlHandler() - Constructor for class com.microsoft.rest.interceptors.BaseUrlHandler

BasicAuthenticationCredentials - Class in com.microsoft.rest.credentials

Basic Auth credentials for use with a REST Service Client.

BasicAuthenticationCredentials(String, String) - Constructor for class com.microsoft.rest.credentials.BasicAuthenticationCredentials

Instantiates a new basic authentication credential.

body() - Method in exception com.microsoft.rest.RestException

body() - Method in class com.microsoft.rest.ServiceResponse

Gets the response object.

build(Response<ResponseBody>) - Method in interface com.microsoft.rest.protocol.ResponseBuilder

Build a ServiceResponse instance from a REST call response and a possible error.

build() - Method in class com.microsoft.rest.RestClient.Builder

Build a RestClient with all the current configurations.

build(Response<ResponseBody>) - Method in class com.microsoft.rest.ServiceResponseBuilder

buildEmpty(Response<Void>) - Method in interface com.microsoft.rest.protocol.ResponseBuilder

Build a ServiceResponse instance from a REST call response and a possible error, which does not have a response body.

buildEmpty(Response<Void>) - Method in class com.microsoft.rest.ServiceResponseBuilder

buildEmptyWithHeaders(Response<Void>, Class<THeader>) - Method in interface com.microsoft.rest.protocol.ResponseBuilder

Build a ServiceResponseWithHeaders instance from a REST call response, a header in JSON format, and a possible error, which does not have a response body.

buildEmptyWithHeaders(Response<Void>, Class<THeader>) - Method in class com.microsoft.rest.ServiceResponseBuilder

Builder() - Constructor for class com.microsoft.rest.RestClient.Builder

Creates an instance of the builder with a base URL to the service.

Builder(OkHttpClient.Builder, Retrofit.Builder) - Constructor for class com.microsoft.rest.RestClient.Builder

Creates an instance of the builder with a base URL and 2 custom builders.

buildWithHeaders(Response<ResponseBody>, Class<THeader>) - Method in interface com.microsoft.rest.protocol.ResponseBuilder

Build a ServiceResponseWithHeaders instance from a REST call response, a header in JSON format, and a possible error.

buildWithHeaders(Response<ResponseBody>, Class<THeader>) - Method in class com.microsoft.rest.ServiceResponseBuilder

ByteArraySerializer - Class in com.microsoft.rest.serializer

Custom serializer for serializing Byte[] objects into Base64 strings.

ByteArraySerializer() - Constructor for class com.microsoft.rest.serializer.ByteArraySerializer

C

cancel(boolean) - Method in class com.microsoft.rest.ServiceFuture

close() - Method in class com.microsoft.rest.RestClient

Closes the HTTP client and recycles the resources associated.

closeAndWait() - Method in class com.microsoft.rest.RestClient

Closes the HTTP client, recycles the resources associated, and waits for 60 seconds for all the threads to be recycled.

CollectionFormat - Enum in com.microsoft.rest

Swagger collection format to use for joining List parameters in paths, queries, and headers.

com.microsoft.rest - package com.microsoft.rest

The package contains the runtime classes required for AutoRest generated clients to compile and function.

com.microsoft.rest.credentials - package com.microsoft.rest.credentials

The package provides 2 basic credential classes that work with AutoRest generated clients for authentication purposes.

com.microsoft.rest.interceptors - package com.microsoft.rest.interceptors

The package contains default interceptors for making HTTP requests.

com.microsoft.rest.protocol - package com.microsoft.rest.protocol

The package contains classes that interfaces defining the behaviors of the necessary components of a Rest Client.

com.microsoft.rest.retry - package com.microsoft.rest.retry

The package contains classes that define the retry behaviors when an error occurs during a REST call.

com.microsoft.rest.serializer - package com.microsoft.rest.serializer

The package contains classes that handle serialization and deserialization for the REST call payloads.

converterFactory() - Method in interface com.microsoft.rest.protocol.SerializerAdapter

converterFactory() - Method in class com.microsoft.rest.serializer.JacksonAdapter

credentials() - Method in class com.microsoft.rest.RestClient

CustomHeadersInterceptor - Class in com.microsoft.rest.interceptors

An instance of this class enables adding custom headers in client requests when added to the OkHttpClient interceptors.

CustomHeadersInterceptor() - Constructor for class com.microsoft.rest.interceptors.CustomHeadersInterceptor

Initialize an instance of CustomHeadersInterceptor class.

CustomHeadersInterceptor(String, String) - Constructor for class com.microsoft.rest.interceptors.CustomHeadersInterceptor

Initialize an instance of CustomHeadersInterceptor class.

D

dateTime() - Method in class com.microsoft.rest.DateTimeRfc1123

Returns the underlying DateTime.

DateTimeRfc1123 - Class in com.microsoft.rest

Simple wrapper over joda.time.DateTime used for specifying RFC1123 format during serialization/deserialization.

DateTimeRfc1123(DateTime) - Constructor for class com.microsoft.rest.DateTimeRfc1123

Creates a new DateTimeRfc1123 object with the specified DateTime.

DateTimeRfc1123(String) - Constructor for class com.microsoft.rest.DateTimeRfc1123

Creates a new DateTimeRfc1123 object with the specified DateTime.

DateTimeRfc1123Serializer - Class in com.microsoft.rest.serializer

Custom serializer for serializing DateTimeRfc1123 object into RFC1123 formats.

DateTimeRfc1123Serializer() - Constructor for class com.microsoft.rest.serializer.DateTimeRfc1123Serializer

DateTimeSerializer - Class in com.microsoft.rest.serializer

Custom serializer for serializing DateTime object into ISO8601 formats.

DateTimeSerializer() - Constructor for class com.microsoft.rest.serializer.DateTimeSerializer

decodedBytes() - Method in class com.microsoft.rest.Base64Url

Decode the bytes and return.

DEFAULT_CLIENT_BACKOFF - Static variable in class com.microsoft.rest.retry.ExponentialBackoffRetryStrategy

Represents the default amount of time used when calculating a random delta in the exponential delay between retries.

DEFAULT_CLIENT_RETRY_COUNT - Static variable in class com.microsoft.rest.retry.RetryStrategy

Represents the default number of retry attempts.

DEFAULT_FIRST_FAST_RETRY - Static variable in class com.microsoft.rest.retry.RetryStrategy

Represents the default flag indicating whether the first retry attempt will be made immediately, whereas subsequent retries will remain subject to the retry interval.

DEFAULT_MAX_BACKOFF - Static variable in class com.microsoft.rest.retry.ExponentialBackoffRetryStrategy

Represents the default maximum amount of time used when calculating the exponential delay between retries.

DEFAULT_MIN_BACKOFF - Static variable in class com.microsoft.rest.retry.ExponentialBackoffRetryStrategy

Represents the default minimum amount of time used when calculating the exponential delay between retries.

DEFAULT_RETRY_INTERVAL - Static variable in class com.microsoft.rest.retry.RetryStrategy

Represents the default interval between retries.

deserialize(String, Type) - Method in interface com.microsoft.rest.protocol.SerializerAdapter

Deserializes a string into a U object using the current T.

deserialize(JsonParser, DeserializationContext) - Method in class com.microsoft.rest.serializer.FlatteningDeserializer

deserialize(String, Type) - Method in class com.microsoft.rest.serializer.JacksonAdapter

E

encode(byte[]) - Static method in class com.microsoft.rest.Base64Url

Encode a byte array into Base64Url encoded bytes.

encodedBytes() - Method in class com.microsoft.rest.Base64Url

Returns the underlying encoded byte array.

Environment - Interface in com.microsoft.rest.protocol

An collection of endpoints in a region or a cloud.

Environment.Endpoint - Interface in com.microsoft.rest.protocol

An endpoint identifier used for the provider to get a URL.

equals(Object) - Method in class com.microsoft.rest.Base64Url

equals(Object) - Method in class com.microsoft.rest.DateTimeRfc1123

equals(Object) - Method in class com.microsoft.rest.ExpandableStringEnum

exceptionType() - Method in class com.microsoft.rest.ServiceResponseBuilder

ExpandableStringEnum<T extends ExpandableStringEnum<T>> - Class in com.microsoft.rest

Base implementation for expandable, single string enums.

ExpandableStringEnum() - Constructor for class com.microsoft.rest.ExpandableStringEnum

ExponentialBackoffRetryStrategy - Class in com.microsoft.rest.retry

A retry strategy with backoff parameters for calculating the exponential delay between retries.

ExponentialBackoffRetryStrategy() - Constructor for class com.microsoft.rest.retry.ExponentialBackoffRetryStrategy

Initializes a new instance of the ExponentialBackoffRetryStrategy class.

ExponentialBackoffRetryStrategy(int, int, int, int) - Constructor for class com.microsoft.rest.retry.ExponentialBackoffRetryStrategy

Initializes a new instance of the ExponentialBackoffRetryStrategy class.

ExponentialBackoffRetryStrategy(String, int, int, int, int, boolean) - Constructor for class com.microsoft.rest.retry.ExponentialBackoffRetryStrategy

Initializes a new instance of the ExponentialBackoffRetryStrategy class.

F

Factory() - Constructor for class com.microsoft.rest.ServiceResponseBuilder.Factory

failure(Throwable) - Method in interface com.microsoft.rest.ServiceCallback

Override this method to handle REST call failures.

FlatteningDeserializer - Class in com.microsoft.rest.serializer

Custom serializer for deserializing complex types with wrapped properties.

FlatteningDeserializer(Class<?>, JsonDeserializer<?>, ObjectMapper) - Constructor for class com.microsoft.rest.serializer.FlatteningDeserializer

Creates an instance of FlatteningDeserializer.

FlatteningSerializer - Class in com.microsoft.rest.serializer

Custom serializer for serializing types with wrapped properties.

FlatteningSerializer(Class<?>, JsonSerializer<?>, ObjectMapper) - Constructor for class com.microsoft.rest.serializer.FlatteningSerializer

Creates an instance of FlatteningSerializer.

fromBody(Observable<T>, ServiceCallback<T>) - Static method in class com.microsoft.rest.ServiceFuture

Creates a ServiceFuture from an observable object and a callback.

fromBody(Completable, ServiceCallback<Void>) - Static method in class com.microsoft.rest.ServiceFuture

Creates a ServiceFuture from an Completable object and a callback.

fromHeaderResponse(Observable<ServiceResponseWithHeaders<T, V>>, ServiceCallback<T>) - Static method in class com.microsoft.rest.ServiceFuture

Creates a ServiceCall from an observable and a callback for a header response.

fromResponse(Observable<ServiceResponse<T>>) - Static method in class com.microsoft.rest.ServiceFuture

Creates a ServiceCall from an observable object.

fromResponse(Observable<ServiceResponse<T>>, ServiceCallback<T>) - Static method in class com.microsoft.rest.ServiceFuture

Creates a ServiceCall from an observable object and a callback.

fromString(String, Class<T>) - Static method in class com.microsoft.rest.ExpandableStringEnum

G

getDelimiter() - Method in enum com.microsoft.rest.CollectionFormat

Gets the delimiter used to join a list of parameters.

getModule() - Static method in class com.microsoft.rest.serializer.Base64UrlSerializer

Gets a module wrapping this serializer as an adapter for the Jackson ObjectMapper.

getModule() - Static method in class com.microsoft.rest.serializer.ByteArraySerializer

Gets a module wrapping this serializer as an adapter for the Jackson ObjectMapper.

getModule() - Static method in class com.microsoft.rest.serializer.DateTimeRfc1123Serializer

Gets a module wrapping this serializer as an adapter for the Jackson ObjectMapper.

getModule() - Static method in class com.microsoft.rest.serializer.DateTimeSerializer

Gets a module wrapping this serializer as an adapter for the Jackson ObjectMapper.

getModule(ObjectMapper) - Static method in class com.microsoft.rest.serializer.FlatteningDeserializer

Gets a module wrapping this serializer as an adapter for the Jackson ObjectMapper.

getModule(ObjectMapper) - Static method in class com.microsoft.rest.serializer.FlatteningSerializer

Gets a module wrapping this serializer as an adapter for the Jackson ObjectMapper.

getModule() - Static method in class com.microsoft.rest.serializer.HeadersSerializer

Gets a module wrapping this serializer as an adapter for the Jackson ObjectMapper.

getPassword() - Method in class com.microsoft.rest.credentials.BasicAuthenticationCredentials

getScheme() - Method in class com.microsoft.rest.credentials.TokenCredentials

Get the authentication scheme.

getSubscription() - Method in class com.microsoft.rest.ServiceFuture

getToken(Request) - Method in class com.microsoft.rest.credentials.TokenCredentials

Get the secure token.

getUserName() - Method in class com.microsoft.rest.credentials.BasicAuthenticationCredentials

H

hashCode() - Method in class com.microsoft.rest.Base64Url

hashCode() - Method in class com.microsoft.rest.DateTimeRfc1123

hashCode() - Method in class com.microsoft.rest.ExpandableStringEnum

headers() - Method in class com.microsoft.rest.interceptors.CustomHeadersInterceptor

headers() - Method in class com.microsoft.rest.RestClient

headers() - Method in class com.microsoft.rest.ServiceResponseWithHeaders

Gets the response headers.

HeadersSerializer - Class in com.microsoft.rest.serializer

Custom serializer for serializing Headers objects.

HeadersSerializer() - Constructor for class com.microsoft.rest.serializer.HeadersSerializer

headResponse() - Method in class com.microsoft.rest.ServiceResponse

Gets the raw REST response from a HEAD operation.

httpClient() - Method in class com.microsoft.rest.RestClient

httpClient() - Method in class com.microsoft.rest.ServiceClient

I

identifier() - Method in interface com.microsoft.rest.protocol.Environment.Endpoint

intercept(Interceptor.Chain) - Method in class com.microsoft.rest.interceptors.BaseUrlHandler

intercept(Interceptor.Chain) - Method in class com.microsoft.rest.interceptors.CustomHeadersInterceptor

intercept(Interceptor.Chain) - Method in class com.microsoft.rest.interceptors.LoggingInterceptor

intercept(Interceptor.Chain) - Method in class com.microsoft.rest.interceptors.RequestIdHeaderInterceptor

intercept(Interceptor.Chain) - Method in class com.microsoft.rest.interceptors.UserAgentInterceptor

intercept(Interceptor.Chain) - Method in class com.microsoft.rest.retry.RetryHandler

isCancelled() - Method in class com.microsoft.rest.ServiceFuture

isFastFirstRetry() - Method in class com.microsoft.rest.retry.RetryStrategy

Gets whether the first retry attempt will be made immediately.

isPrettyJson() - Method in enum com.microsoft.rest.LogLevel

isSuccessful(int) - Method in class com.microsoft.rest.ServiceResponseBuilder

Check if the returned status code will be considered a success for this builder.

J

JacksonAdapter - Class in com.microsoft.rest.serializer

A serialization helper class wrapped around JacksonConverterFactory and ObjectMapper.

JacksonAdapter() - Constructor for class com.microsoft.rest.serializer.JacksonAdapter

Creates a new JacksonAdapter instance with default mapper settings.

JsonFlatten - Annotation Type in com.microsoft.rest.serializer

Annotation used for flattening properties separated by '.'.

L

log(Logger, String) - Method in class com.microsoft.rest.interceptors.LoggingInterceptor

Process the log using an SLF4j logger and an HTTP message.

LoggingInterceptor - Class in com.microsoft.rest.interceptors

An OkHttp interceptor that handles logging of HTTP requests and responses.

LoggingInterceptor(LogLevel) - Constructor for class com.microsoft.rest.interceptors.LoggingInterceptor

Creates an interceptor with a LogLevel enum.

logLevel() - Method in class com.microsoft.rest.interceptors.LoggingInterceptor

LogLevel - Enum in com.microsoft.rest

Describes the level of HTTP traffic to log.

logLevel() - Method in class com.microsoft.rest.RestClient

N

name() - Method in class com.microsoft.rest.retry.RetryStrategy

Gets the name of the retry strategy.

newBuilder() - Method in class com.microsoft.rest.RestClient

Create a new builder for a new Rest Client with the same configurations on this one.

newInstance(SerializerAdapter<?>) - Method in interface com.microsoft.rest.protocol.ResponseBuilder.Factory

Returns a response builder instance.

newInstance(SerializerAdapter<?>) - Method in class com.microsoft.rest.ServiceResponseBuilder.Factory

R

register(int, Type) - Method in interface com.microsoft.rest.protocol.ResponseBuilder

Register a mapping from a response status code to a response destination type.

register(int, Type) - Method in class com.microsoft.rest.ServiceResponseBuilder

registerAll(Map<Integer, Type>) - Method in class com.microsoft.rest.ServiceResponseBuilder

Register all the mappings from a response status code to a response destination type stored in a Map.

registerError(Class<? extends RestException>) - Method in interface com.microsoft.rest.protocol.ResponseBuilder

Register a destination type for errors with models.

registerError(Class<? extends RestException>) - Method in class com.microsoft.rest.ServiceResponseBuilder

removeHeader(String) - Method in class com.microsoft.rest.interceptors.CustomHeadersInterceptor

Remove a header.

replaceHeader(String, String) - Method in class com.microsoft.rest.interceptors.CustomHeadersInterceptor

Add a single header key-value pair.

RequestIdHeaderInterceptor - Class in com.microsoft.rest.interceptors

An instance of this class puts an UUID in the request header.

RequestIdHeaderInterceptor() - Constructor for class com.microsoft.rest.interceptors.RequestIdHeaderInterceptor

resolve(DeserializationContext) - Method in class com.microsoft.rest.serializer.FlatteningDeserializer

resolve(SerializerProvider) - Method in class com.microsoft.rest.serializer.FlatteningSerializer

response() - Method in exception com.microsoft.rest.RestException

response() - Method in class com.microsoft.rest.ServiceResponse

Gets the raw REST response.

ResponseBuilder<T,E extends RestException> - Interface in com.microsoft.rest.protocol

Defines an interface that can process a Retrofit 2 response into a deserialized body or an exception, depending on the status code registered.

ResponseBuilder.Factory - Interface in com.microsoft.rest.protocol

A factory that creates a builder based on the return type and the exception type.

responseBuilderFactory() - Method in class com.microsoft.rest.RestClient

RestClient - Class in com.microsoft.rest

An instance of this class stores the client information for making REST calls.

restClient() - Method in class com.microsoft.rest.ServiceClient

RestClient.Builder - Class in com.microsoft.rest

The builder class for building a REST client.

RestException - Exception in com.microsoft.rest

Exception thrown for an invalid response with custom error information.

RestException(String, Response<ResponseBody>) - Constructor for exception com.microsoft.rest.RestException

Initializes a new instance of the RestException class.

RestException(String, Response<ResponseBody>, Object) - Constructor for exception com.microsoft.rest.RestException

Initializes a new instance of the RestException class.

retrofit() - Method in class com.microsoft.rest.RestClient

retrofit() - Method in class com.microsoft.rest.ServiceClient

RetryHandler - Class in com.microsoft.rest.retry

An instance of this interceptor placed in the request pipeline handles retriable errors.

RetryHandler() - Constructor for class com.microsoft.rest.retry.RetryHandler

Initialized an instance of RetryHandler class.

RetryHandler(RetryStrategy) - Constructor for class com.microsoft.rest.retry.RetryHandler

Initialized an instance of RetryHandler class.

RetryStrategy - Class in com.microsoft.rest.retry

Represents a retry strategy that determines the number of retry attempts and the interval between retries.

RetryStrategy(String, boolean) - Constructor for class com.microsoft.rest.retry.RetryStrategy

Initializes a new instance of the RetryStrategy class.

S

serialize(Object) - Method in interface com.microsoft.rest.protocol.SerializerAdapter

Serializes an object into a JSON string.

serialize(Base64Url, JsonGenerator, SerializerProvider) - Method in class com.microsoft.rest.serializer.Base64UrlSerializer

serialize(Byte[], JsonGenerator, SerializerProvider) - Method in class com.microsoft.rest.serializer.ByteArraySerializer

serialize(DateTimeRfc1123, JsonGenerator, SerializerProvider) - Method in class com.microsoft.rest.serializer.DateTimeRfc1123Serializer

serialize(DateTime, JsonGenerator, SerializerProvider) - Method in class com.microsoft.rest.serializer.DateTimeSerializer

serialize(Object, JsonGenerator, SerializerProvider) - Method in class com.microsoft.rest.serializer.FlatteningSerializer

serialize(Headers, JsonGenerator, SerializerProvider) - Method in class com.microsoft.rest.serializer.HeadersSerializer

serialize(Object) - Method in class com.microsoft.rest.serializer.JacksonAdapter

serializeList(List<?>, CollectionFormat) - Method in interface com.microsoft.rest.protocol.SerializerAdapter

Serializes a list into a string with the delimiter specified with the Swagger collection format joining each individual serialized items in the list.

serializeList(List<?>, CollectionFormat) - Method in class com.microsoft.rest.serializer.JacksonAdapter

serializer() - Method in interface com.microsoft.rest.protocol.SerializerAdapter

serializer() - Method in class com.microsoft.rest.serializer.JacksonAdapter

SerializerAdapter<T> - Interface in com.microsoft.rest.protocol

This interface defines the behaviors an adapter of a serializer needs to implement.

serializerAdapter() - Method in class com.microsoft.rest.RestClient

serializerAdapter() - Method in class com.microsoft.rest.ServiceClient

serializeRaw(Object) - Method in interface com.microsoft.rest.protocol.SerializerAdapter

Serializes an object into a raw string.

serializeRaw(Object) - Method in class com.microsoft.rest.serializer.JacksonAdapter

serializeWithType(Object, JsonGenerator, SerializerProvider, TypeSerializer) - Method in class com.microsoft.rest.serializer.FlatteningSerializer

ServiceCallback<T> - Interface in com.microsoft.rest

The callback used for client side asynchronous operations.

ServiceClient - Class in com.microsoft.rest

ServiceClient is the abstraction for accessing REST operations and their payload data types.

ServiceClient(String) - Constructor for class com.microsoft.rest.ServiceClient

Initializes a new instance of the ServiceClient class.

ServiceClient(String, OkHttpClient.Builder, Retrofit.Builder) - Constructor for class com.microsoft.rest.ServiceClient

Initializes a new instance of the ServiceClient class.

ServiceClient(RestClient) - Constructor for class com.microsoft.rest.ServiceClient

Initializes a new instance of the ServiceClient class.

ServiceClientCredentials - Interface in com.microsoft.rest.credentials

ServiceClientCredentials is the abstraction for credentials used by ServiceClients accessing REST services.

ServiceFuture<T> - Class in com.microsoft.rest

An instance of this class provides access to the underlying REST call invocation.

ServiceFuture() - Constructor for class com.microsoft.rest.ServiceFuture

ServiceResponse<T> - Class in com.microsoft.rest

An instance of this class holds a response object and a raw REST response.

ServiceResponse(T, Response<ResponseBody>) - Constructor for class com.microsoft.rest.ServiceResponse

Instantiate a ServiceResponse instance with a response object and a raw REST response.

ServiceResponse(Response<Void>) - Constructor for class com.microsoft.rest.ServiceResponse

Instantiate a ServiceResponse instance with a response from a HEAD operation.

ServiceResponseBuilder<T,E extends RestException> - Class in com.microsoft.rest

The builder for building a ServiceResponse.

ServiceResponseBuilder.Factory - Class in com.microsoft.rest

A factory to create a service response builder.

ServiceResponseWithHeaders<TBody,THeader> - Class in com.microsoft.rest

An instance of this class holds a response object and a raw REST response.

ServiceResponseWithHeaders(TBody, THeader, Response<ResponseBody>) - Constructor for class com.microsoft.rest.ServiceResponseWithHeaders

Instantiate a ServiceResponse instance with a response object and a raw REST response.

ServiceResponseWithHeaders(THeader, Response<Void>) - Constructor for class com.microsoft.rest.ServiceResponseWithHeaders

Instantiate a ServiceResponse instance with a response object and a raw REST response.

setSubscription(Subscription) - Method in class com.microsoft.rest.ServiceFuture

shouldRetry(int, Response) - Method in class com.microsoft.rest.retry.ExponentialBackoffRetryStrategy

Returns if a request should be retried based on the retry count, current response, and the current strategy.

shouldRetry(int, Response) - Method in class com.microsoft.rest.retry.RetryStrategy

Returns if a request should be retried based on the retry count, current response, and the current strategy.

simpleMapper() - Method in class com.microsoft.rest.serializer.JacksonAdapter

Gets a static instance of ObjectMapper that doesn't handle flattening.

SkipParentValidation - Annotation Type in com.microsoft.rest

Annotation used for notifying the validator to skip validation for the properties in the parent class.

strategy() - Method in class com.microsoft.rest.retry.RetryHandler

success(T) - Method in interface com.microsoft.rest.ServiceCallback

Override this method to handle successful REST call results.

success(T) - Method in class com.microsoft.rest.ServiceFuture

Invoke this method to report completed, allowing AbstractFuture.get() to be unblocked.

T

TokenCredentials - Class in com.microsoft.rest.credentials

Token based credentials for use with a REST Service Client.

TokenCredentials(String, String) - Constructor for class com.microsoft.rest.credentials.TokenCredentials

Initializes a new instance of the TokenCredentials.

toString() - Method in class com.microsoft.rest.Base64Url

toString() - Method in class com.microsoft.rest.DateTimeRfc1123

toString() - Method in class com.microsoft.rest.ExpandableStringEnum

U

url(Environment.Endpoint) - Method in interface com.microsoft.rest.protocol.Environment

Provides a URL for the endpoint.

useHttpClientThreadPool(boolean) - Method in class com.microsoft.rest.RestClient.Builder

Sets whether to use the thread pool in OkHttp client or RxJava schedulers.

userAgent() - Method in class com.microsoft.rest.interceptors.UserAgentInterceptor

UserAgentInterceptor - Class in com.microsoft.rest.interceptors

User agent interceptor for putting a 'User-Agent' header in the request.

UserAgentInterceptor() - Constructor for class com.microsoft.rest.interceptors.UserAgentInterceptor

Initialize an instance of UserAgentInterceptor class with the default 'User-Agent' header.

V

validate(Object) - Static method in class com.microsoft.rest.Validator

Validates a user provided required parameter to be not null.

Validator - Class in com.microsoft.rest

Validates user provided parameters are not null if they are required.

valueOf(String) - Static method in enum com.microsoft.rest.CollectionFormat

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.microsoft.rest.LogLevel

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.microsoft.rest.CollectionFormat

Returns an array containing the constants of this enum type, in the order they are declared.

values(Class<T>) - Static method in class com.microsoft.rest.ExpandableStringEnum

values() - Static method in enum com.microsoft.rest.LogLevel

Returns an array containing the constants of this enum type, in the order they are declared.

W

withBaseUrl(String) - Method in class com.microsoft.rest.RestClient.Builder

Sets the dynamic base URL.

withBaseUrl(Environment, Environment.Endpoint) - Method in class com.microsoft.rest.RestClient.Builder

Sets the base URL with the default from the Environment.

withBody(T) - Method in class com.microsoft.rest.ServiceResponse

Sets the response object.

withCallbackExecutor(Executor) - Method in class com.microsoft.rest.RestClient.Builder

Sets the executor for async callbacks to run on.

withConnectionPool(ConnectionPool) - Method in class com.microsoft.rest.RestClient.Builder

Sets the connection pool for the Http client.

withConnectionTimeout(long, TimeUnit) - Method in class com.microsoft.rest.RestClient.Builder

Set the connection timeout on the HTTP client.

withCredentials(ServiceClientCredentials) - Method in class com.microsoft.rest.RestClient.Builder

Sets the credentials.

withDispatcher(Dispatcher) - Method in class com.microsoft.rest.RestClient.Builder

Sets the dispatcher used in OkHttp client.

withInterceptor(Interceptor) - Method in class com.microsoft.rest.RestClient.Builder

Add an interceptor the Http client pipeline.

withLogLevel(LogLevel) - Method in class com.microsoft.rest.interceptors.LoggingInterceptor

Sets the current logging level.

withLogLevel(LogLevel) - Method in class com.microsoft.rest.RestClient.Builder

Sets the HTTP log level.

withLogLevel(LogLevel) - Method in class com.microsoft.rest.RestClient

Set the current HTTP traffic logging level.

withMaxIdleConnections(int) - Method in class com.microsoft.rest.RestClient.Builder

Deprecated.

use RestClient.Builder.withConnectionPool(ConnectionPool) instead

withNameValue(String, T, Class<T>) - Method in class com.microsoft.rest.ExpandableStringEnum

withNetworkInterceptor(Interceptor) - Method in class com.microsoft.rest.RestClient.Builder

Add an interceptor the network layer of Http client pipeline.

withPrettyJson(boolean) - Method in enum com.microsoft.rest.LogLevel

Specifies whether to log prettified JSON.

withProxy(Proxy) - Method in class com.microsoft.rest.RestClient.Builder

Sets the proxy for the HTTP client.

withProxyAuthenticator(Authenticator) - Method in class com.microsoft.rest.RestClient.Builder

Sets the proxy authenticator for the HTTP client.

withReadTimeout(long, TimeUnit) - Method in class com.microsoft.rest.RestClient.Builder

Set the read timeout on the HTTP client.

withResponseBuilderFactory(ResponseBuilder.Factory) - Method in class com.microsoft.rest.RestClient.Builder

Sets the response builder factory.

withRetryStrategy(RetryStrategy) - Method in class com.microsoft.rest.RestClient.Builder

Adds a retry strategy to the client.

withSerializerAdapter(SerializerAdapter<?>) - Method in class com.microsoft.rest.RestClient.Builder

Sets the serialization adapter.

withThrowOnGet404(boolean) - Method in class com.microsoft.rest.ServiceResponseBuilder

Specifies whether to throw on 404 responses from a GET call.

withUserAgent(String) - Method in class com.microsoft.rest.interceptors.UserAgentInterceptor

Overwrite the User-Agent header.

withUserAgent(String) - Method in class com.microsoft.rest.RestClient.Builder

Sets the user agent header.

A B C D E F G H I J L N R S T U V W