TransitObject (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.TransitObject

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class TransitObject
extends com.google.api.client.json.GenericJson
```
Model definition for TransitObject.
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

TransitObject()

Constructors
Constructor and Description
`TransitObject()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TransitObject`	`clone()`
`ActivationStatus`	`getActivationStatus()` The activation status for the object.
`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.
`String`	`getClassId()` Required.
`TransitClass`	`getClassReference()` A copy of the inherited fields of the parent class.
`String`	`getConcessionCategory()` The concession category for the ticket.
`LocalizedString`	`getCustomConcessionCategory()` A custom concession category to use when `concessionCategory` does not provide the right option.
`LocalizedString`	`getCustomTicketStatus()` A custom status to use for the ticket status value when `ticketStatus` does not provide the right option.
`DeviceContext`	`getDeviceContext()` Device context associated with the object.
`Boolean`	`getDisableExpirationNotification()` Indicates if notifications should explicitly be suppressed.
`GroupingInfo`	`getGroupingInfo()` Information that controls how passes are grouped together.
`Boolean`	`getHasLinkedDevice()` Whether this object is currently linked to a single device.
`Boolean`	`getHasUsers()` Indicates if the object has users.
`Image`	`getHeroImage()` Optional banner image displayed on the front of the card.
`String`	`getHexBackgroundColor()` The background color for the card.
`String`	`getId()` Required.
`List<ImageModuleData>`	`getImageModulesData()` Image module data.
`InfoModuleData`	`getInfoModuleData()` Deprecated.
`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 transit object.
`LinksModuleData`	`getLinksModuleData()` Links module data.
`List<LatLongPoint>`	`getLocations()` Note: This field is currently not supported to trigger geo notifications.
`List<MerchantLocation>`	`getMerchantLocations()` Merchant locations.
`List<Message>`	`getMessages()` An array of messages displayed in the app.
`String`	`getNotifyPreference()` Whether or not field updates to this object should trigger notifications.
`PassConstraints`	`getPassConstraints()` Pass constraints for the object.
`String`	`getPassengerNames()` The name(s) of the passengers the ticket is assigned to.
`String`	`getPassengerType()` The number of passengers.
`PurchaseDetails`	`getPurchaseDetails()` Purchase details for this ticket.
`RotatingBarcode`	`getRotatingBarcode()` The rotating barcode type and value.
`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()` Required.
`List<TextModuleData>`	`getTextModulesData()` Text module data.
`TicketLeg`	`getTicketLeg()` A single ticket leg contains departure and arrival information along with boarding and seating information.
`List<TicketLeg>`	`getTicketLegs()` Each ticket may contain one or more legs.
`String`	`getTicketNumber()` The number of the ticket.
`TicketRestrictions`	`getTicketRestrictions()` Information about what kind of restrictions there are on using this ticket.
`String`	`getTicketStatus()` The status of the ticket.
`String`	`getTripId()` This id is used to group tickets together if the user has saved multiple tickets for the same trip.
`String`	`getTripType()` Required.
`TimeInterval`	`getValidTimeInterval()` The time period this object will be `active` and object can be used.
`List<ValueAddedModuleData>`	`getValueAddedModuleData()` Optional value added module data.
`Long`	`getVersion()` Deprecated
`TransitObject`	`set(String fieldName, Object value)`
`TransitObject`	`setActivationStatus(ActivationStatus activationStatus)` The activation status for the object.
`TransitObject`	`setAppLinkData(AppLinkData appLinkData)` Optional app or website link that will be displayed as a button on the front of the pass.
`TransitObject`	`setBarcode(Barcode barcode)` The barcode type and value.
`TransitObject`	`setClassId(String classId)` Required.
`TransitObject`	`setClassReference(TransitClass classReference)` A copy of the inherited fields of the parent class.
`TransitObject`	`setConcessionCategory(String concessionCategory)` The concession category for the ticket.
`TransitObject`	`setCustomConcessionCategory(LocalizedString customConcessionCategory)` A custom concession category to use when `concessionCategory` does not provide the right option.
`TransitObject`	`setCustomTicketStatus(LocalizedString customTicketStatus)` A custom status to use for the ticket status value when `ticketStatus` does not provide the right option.
`TransitObject`	`setDeviceContext(DeviceContext deviceContext)` Device context associated with the object.
`TransitObject`	`setDisableExpirationNotification(Boolean disableExpirationNotification)` Indicates if notifications should explicitly be suppressed.
`TransitObject`	`setGroupingInfo(GroupingInfo groupingInfo)` Information that controls how passes are grouped together.
`TransitObject`	`setHasLinkedDevice(Boolean hasLinkedDevice)` Whether this object is currently linked to a single device.
`TransitObject`	`setHasUsers(Boolean hasUsers)` Indicates if the object has users.
`TransitObject`	`setHeroImage(Image heroImage)` Optional banner image displayed on the front of the card.
`TransitObject`	`setHexBackgroundColor(String hexBackgroundColor)` The background color for the card.
`TransitObject`	`setId(String id)` Required.
`TransitObject`	`setImageModulesData(List<ImageModuleData> imageModulesData)` Image module data.
`TransitObject`	`setInfoModuleData(InfoModuleData infoModuleData)` Deprecated.
`TransitObject`	`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 transit object.
`TransitObject`	`setLinksModuleData(LinksModuleData linksModuleData)` Links module data.
`TransitObject`	`setLocations(List<LatLongPoint> locations)` Note: This field is currently not supported to trigger geo notifications.
`TransitObject`	`setMerchantLocations(List<MerchantLocation> merchantLocations)` Merchant locations.
`TransitObject`	`setMessages(List<Message> messages)` An array of messages displayed in the app.
`TransitObject`	`setNotifyPreference(String notifyPreference)` Whether or not field updates to this object should trigger notifications.
`TransitObject`	`setPassConstraints(PassConstraints passConstraints)` Pass constraints for the object.
`TransitObject`	`setPassengerNames(String passengerNames)` The name(s) of the passengers the ticket is assigned to.
`TransitObject`	`setPassengerType(String passengerType)` The number of passengers.
`TransitObject`	`setPurchaseDetails(PurchaseDetails purchaseDetails)` Purchase details for this ticket.
`TransitObject`	`setRotatingBarcode(RotatingBarcode rotatingBarcode)` The rotating barcode type and value.
`TransitObject`	`setSaveRestrictions(SaveRestrictions saveRestrictions)` Restrictions on the object that needs to be verified before the user tries to save the pass.
`TransitObject`	`setSmartTapRedemptionValue(String smartTapRedemptionValue)` The value that will be transmitted to a Smart Tap certified terminal over NFC for this object.
`TransitObject`	`setState(String state)` Required.
`TransitObject`	`setTextModulesData(List<TextModuleData> textModulesData)` Text module data.
`TransitObject`	`setTicketLeg(TicketLeg ticketLeg)` A single ticket leg contains departure and arrival information along with boarding and seating information.
`TransitObject`	`setTicketLegs(List<TicketLeg> ticketLegs)` Each ticket may contain one or more legs.
`TransitObject`	`setTicketNumber(String ticketNumber)` The number of the ticket.
`TransitObject`	`setTicketRestrictions(TicketRestrictions ticketRestrictions)` Information about what kind of restrictions there are on using this ticket.
`TransitObject`	`setTicketStatus(String ticketStatus)` The status of the ticket.
`TransitObject`	`setTripId(String tripId)` This id is used to group tickets together if the user has saved multiple tickets for the same trip.
`TransitObject`	`setTripType(String tripType)` Required.
`TransitObject`	`setValidTimeInterval(TimeInterval validTimeInterval)` The time period this object will be `active` and object can be used.
`TransitObject`	`setValueAddedModuleData(List<ValueAddedModuleData> valueAddedModuleData)` Optional value added module data.
`TransitObject`	`setVersion(Long version)` Deprecated

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
  - TransitObject
```
public TransitObject()
```
- Method Detail
  - getActivationStatus
```
public ActivationStatus getActivationStatus()
```
    The activation status for the object. Required if the class has `activationOptions` set.
    
    Returns:
    
    value or null for none
  - setActivationStatus
```
public TransitObject setActivationStatus(ActivationStatus activationStatus)
```
    The activation status for the object. Required if the class has `activationOptions` set.
    
    Parameters:
    
    activationStatus - activationStatus or null for none
  - 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 TransitObject 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.
    
    Returns:
    
    value or null for none
  - setBarcode
```
public TransitObject setBarcode(Barcode barcode)
```
    The barcode type and value.
    
    Parameters:
    
    barcode - barcode 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 issuer ID.identifier where the former is issued by Google and latter is chosen by you.
    
    Returns:
    
    value or null for none
  - setClassId
```
public TransitObject 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 issuer ID.identifier where the former is issued by Google and latter is chosen by you.
    
    Parameters:
    
    classId - classId or null for none
  - getClassReference
```
public TransitClass getClassReference()
```
    A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
    
    Returns:
    
    value or null for none
  - setClassReference
```
public TransitObject setClassReference(TransitClass classReference)
```
    A copy of the inherited fields of the parent class. These fields are retrieved during a GET.
    
    Parameters:
    
    classReference - classReference or null for none
  - getConcessionCategory
```
public String getConcessionCategory()
```
    The concession category for the ticket.
    
    Returns:
    
    value or null for none
  - setConcessionCategory
```
public TransitObject setConcessionCategory(String concessionCategory)
```
    The concession category for the ticket.
    
    Parameters:
    
    concessionCategory - concessionCategory or null for none
  - getCustomConcessionCategory
```
public LocalizedString getCustomConcessionCategory()
```
    A custom concession category to use when `concessionCategory` does not provide the right option. Both `concessionCategory` and `customConcessionCategory` may not be set.
    
    Returns:
    
    value or null for none
  - setCustomConcessionCategory
```
public TransitObject setCustomConcessionCategory(LocalizedString customConcessionCategory)
```
    A custom concession category to use when `concessionCategory` does not provide the right option. Both `concessionCategory` and `customConcessionCategory` may not be set.
    
    Parameters:
    
    customConcessionCategory - customConcessionCategory or null for none
  - getCustomTicketStatus
```
public LocalizedString getCustomTicketStatus()
```
    A custom status to use for the ticket status value when `ticketStatus` does not provide the right option. Both `ticketStatus` and `customTicketStatus` may not be set.
    
    Returns:
    
    value or null for none
  - setCustomTicketStatus
```
public TransitObject setCustomTicketStatus(LocalizedString customTicketStatus)
```
    A custom status to use for the ticket status value when `ticketStatus` does not provide the right option. Both `ticketStatus` and `customTicketStatus` may not be set.
    
    Parameters:
    
    customTicketStatus - customTicketStatus or null for none
  - getDeviceContext
```
public DeviceContext getDeviceContext()
```
    Device context associated with the object.
    
    Returns:
    
    value or null for none
  - setDeviceContext
```
public TransitObject setDeviceContext(DeviceContext deviceContext)
```
    Device context associated with the object.
    
    Parameters:
    
    deviceContext - deviceContext or null for none
  - getDisableExpirationNotification
```
public Boolean getDisableExpirationNotification()
```
    Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.
    
    Returns:
    
    value or null for none
  - setDisableExpirationNotification
```
public TransitObject setDisableExpirationNotification(Boolean disableExpirationNotification)
```
    Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.
    
    Parameters:
    
    disableExpirationNotification - disableExpirationNotification or null for none
  - getGroupingInfo
```
public GroupingInfo getGroupingInfo()
```
    Information that controls how passes are grouped together.
    
    Returns:
    
    value or null for none
  - setGroupingInfo
```
public TransitObject setGroupingInfo(GroupingInfo groupingInfo)
```
    Information that controls how passes are grouped together.
    
    Parameters:
    
    groupingInfo - groupingInfo or null for none
  - getHasLinkedDevice
```
public Boolean getHasLinkedDevice()
```
    Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
    
    Returns:
    
    value or null for none
  - setHasLinkedDevice
```
public TransitObject setHasLinkedDevice(Boolean hasLinkedDevice)
```
    Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.
    
    Parameters:
    
    hasLinkedDevice - hasLinkedDevice 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 TransitObject setHasUsers(Boolean hasUsers)
```
    Indicates if the object has users. This field is set by the platform.
    
    Parameters:
    
    hasUsers - hasUsers or null for none
  - getHeroImage
```
public Image getHeroImage()
```
    Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
    
    Returns:
    
    value or null for none
  - setHeroImage
```
public TransitObject setHeroImage(Image heroImage)
```
    Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.
    
    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. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
    
    Returns:
    
    value or null for none
  - setHexBackgroundColor
```
public TransitObject 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. The format is #rrggbb where rrggbb is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #rgb, such as `#fc0`.
    
    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 should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
    
    Returns:
    
    value or null for none
  - setId
```
public TransitObject setId(String id)
```
    Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.
    
    Parameters:
    
    id - id or null for none
  - getImageModulesData
```
public List<ImageModuleData> getImageModulesData()
```
    Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
    
    Returns:
    
    value or null for none
  - setImageModulesData
```
public TransitObject setImageModulesData(List<ImageModuleData> imageModulesData)
```
    Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.
    
    Parameters:
    
    imageModulesData - imageModulesData or null for none
  - getInfoModuleData
```
public InfoModuleData getInfoModuleData()
```
    Deprecated. Use textModulesData instead.
    
    Returns:
    
    value or null for none
  - setInfoModuleData
```
public TransitObject setInfoModuleData(InfoModuleData infoModuleData)
```
    Deprecated. Use textModulesData instead.
    
    Parameters:
    
    infoModuleData - infoModuleData 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 transit object. If a user had saved this transit 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 TransitObject 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 transit object. If a user had saved this transit 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 links module data is also defined on the class, both will be displayed.
    
    Returns:
    
    value or null for none
  - setLinksModuleData
```
public TransitObject setLinksModuleData(LinksModuleData linksModuleData)
```
    Links module data. If links module data is also defined on the class, both will be displayed.
    
    Parameters:
    
    linksModuleData - linksModuleData or null for none
  - getLocations
```
public List<LatLongPoint> getLocations()
```
    Note: This field is currently not supported to trigger geo notifications.
    
    Returns:
    
    value or null for none
  - setLocations
```
public TransitObject setLocations(List<LatLongPoint> locations)
```
    Note: This field is currently not supported to trigger geo notifications.
    
    Parameters:
    
    locations - locations 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 TransitObject 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 TransitObject 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
  - getNotifyPreference
```
public String getNotifyPreference()
```
    Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
    
    Returns:
    
    value or null for none
  - setNotifyPreference
```
public TransitObject setNotifyPreference(String notifyPreference)
```
    Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered.
    
    Parameters:
    
    notifyPreference - notifyPreference 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 TransitObject setPassConstraints(PassConstraints passConstraints)
```
    Pass constraints for the object. Includes limiting NFC and screenshot behaviors.
    
    Parameters:
    
    passConstraints - passConstraints or null for none
  - getPassengerNames
```
public String getPassengerNames()
```
    The name(s) of the passengers the ticket is assigned to. The above `passengerType` field is meant to give Google context on this field.
    
    Returns:
    
    value or null for none
  - setPassengerNames
```
public TransitObject setPassengerNames(String passengerNames)
```
    The name(s) of the passengers the ticket is assigned to. The above `passengerType` field is meant to give Google context on this field.
    
    Parameters:
    
    passengerNames - passengerNames or null for none
  - getPassengerType
```
public String getPassengerType()
```
    The number of passengers.
    
    Returns:
    
    value or null for none
  - setPassengerType
```
public TransitObject setPassengerType(String passengerType)
```
    The number of passengers.
    
    Parameters:
    
    passengerType - passengerType or null for none
  - getPurchaseDetails
```
public PurchaseDetails getPurchaseDetails()
```
    Purchase details for this ticket.
    
    Returns:
    
    value or null for none
  - setPurchaseDetails
```
public TransitObject setPurchaseDetails(PurchaseDetails purchaseDetails)
```
    Purchase details for this ticket.
    
    Parameters:
    
    purchaseDetails - purchaseDetails or null for none
  - getRotatingBarcode
```
public RotatingBarcode getRotatingBarcode()
```
    The rotating barcode type and value.
    
    Returns:
    
    value or null for none
  - setRotatingBarcode
```
public TransitObject setRotatingBarcode(RotatingBarcode rotatingBarcode)
```
    The rotating barcode type and value.
    
    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 TransitObject 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 TransitObject 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()
```
    Required. 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.
    
    Returns:
    
    value or null for none
  - setState
```
public TransitObject setState(String state)
```
    Required. 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.
    
    Parameters:
    
    state - state or null for none
  - getTextModulesData
```
public List<TextModuleData> getTextModulesData()
```
    Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
    
    Returns:
    
    value or null for none
  - setTextModulesData
```
public TransitObject setTextModulesData(List<TextModuleData> textModulesData)
```
    Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.
    
    Parameters:
    
    textModulesData - textModulesData or null for none
  - getTicketLeg
```
public TicketLeg getTicketLeg()
```
    A single ticket leg contains departure and arrival information along with boarding and seating information. If more than one leg is to be specified then use the `ticketLegs` field instead. Both `ticketLeg` and `ticketLegs` may not be set.
    
    Returns:
    
    value or null for none
  - setTicketLeg
```
public TransitObject setTicketLeg(TicketLeg ticketLeg)
```
    A single ticket leg contains departure and arrival information along with boarding and seating information. If more than one leg is to be specified then use the `ticketLegs` field instead. Both `ticketLeg` and `ticketLegs` may not be set.
    
    Parameters:
    
    ticketLeg - ticketLeg or null for none
  - getTicketLegs
```
public List<TicketLeg> getTicketLegs()
```
    Each ticket may contain one or more legs. Each leg contains departure and arrival information along with boarding and seating information. If only one leg is to be specified then use the `ticketLeg` field instead. Both `ticketLeg` and `ticketLegs` may not be set.
    
    Returns:
    
    value or null for none
  - setTicketLegs
```
public TransitObject setTicketLegs(List<TicketLeg> ticketLegs)
```
    Each ticket may contain one or more legs. Each leg contains departure and arrival information along with boarding and seating information. If only one leg is to be specified then use the `ticketLeg` field instead. Both `ticketLeg` and `ticketLegs` may not be set.
    
    Parameters:
    
    ticketLegs - ticketLegs or null for none
  - getTicketNumber
```
public String getTicketNumber()
```
    The number of the ticket. This is a unique identifier for the ticket in the transit operator's system.
    
    Returns:
    
    value or null for none
  - setTicketNumber
```
public TransitObject setTicketNumber(String ticketNumber)
```
    The number of the ticket. This is a unique identifier for the ticket in the transit operator's system.
    
    Parameters:
    
    ticketNumber - ticketNumber or null for none
  - getTicketRestrictions
```
public TicketRestrictions getTicketRestrictions()
```
    Information about what kind of restrictions there are on using this ticket. For example, which days of the week it must be used, or which routes are allowed to be taken.
    
    Returns:
    
    value or null for none
  - setTicketRestrictions
```
public TransitObject setTicketRestrictions(TicketRestrictions ticketRestrictions)
```
    Information about what kind of restrictions there are on using this ticket. For example, which days of the week it must be used, or which routes are allowed to be taken.
    
    Parameters:
    
    ticketRestrictions - ticketRestrictions or null for none
  - getTicketStatus
```
public String getTicketStatus()
```
    The status of the ticket. For states which affect display, use the `state` field instead.
    
    Returns:
    
    value or null for none
  - setTicketStatus
```
public TransitObject setTicketStatus(String ticketStatus)
```
    The status of the ticket. For states which affect display, use the `state` field instead.
    
    Parameters:
    
    ticketStatus - ticketStatus or null for none
  - getTripId
```
public String getTripId()
```
    This id is used to group tickets together if the user has saved multiple tickets for the same trip.
    
    Returns:
    
    value or null for none
  - setTripId
```
public TransitObject setTripId(String tripId)
```
    This id is used to group tickets together if the user has saved multiple tickets for the same trip.
    
    Parameters:
    
    tripId - tripId or null for none
  - getTripType
```
public String getTripType()
```
    Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination.
    
    Returns:
    
    value or null for none
  - setTripType
```
public TransitObject setTripType(String tripType)
```
    Required. The type of trip this transit object represents. Used to determine the pass title and/or which symbol to use between the origin and destination.
    
    Parameters:
    
    tripType - tripType or null for none
  - getValidTimeInterval
```
public TimeInterval getValidTimeInterval()
```
    The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
    
    Returns:
    
    value or null for none
  - setValidTimeInterval
```
public TransitObject setValidTimeInterval(TimeInterval validTimeInterval)
```
    The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed.
    
    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 TransitObject setValueAddedModuleData(List<ValueAddedModuleData> valueAddedModuleData)
```
    Optional value added module data. Maximum of ten on the object.
    
    Parameters:
    
    valueAddedModuleData - valueAddedModuleData or null for none
  - getVersion
```
public Long getVersion()
```
    Deprecated
    
    Returns:
    
    value or null for none
  - setVersion
```
public TransitObject setVersion(Long version)
```
    Deprecated
    
    Parameters:
    
    version - version or null for none
  - set
```
public TransitObject set(String fieldName,
                         Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public TransitObject clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class TransitObject

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

TransitObject

Method Detail

getActivationStatus

setActivationStatus

getAppLinkData

setAppLinkData

getBarcode

setBarcode

getClassId

setClassId

getClassReference

setClassReference

getConcessionCategory

setConcessionCategory

getCustomConcessionCategory

setCustomConcessionCategory

getCustomTicketStatus

setCustomTicketStatus

getDeviceContext

setDeviceContext

getDisableExpirationNotification

setDisableExpirationNotification

getGroupingInfo

setGroupingInfo

getHasLinkedDevice

setHasLinkedDevice

getHasUsers

setHasUsers

getHeroImage

setHeroImage

getHexBackgroundColor

setHexBackgroundColor

getId

setId

getImageModulesData

setImageModulesData

getInfoModuleData

setInfoModuleData

getLinkedObjectIds

setLinkedObjectIds

getLinksModuleData

setLinksModuleData

getLocations

setLocations

getMerchantLocations

setMerchantLocations

getMessages

setMessages

getNotifyPreference

setNotifyPreference

getPassConstraints

setPassConstraints

getPassengerNames

setPassengerNames

getPassengerType

setPassengerType

getPurchaseDetails

setPurchaseDetails

getRotatingBarcode

setRotatingBarcode

getSaveRestrictions

setSaveRestrictions

getSmartTapRedemptionValue

setSmartTapRedemptionValue

getState

setState

getTextModulesData