com.commercetools.sync.commons.helpers

Class ResourceKeyIdGraphQlRequest

java.lang.Object

com.commercetools.sync.commons.helpers.ResourceKeyIdGraphQlRequest

All Implemented Interfaces:

io.sphere.sdk.client.SphereRequest<ResourceKeyIdGraphQlResult>

public class ResourceKeyIdGraphQlRequest
extends java.lang.Object
implements io.sphere.sdk.client.SphereRequest<ResourceKeyIdGraphQlResult>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<java.lang.String>	keysToSearch
protected GraphQlQueryResources	resource

Constructor Summary

Constructors

Constructor and Description
ResourceKeyIdGraphQlRequest(java.util.Set<java.lang.String> keysToSearch, GraphQlQueryResources resource) A SphereRequest implementation to allow SphereClient to execute graphQL queries on CTP.

Method Summary

Modifier and Type	Method and Description
ResourceKeyIdGraphQlResult	deserialize(io.sphere.sdk.http.HttpResponse httpResponse)
io.sphere.sdk.client.HttpRequestIntent	httpRequestIntent()
ResourceKeyIdGraphQlRequest	withLimit(long limit) This method adds a limit to the request.
ResourceKeyIdGraphQlRequest	withPredicate(java.lang.String predicate) This method adds a predicate string to the request.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.sphere.sdk.client.SphereRequest

canDeserialize

Field Detail

keysToSearch

protected final java.util.Set<java.lang.String> keysToSearch

resource

protected final GraphQlQueryResources resource

Constructor Detail

ResourceKeyIdGraphQlRequest

public ResourceKeyIdGraphQlRequest(@Nonnull
                                   java.util.Set<java.lang.String> keysToSearch,
                                   @Nonnull
                                   GraphQlQueryResources resource)

A SphereRequest implementation to allow SphereClient to execute graphQL queries on CTP. It provides a POST request to the CTP graphql API containing body to fetch a set of ids matching given keys of a resource defined in endpoint parameter.

Parameters:

keysToSearch - - a set of keys to fetch matching ids for.

resource - - a string representing the name of the resource endpoint.

Method Detail

withPredicate

@Nonnull
public ResourceKeyIdGraphQlRequest withPredicate(java.lang.String predicate)

This method adds a predicate string to the request.

Parameters:

predicate - - a string representing a query predicate.

Returns:

- an instance of this class.

withLimit

@Nonnull
public ResourceKeyIdGraphQlRequest withLimit(long limit)

This method adds a limit to the request.

Parameters:

limit - - a number representing the query limit parameter

Returns:

- an instance of this class

deserialize

@Nullable
public ResourceKeyIdGraphQlResult deserialize(io.sphere.sdk.http.HttpResponse httpResponse)

Specified by:

deserialize in interface io.sphere.sdk.client.SphereRequest<ResourceKeyIdGraphQlResult>

httpRequestIntent

public io.sphere.sdk.client.HttpRequestIntent httpRequestIntent()

Specified by:

httpRequestIntent in interface io.sphere.sdk.client.SphereRequest<ResourceKeyIdGraphQlResult>