Module org.kohsuke.github.api

Package org.kohsuke.github.internal.graphql.response

Class GHGraphQLResponse<T>

java.lang.Object

org.kohsuke.github.internal.graphql.response.GHGraphQLResponse<T>

Type Parameters:

T - the type of data

Direct Known Subclasses:

GHGraphQLResponse.ObjectResponse

public class GHGraphQLResponse<T>
extends Object

A response of GraphQL.

This class is used to parse the response of GraphQL.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GHGraphQLResponse.ObjectResponse	A GraphQL response with basic Object data type.

Constructor Summary

Constructors

Constructor	Description
GHGraphQLResponse(T data, List<org.kohsuke.github.internal.graphql.response.GHGraphQLResponse.GraphQLError> errors)

Method Summary

Modifier and Type	Method	Description
T	getData()
List<String>	getErrorMessages()
boolean	isSuccessful()

Methods inherited from class java.lang.Object

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

Constructor Details

GHGraphQLResponse

public GHGraphQLResponse(T data,
 List<org.kohsuke.github.internal.graphql.response.GHGraphQLResponse.GraphQLError> errors)

Parameters:

data - GraphQL success response

errors - GraphQL failure response, This will be empty if not fail

Method Details

isSuccessful

public boolean isSuccessful()

Returns:

request is succeeded. True when error list is empty.

getData

public T getData()

Returns:

GraphQL success response

getErrorMessages

public List<String> getErrorMessages()

Returns:

GraphQL error messages from Github Response. Empty list when no errors occurred.