GenericObject (Google Wallet API v1-rev20250506-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.walletobjects.model.GenericObject

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GenericObject
extends com.google.api.client.json.GenericJson
```
Generic Object
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Wallet API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

GenericObject()

Constructors
Constructor and Description
`GenericObject()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GenericObject`	`clone()`
`AppLinkData`	`getAppLinkData()` Optional app or website link that will be displayed as a button on the front of the pass.
`Barcode`	`getBarcode()` The barcode type and value.
`LocalizedString`	`getCardTitle()` Required.
`String`	`getClassId()` Required.
`String`	`getGenericType()` Specify which `GenericType` the card belongs to.
`GroupingInfo`	`getGroupingInfo()` Information that controls how passes are grouped together.
`Boolean`	`getHasUsers()` Indicates if the object has users.
`LocalizedString`	`getHeader()` Required.
`Image`	`getHeroImage()` Banner image displayed on the front of the card if present.
`String`	`getHexBackgroundColor()` The background color for the card.
`String`	`getId()` Required.
`List<ImageModuleData>`	`getImageModulesData()` Image module data.
`List<String>`	`getLinkedObjectIds()` linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this generic object.
`LinksModuleData`	`getLinksModuleData()` Links module data.
`Image`	`getLogo()` The logo image of the pass.
`List<MerchantLocation>`	`getMerchantLocations()` Merchant locations.
`List<Message>`	`getMessages()` An array of messages displayed in the app.
`Notifications`	`getNotifications()` The notification settings that are enabled for this object.
`PassConstraints`	`getPassConstraints()` Pass constraints for the object.
`RotatingBarcode`	`getRotatingBarcode()` The rotating barcode settings/details.
`SaveRestrictions`	`getSaveRestrictions()` Restrictions on the object that needs to be verified before the user tries to save the pass.
`String`	`getSmartTapRedemptionValue()` The value that will be transmitted to a Smart Tap certified terminal over NFC for this object.
`String`	`getState()` The state of the object.
`LocalizedString`	`getSubheader()` The title label of the pass, such as location where this pass can be used.
`List<TextModuleData>`	`getTextModulesData()` Text module data.
`TimeInterval`	`getValidTimeInterval()` The time period this object will be considered valid or usable.
`List<ValueAddedModuleData>`	`getValueAddedModuleData()` Optional value added module data.
`Image`	`getWideLogo()` The wide logo of the pass.
`GenericObject`	`set(String fieldName, Object value)`
`GenericObject`	`setAppLinkData(AppLinkData appLinkData)` Optional app or website link that will be displayed as a button on the front of the pass.
`GenericObject`	`setBarcode(Barcode barcode)` The barcode type and value.
`GenericObject`	`setCardTitle(LocalizedString cardTitle)` Required.
`GenericObject`	`setClassId(String classId)` Required.
`GenericObject`	`setGenericType(String genericType)` Specify which `GenericType` the card belongs to.
`GenericObject`	`setGroupingInfo(GroupingInfo groupingInfo)` Information that controls how passes are grouped together.
`GenericObject`	`setHasUsers(Boolean hasUsers)` Indicates if the object has users.
`GenericObject`	`setHeader(LocalizedString header)` Required.
`GenericObject`	`setHeroImage(Image heroImage)` Banner image displayed on the front of the card if present.
`GenericObject`	`setHexBackgroundColor(String hexBackgroundColor)` The background color for the card.
`GenericObject`	`setId(String id)` Required.
`GenericObject`	`setImageModulesData(List<ImageModuleData> imageModulesData)` Image module data.
`GenericObject`	`setLinkedObjectIds(List<String> linkedObjectIds)` linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this generic object.
`GenericObject`	`setLinksModuleData(LinksModuleData linksModuleData)` Links module data.
`GenericObject`	`setLogo(Image logo)` The logo image of the pass.
`GenericObject`	`setMerchantLocations(List<MerchantLocation> merchantLocations)` Merchant locations.
`GenericObject`	`setMessages(List<Message> messages)` An array of messages displayed in the app.
`GenericObject`	`setNotifications(Notifications notifications)` The notification settings that are enabled for this object.
`GenericObject`	`setPassConstraints(PassConstraints passConstraints)` Pass constraints for the object.
`GenericObject`	`setRotatingBarcode(RotatingBarcode rotatingBarcode)` The rotating barcode settings/details.
`GenericObject`	`setSaveRestrictions(SaveRestrictions saveRestrictions)` Restrictions on the object that needs to be verified before the user tries to save the pass.
`GenericObject`	`setSmartTapRedemptionValue(String smartTapRedemptionValue)` The value that will be transmitted to a Smart Tap certified terminal over NFC for this object.
`GenericObject`	`setState(String state)` The state of the object.
`GenericObject`	`setSubheader(LocalizedString subheader)` The title label of the pass, such as location where this pass can be used.
`GenericObject`	`setTextModulesData(List<TextModuleData> textModulesData)` Text module data.
`GenericObject`	`setValidTimeInterval(TimeInterval validTimeInterval)` The time period this object will be considered valid or usable.
`GenericObject`	`setValueAddedModuleData(List<ValueAddedModuleData> valueAddedModuleData)` Optional value added module data.
`GenericObject`	`setWideLogo(Image wideLogo)` The wide logo of the pass.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - GenericObject
```
public GenericObject()
```
- Method Detail
  - getAppLinkData
```
public AppLinkData getAppLinkData()
```
    Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
    
    Returns:
    
    value or null for none
  - setAppLinkData
```
public GenericObject setAppLinkData(AppLinkData appLinkData)
```
    Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed.
    
    Parameters:
    
    appLinkData - appLinkData or null for none
  - getBarcode
```
public Barcode getBarcode()
```
    The barcode type and value. If pass does not have a barcode, we can allow the issuer to set Barcode.alternate_text and display just that.
    
    Returns:
    
    value or null for none
  - setBarcode
```
public GenericObject setBarcode(Barcode barcode)
```
    The barcode type and value. If pass does not have a barcode, we can allow the issuer to set Barcode.alternate_text and display just that.
    
    Parameters:
    
    barcode - barcode or null for none
  - getCardTitle
```
public LocalizedString getCardTitle()
```
    Required. The header of the pass. This is usually the Business name such as "XXX Gym", "AAA Insurance". This field is required and appears in the header row at the very top of the pass.
    
    Returns:
    
    value or null for none
  - setCardTitle
```
public GenericObject setCardTitle(LocalizedString cardTitle)
```
    Required. The header of the pass. This is usually the Business name such as "XXX Gym", "AAA Insurance". This field is required and appears in the header row at the very top of the pass.
    
    Parameters:
    
    cardTitle - cardTitle or null for none
  - getClassId
```
public String getClassId()
```
    Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you.
    
    Returns:
    
    value or null for none
  - setClassId
```
public GenericObject setClassId(String classId)
```
    Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you.
    
    Parameters:
    
    classId - classId or null for none
  - getGenericType
```
public String getGenericType()
```
    Specify which `GenericType` the card belongs to.
    
    Returns:
    
    value or null for none
  - setGenericType
```
public GenericObject setGenericType(String genericType)
```
    Specify which `GenericType` the card belongs to.
    
    Parameters:
    
    genericType - genericType or null for none
  - getGroupingInfo
```
public GroupingInfo getGroupingInfo()
```
    Information that controls how passes are grouped together.
    
    Returns:
    
    value or null for none
  - setGroupingInfo
```
public GenericObject setGroupingInfo(GroupingInfo groupingInfo)
```
    Information that controls how passes are grouped together.
    
    Parameters:
    
    groupingInfo - groupingInfo or null for none
  - getHasUsers
```
public Boolean getHasUsers()
```
    Indicates if the object has users. This field is set by the platform.
    
    Returns:
    
    value or null for none
  - setHasUsers
```
public GenericObject setHasUsers(Boolean hasUsers)
```
    Indicates if the object has users. This field is set by the platform.
    
    Parameters:
    
    hasUsers - hasUsers or null for none
  - getHeader
```
public LocalizedString getHeader()
```
    Required. The title of the pass, such as "50% off coupon" or "Library card" or "Voucher". This field is required and appears in the title row of the pass detail view.
    
    Returns:
    
    value or null for none
  - setHeader
```
public GenericObject setHeader(LocalizedString header)
```
    Required. The title of the pass, such as "50% off coupon" or "Library card" or "Voucher". This field is required and appears in the title row of the pass detail view.
    
    Parameters:
    
    header - header or null for none
  - getHeroImage
```
public Image getHeroImage()
```
    Banner image displayed on the front of the card if present. The image will be displayed at 100% width.
    
    Returns:
    
    value or null for none
  - setHeroImage
```
public GenericObject setHeroImage(Image heroImage)
```
    Banner image displayed on the front of the card if present. The image will be displayed at 100% width.
    
    Parameters:
    
    heroImage - heroImage or null for none
  - getHexBackgroundColor
```
public String getHexBackgroundColor()
```
    The background color for the card. If not set, the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used and if logo is not set, a color would be chosen by Google.
    
    Returns:
    
    value or null for none
  - setHexBackgroundColor
```
public GenericObject setHexBackgroundColor(String hexBackgroundColor)
```
    The background color for the card. If not set, the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used and if logo is not set, a color would be chosen by Google.
    
    Parameters:
    
    hexBackgroundColor - hexBackgroundColor or null for none
  - getId
```
public String getId()
```
    Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value needs to follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you. The unique identifier can only include alphanumeric characters, `.`, `_`, or `-`.
    
    Returns:
    
    value or null for none
  - setId
```
public GenericObject setId(String id)
```
    Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value needs to follow the format `issuerID.identifier` where `issuerID` is issued by Google and `identifier` is chosen by you. The unique identifier can only include alphanumeric characters, `.`, `_`, or `-`.
    
    Parameters:
    
    id - id or null for none
  - getImageModulesData
```
public List<ImageModuleData> getImageModulesData()
```
    Image module data. Only one of the image from class and one from object level will be rendered when both set.
    
    Returns:
    
    value or null for none
  - setImageModulesData
```
public GenericObject setImageModulesData(List<ImageModuleData> imageModulesData)
```
    Image module data. Only one of the image from class and one from object level will be rendered when both set.
    
    Parameters:
    
    imageModulesData - imageModulesData or null for none
  - getLinkedObjectIds
```
public List<String> getLinkedObjectIds()
```
    linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this generic object. If a user had saved this generic card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.
    
    Returns:
    
    value or null for none
  - setLinkedObjectIds
```
public GenericObject setLinkedObjectIds(List<String> linkedObjectIds)
```
    linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this generic object. If a user had saved this generic card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.
    
    Parameters:
    
    linkedObjectIds - linkedObjectIds or null for none
  - getLinksModuleData
```
public LinksModuleData getLinksModuleData()
```
    Links module data. If `linksModuleData` is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
    
    Returns:
    
    value or null for none
  - setLinksModuleData
```
public GenericObject setLinksModuleData(LinksModuleData linksModuleData)
```
    Links module data. If `linksModuleData` is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
    
    Parameters:
    
    linksModuleData - linksModuleData or null for none
  - getLogo
```
public Image getLogo()
```
    The logo image of the pass. This image is displayed in the card detail view in upper left, and also on the list/thumbnail view. If the logo is not present, the first letter of `cardTitle` would be shown as logo.
    
    Returns:
    
    value or null for none
  - setLogo
```
public GenericObject setLogo(Image logo)
```
    The logo image of the pass. This image is displayed in the card detail view in upper left, and also on the list/thumbnail view. If the logo is not present, the first letter of `cardTitle` would be shown as logo.
    
    Parameters:
    
    logo - logo or null for none
  - getMerchantLocations
```
public List<MerchantLocation> getMerchantLocations()
```
    Merchant locations. There is a maximum of ten on the object. Any additional MerchantLocations added beyond the 10 will be rejected. These locations will trigger a notification when a user enters within a Google-set radius of the point. This field replaces the deprecated LatLongPoints.
    
    Returns:
    
    value or null for none
  - setMerchantLocations
```
public GenericObject setMerchantLocations(List<MerchantLocation> merchantLocations)
```
    Merchant locations. There is a maximum of ten on the object. Any additional MerchantLocations added beyond the 10 will be rejected. These locations will trigger a notification when a user enters within a Google-set radius of the point. This field replaces the deprecated LatLongPoints.
    
    Parameters:
    
    merchantLocations - merchantLocations or null for none
  - getMessages
```
public List<Message> getMessages()
```
    An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
    
    Returns:
    
    value or null for none
  - setMessages
```
public GenericObject setMessages(List<Message> messages)
```
    An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.
    
    Parameters:
    
    messages - messages or null for none
  - getNotifications
```
public Notifications getNotifications()
```
    The notification settings that are enabled for this object.
    
    Returns:
    
    value or null for none
  - setNotifications
```
public GenericObject setNotifications(Notifications notifications)
```
    The notification settings that are enabled for this object.
    
    Parameters:
    
    notifications - notifications or null for none
  - getPassConstraints
```
public PassConstraints getPassConstraints()
```
    Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
    
    Returns:
    
    value or null for none
  - setPassConstraints
```
public GenericObject setPassConstraints(PassConstraints passConstraints)
```
    Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
    
    Parameters:
    
    passConstraints - passConstraints or null for none
  - getRotatingBarcode
```
public RotatingBarcode getRotatingBarcode()
```
    The rotating barcode settings/details.
    
    Returns:
    
    value or null for none
  - setRotatingBarcode
```
public GenericObject setRotatingBarcode(RotatingBarcode rotatingBarcode)
```
    The rotating barcode settings/details.
    
    Parameters:
    
    rotatingBarcode - rotatingBarcode or null for none
  - getSaveRestrictions
```
public SaveRestrictions getSaveRestrictions()
```
    Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass.
    
    Returns:
    
    value or null for none
  - setSaveRestrictions
```
public GenericObject setSaveRestrictions(SaveRestrictions saveRestrictions)
```
    Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass.
    
    Parameters:
    
    saveRestrictions - saveRestrictions or null for none
  - getSmartTapRedemptionValue
```
public String getSmartTapRedemptionValue()
```
    The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
    
    Returns:
    
    value or null for none
  - setSmartTapRedemptionValue
```
public GenericObject setSmartTapRedemptionValue(String smartTapRedemptionValue)
```
    The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.
    
    Parameters:
    
    smartTapRedemptionValue - smartTapRedemptionValue or null for none
  - getState
```
public String getState()
```
    The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. If this is not provided, the object would be considered `ACTIVE`.
    
    Returns:
    
    value or null for none
  - setState
```
public GenericObject setState(String state)
```
    The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. If this is not provided, the object would be considered `ACTIVE`.
    
    Parameters:
    
    state - state or null for none
  - getSubheader
```
public LocalizedString getSubheader()
```
    The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view.
    
    Returns:
    
    value or null for none
  - setSubheader
```
public GenericObject setSubheader(LocalizedString subheader)
```
    The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view.
    
    Parameters:
    
    subheader - subheader or null for none
  - getTextModulesData
```
public List<TextModuleData> getTextModulesData()
```
    Text module data. If `textModulesData` is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
    
    Returns:
    
    value or null for none
  - setTextModulesData
```
public GenericObject setTextModulesData(List<TextModuleData> textModulesData)
```
    Text module data. If `textModulesData` is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object.
    
    Parameters:
    
    textModulesData - textModulesData or null for none
  - getValidTimeInterval
```
public TimeInterval getValidTimeInterval()
```
    The time period this object will be considered valid or usable. When the time period is passed, the object will be considered expired, which will affect the rendering on user's devices.
    
    Returns:
    
    value or null for none
  - setValidTimeInterval
```
public GenericObject setValidTimeInterval(TimeInterval validTimeInterval)
```
    The time period this object will be considered valid or usable. When the time period is passed, the object will be considered expired, which will affect the rendering on user's devices.
    
    Parameters:
    
    validTimeInterval - validTimeInterval or null for none
  - getValueAddedModuleData
```
public List<ValueAddedModuleData> getValueAddedModuleData()
```
    Optional value added module data. Maximum of ten on the object.
    
    Returns:
    
    value or null for none
  - setValueAddedModuleData
```
public GenericObject setValueAddedModuleData(List<ValueAddedModuleData> valueAddedModuleData)
```
    Optional value added module data. Maximum of ten on the object.
    
    Parameters:
    
    valueAddedModuleData - valueAddedModuleData or null for none
  - getWideLogo
```
public Image getWideLogo()
```
    The wide logo of the pass. When provided, this will be used in place of the logo in the top left of the card view.
    
    Returns:
    
    value or null for none
  - setWideLogo
```
public GenericObject setWideLogo(Image wideLogo)
```
    The wide logo of the pass. When provided, this will be used in place of the logo in the top left of the card view.
    
    Parameters:
    
    wideLogo - wideLogo or null for none
  - set
```
public GenericObject set(String fieldName,
                         Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GenericObject clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GenericObject

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GenericObject

Method Detail

getAppLinkData

setAppLinkData

getBarcode

setBarcode

getCardTitle

setCardTitle

getClassId

setClassId

getGenericType

setGenericType

getGroupingInfo

setGroupingInfo

getHasUsers

setHasUsers

getHeader

setHeader

getHeroImage

setHeroImage

getHexBackgroundColor

setHexBackgroundColor

getId

setId

getImageModulesData

setImageModulesData

getLinkedObjectIds

setLinkedObjectIds

getLinksModuleData

setLinksModuleData

getLogo

setLogo

getMerchantLocations

setMerchantLocations

getMessages

setMessages

getNotifications

setNotifications

getPassConstraints

setPassConstraints

getRotatingBarcode

setRotatingBarcode

getSaveRestrictions

setSaveRestrictions

getSmartTapRedemptionValue

setSmartTapRedemptionValue

getState

setState

getSubheader

setSubheader

getTextModulesData

setTextModulesData

getValidTimeInterval

setValidTimeInterval

getValueAddedModuleData

setValueAddedModuleData

getWideLogo

setWideLogo

set

clone