com.apollographql.apollo.api

Class Operation.Variables

java.lang.Object

com.apollographql.apollo.api.Operation.Variables

Enclosing interface:

Operation<D extends Operation.Data,T,V extends Operation.Variables>

public static class Operation.Variables
extends java.lang.Object

Abstraction for the variables which are a part of the GraphQL operation. For example, for the following GraphQL operation, Variables represents values for GraphQL '$type' and '$limit' variables:

      query FeedQuery($type: FeedType!, $limit: Int!) {
          feedEntries: feed(type: $type, limit: $limit) {
          id
          repository {
              ...RepositoryFragment
          }
          postedBy {
            login
          }
      }
    }
 
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Variables()

Method Summary

Modifier and Type	Method and Description
java.lang.String	marshal() Serializes variables as JSON string to be sent to the GraphQL server.
java.lang.String	marshal(ScalarTypeAdapters scalarTypeAdapters) Serializes variables as JSON string to be sent to the GraphQL server.
InputFieldMarshaller	marshaller()
java.util.Map<java.lang.String,java.lang.Object>	valueMap()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Variables

protected Variables()

Method Detail

valueMap

@NotNull
public java.util.Map<java.lang.String,java.lang.Object> valueMap()

marshaller

@NotNull
public InputFieldMarshaller marshaller()

marshal

public final java.lang.String marshal()
                               throws java.io.IOException

Serializes variables as JSON string to be sent to the GraphQL server.

Returns:

JSON string

Throws:

java.io.IOException

marshal

public final java.lang.String marshal(@NotNull
                                      ScalarTypeAdapters scalarTypeAdapters)
                               throws java.io.IOException

Serializes variables as JSON string to be sent to the GraphQL server.

Parameters:

scalarTypeAdapters - adapters for custom GraphQL scalar types

Returns:

JSON string

Throws:

java.io.IOException