com.shopify.buy3

Class Storefront.Metafield

java.lang.Object

com.shopify.graphql.support.AbstractResponse<Storefront.Metafield>

com.shopify.buy3.Storefront.Metafield

All Implemented Interfaces:

Storefront.Node, Node, java.io.Serializable

Enclosing class:

Storefront

public static class Storefront.Metafield
extends AbstractResponse<Storefront.Metafield>
implements Storefront.Node

Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are comprised of keys, values, and value types.

See Also:

Serialized Form

Field Summary

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

optimisticData, responseData

Constructor Summary

Constructors

Constructor and Description
Metafield()
Metafield(JsonObject fields)

Method Summary

Modifier and Type	Method and Description
DateTime	getCreatedAt() The date and time when the storefront metafield was created.
java.lang.String	getDescription() The description of a metafield.
java.lang.String	getGraphQlTypeName()
ID	getId() A globally-unique ID.
java.lang.String	getKey() The unique identifier for the metafield within its namespace.
java.lang.String	getNamespace() The container for a group of metafields that the metafield is associated with.
Storefront.MetafieldParentResource	getParentResource() The type of resource that the metafield is attached to.
Storefront.MetafieldReference	getReference() Returns a reference object if the metafield's type is a resource reference.
Storefront.MetafieldReferenceConnection	getReferences() A list of reference objects if the metafield's type is a resource reference list.
java.lang.String	getType() The type name of the metafield.
DateTime	getUpdatedAt() The date and time when the metafield was last updated.
java.lang.String	getValue() The data stored in the metafield.
Storefront.Metafield	setCreatedAt(DateTime arg)
Storefront.Metafield	setDescription(java.lang.String arg)
Storefront.Metafield	setKey(java.lang.String arg)
Storefront.Metafield	setNamespace(java.lang.String arg)
Storefront.Metafield	setParentResource(Storefront.MetafieldParentResource arg)
Storefront.Metafield	setReference(Storefront.MetafieldReference arg)
Storefront.Metafield	setReferences(Storefront.MetafieldReferenceConnection arg)
Storefront.Metafield	setType(java.lang.String arg)
Storefront.Metafield	setUpdatedAt(DateTime arg)
Storefront.Metafield	setValue(java.lang.String arg)
boolean	unwrapsToObject(java.lang.String key)

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

collectNodes, get, getFieldName, getKey, jsonAsArray, jsonAsBoolean, jsonAsDouble, jsonAsInteger, jsonAsObject, jsonAsString, withAlias

Methods inherited from class java.lang.Object

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

Constructor Detail

Metafield

public Metafield()

Metafield

public Metafield(JsonObject fields)
          throws SchemaViolationError

Throws:

SchemaViolationError

Method Detail

getGraphQlTypeName

public java.lang.String getGraphQlTypeName()

Specified by:

getGraphQlTypeName in interface Storefront.Node

Specified by:

getGraphQlTypeName in interface Node

getCreatedAt

public DateTime getCreatedAt()

The date and time when the storefront metafield was created.

setCreatedAt

public Storefront.Metafield setCreatedAt(DateTime arg)

getDescription

public java.lang.String getDescription()

The description of a metafield.

setDescription

public Storefront.Metafield setDescription(java.lang.String arg)

getId

public ID getId()

A globally-unique ID.

Specified by:

getId in interface Storefront.Node

Specified by:

getId in interface Node

getKey

public java.lang.String getKey()

The unique identifier for the metafield within its namespace.

setKey

public Storefront.Metafield setKey(java.lang.String arg)

getNamespace

public java.lang.String getNamespace()

The container for a group of metafields that the metafield is associated with.

setNamespace

public Storefront.Metafield setNamespace(java.lang.String arg)

getParentResource

public Storefront.MetafieldParentResource getParentResource()

The type of resource that the metafield is attached to.

setParentResource

public Storefront.Metafield setParentResource(Storefront.MetafieldParentResource arg)

getReference

public Storefront.MetafieldReference getReference()

Returns a reference object if the metafield's type is a resource reference.

setReference

public Storefront.Metafield setReference(Storefront.MetafieldReference arg)

getReferences

public Storefront.MetafieldReferenceConnection getReferences()

A list of reference objects if the metafield's type is a resource reference list.

setReferences

public Storefront.Metafield setReferences(Storefront.MetafieldReferenceConnection arg)

getType

public java.lang.String getType()

The type name of the metafield. Refer to the list of [supported types](https://shopify.dev/apps/metafields/definitions/types).

setType

public Storefront.Metafield setType(java.lang.String arg)

getUpdatedAt

public DateTime getUpdatedAt()

The date and time when the metafield was last updated.

setUpdatedAt

public Storefront.Metafield setUpdatedAt(DateTime arg)

getValue

public java.lang.String getValue()

The data stored in the metafield. Always stored as a string, regardless of the metafield's type.

setValue

public Storefront.Metafield setValue(java.lang.String arg)

unwrapsToObject

public boolean unwrapsToObject(java.lang.String key)

Specified by:

unwrapsToObject in class AbstractResponse<Storefront.Metafield>