apollo-api/com.apollographql.apollo.api/ApolloRequest

ApolloRequest

class ApolloRequest<D : Operation.Data> : ExecutionOptions

An ApolloRequest represents a GraphQL request to execute.

ApolloRequest is immutable and is usually constructed from com.apollographql.apollo.ApolloCall.

You can mutate an ApolloRequest by calling newBuilder:

val newRequest = apolloRequest.newBuilder().addHttpHeader("Authorization", "Bearer $token").build()

Types

Builder

class Builder<D : Operation.Data>(val operation: Operation<D>) : MutableExecutionOptions<ApolloRequest.Builder<D>>

Properties

canBeBatched

open override val canBeBatched: Boolean?

Whether the request can be batched. Used by com.apollographql.apollo.network.http.BatchingHttpInterceptor

enableAutoPersistedQueries

open override val enableAutoPersistedQueries: Boolean?

Whether to enable Auto Persisted Queries and try to send a hashed query first. Used by com.apollographql.apollo.interceptor.AutoPersistedQueryInterceptor

executionContext

open override val executionContext: ExecutionContext

The ExecutionContext to use for the request.

failFastIfOffline

@ApolloExperimental

val failFastIfOffline: Boolean?

httpHeaders

open override val httpHeaders: List<HttpHeader>?

HTTP headers to use for the request. Used by com.apollographql.apollo.api.http.DefaultHttpRequestComposer

httpMethod

open override val httpMethod: HttpMethod?

The HTTP method to use for the request.

ignoreApolloClientHttpHeaders

val ignoreApolloClientHttpHeaders: Boolean?

operation

val operation: Operation<D>

the GraphQL operation for this request

requestUuid

val requestUuid: Uuid

a unique id for this request. For queries and mutations, this is only used for debug. For subscriptions, it is used as subscription id when multiplexing several subscription over a WebSocket.

retryOnError

@ApolloExperimental

val retryOnError: Boolean?

sendApqExtensions

open override val sendApqExtensions: Boolean?

Whether to send the Auto Persisted Queries extensions. Used by com.apollographql.apollo.api.http.DefaultHttpRequestComposer

sendDocument

open override val sendDocument: Boolean?

Whether to send the document. Used by com.apollographql.apollo.api.http.DefaultHttpRequestComposer