com.shopify.buy3

Class Storefront.ApiVersion

java.lang.Object

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

com.shopify.buy3.Storefront.ApiVersion

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

Storefront

public static class Storefront.ApiVersion
extends AbstractResponse<Storefront.ApiVersion>

A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning). Versions are commonly referred to by their handle (for example, `2021-10`).

See Also:

Serialized Form

Field Summary

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

optimisticData, responseData

Constructor Summary

Constructors

Constructor and Description
ApiVersion()
ApiVersion(JsonObject fields)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayName() The human-readable name of the version.
java.lang.String	getGraphQlTypeName()
java.lang.String	getHandle() The unique identifier of an ApiVersion.
java.lang.Boolean	getSupported() Whether the version is actively supported by Shopify.
Storefront.ApiVersion	setDisplayName(java.lang.String arg)
Storefront.ApiVersion	setHandle(java.lang.String arg)
Storefront.ApiVersion	setSupported(java.lang.Boolean 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

ApiVersion

public ApiVersion()

ApiVersion

public ApiVersion(JsonObject fields)
           throws SchemaViolationError

Throws:

SchemaViolationError

Method Detail

getGraphQlTypeName

public java.lang.String getGraphQlTypeName()

getDisplayName

public java.lang.String getDisplayName()

The human-readable name of the version.

setDisplayName

public Storefront.ApiVersion setDisplayName(java.lang.String arg)

getHandle

public java.lang.String getHandle()

The unique identifier of an ApiVersion. All supported API versions have a date-based (YYYY-MM) or `unstable` handle.

setHandle

public Storefront.ApiVersion setHandle(java.lang.String arg)

getSupported

public java.lang.Boolean getSupported()

Whether the version is actively supported by Shopify. Supported API versions are guaranteed to be stable. Unsupported API versions include unstable, release candidate, and end-of-life versions that are marked as unsupported. For more information, refer to [Versioning](https://shopify.dev/api/usage/versioning).

setSupported

public Storefront.ApiVersion setSupported(java.lang.Boolean arg)

unwrapsToObject

public boolean unwrapsToObject(java.lang.String key)

Specified by:

unwrapsToObject in class AbstractResponse<Storefront.ApiVersion>