com.adobe.cq.commerce.magento.graphql

Class EntityUrlQuery

java.lang.Object

com.shopify.graphql.support.AbstractQuery<EntityUrlQuery>

com.adobe.cq.commerce.magento.graphql.EntityUrlQuery

public class EntityUrlQuery
extends AbstractQuery<EntityUrlQuery>

EntityUrl is an output object containing the `id`, `relative_url`, and `type` attributes

Field Summary

Fields inherited from class com.shopify.graphql.support.AbstractQuery

_queryBuilder, ALIAS_SUFFIX_SEPARATOR, CUSTOM_FIELD_LABEL

Method Summary

Modifier and Type	Method and Description
EntityUrlQuery	addFragmentReference(Fragment<EntityUrlQuery> fragment) Adds a EntityUrlQuery fragment reference at the current position of the query.
EntityUrlQuery	canonicalUrl() Deprecated. The canonical_url field is deprecated, use relative_url instead.
static Fragment<EntityUrlQuery>	createFragment(String name, EntityUrlQueryDefinition queryDef) Creates a GraphQL "named" fragment with the specified query type definition.
EntityUrlQuery	entityUid() The unique ID for a `ProductInterface`, `CategoryInterface`, `CmsPage`, etc.
EntityUrlQuery	id() Deprecated. Use `entity_uid` instead.
EntityUrlQuery	redirectCode() 301 or 302 HTTP code for url permanent or temporary redirect or 0 for the 200 no redirect
EntityUrlQuery	relativeUrl() The internal relative URL.
EntityUrlQuery	type() One of PRODUCT, CATEGORY, or CMS_PAGE.

Methods inherited from class com.shopify.graphql.support.AbstractQuery

addCustomObjectField, addCustomSimpleField, appendQuotedString, startField, startInlineFragment, withAlias

Methods inherited from class java.lang.Object

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

Method Detail

canonicalUrl

@Deprecated
public EntityUrlQuery canonicalUrl()

Deprecated. The canonical_url field is deprecated, use relative_url instead.

entityUid

public EntityUrlQuery entityUid()

The unique ID for a `ProductInterface`, `CategoryInterface`, `CmsPage`, etc. object associated with the specified url. This could be a product UID, category UID, or cms page UID.

id

@Deprecated
public EntityUrlQuery id()

Deprecated. Use `entity_uid` instead.

The ID assigned to the object associated with the specified url. This could be a product ID, category ID, or page ID.

redirectCode

public EntityUrlQuery redirectCode()

301 or 302 HTTP code for url permanent or temporary redirect or 0 for the 200 no redirect

relativeUrl

public EntityUrlQuery relativeUrl()

The internal relative URL. If the specified url is a redirect, the query returns the redirected URL, not the original.

type

public EntityUrlQuery type()

One of PRODUCT, CATEGORY, or CMS_PAGE.

createFragment

public static Fragment<EntityUrlQuery> createFragment(String name,
                                                      EntityUrlQueryDefinition queryDef)

Creates a GraphQL "named" fragment with the specified query type definition. The generics nature of fragments ensures that a fragment can only be used at the right place in the GraphQL request.

Parameters:

name - The name of the fragment, must be unique for a given GraphQL request.

queryDef - The fragment definition.

Returns:

The fragment of a given generics type.

addFragmentReference

public EntityUrlQuery addFragmentReference(Fragment<EntityUrlQuery> fragment)

Adds a EntityUrlQuery fragment reference at the current position of the query. For example for a fragment named test, calling this method will add the reference ...test in the query. For GraphQL types implementing an interface, there will be some similar methods using the Query type of each implemented interface.

Parameters:

fragment - The fragment to reference.