com.google.api.services.walletobjects.model

Class FlightObject

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.FlightObject

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class FlightObject
extends com.google.api.client.json.GenericJson

Model definition for FlightObject.

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
FlightObject()

Method Summary

Modifier and Type	Method and Description
FlightObject	clone()
AppLinkData	getAppLinkData() Optional information about the partner app link.
Barcode	getBarcode() The barcode type and value.
BoardingAndSeatingInfo	getBoardingAndSeatingInfo() Passenger specific information about boarding and seating.
String	getClassId() Required.
FlightClass	getClassReference() A copy of the inherited fields of the parent class.
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.
String	getKind() Identifies what kind of resource this is.
LinksModuleData	getLinksModuleData() Links module data.
List<LatLongPoint>	getLocations() Note: This field is currently not supported to trigger geo notifications.
List<Message>	getMessages() An array of messages displayed in the app.
PassConstraints	getPassConstraints() Pass constraints for the object.
String	getPassengerName() Required.
ReservationInfo	getReservationInfo() Required.
RotatingBarcode	getRotatingBarcode() The rotating barcode type and value.
Image	getSecurityProgramLogo() An image for the security program that applies to the passenger.
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.
TimeInterval	getValidTimeInterval() The time period this object will be `active` and object can be used.
Long	getVersion() Deprecated
FlightObject	set(String fieldName, Object value)
FlightObject	setAppLinkData(AppLinkData appLinkData) Optional information about the partner app link.
FlightObject	setBarcode(Barcode barcode) The barcode type and value.
FlightObject	setBoardingAndSeatingInfo(BoardingAndSeatingInfo boardingAndSeatingInfo) Passenger specific information about boarding and seating.
FlightObject	setClassId(String classId) Required.
FlightObject	setClassReference(FlightClass classReference) A copy of the inherited fields of the parent class.
FlightObject	setDisableExpirationNotification(Boolean disableExpirationNotification) Indicates if notifications should explicitly be suppressed.
FlightObject	setGroupingInfo(GroupingInfo groupingInfo) Information that controls how passes are grouped together.
FlightObject	setHasLinkedDevice(Boolean hasLinkedDevice) Whether this object is currently linked to a single device.
FlightObject	setHasUsers(Boolean hasUsers) Indicates if the object has users.
FlightObject	setHeroImage(Image heroImage) Optional banner image displayed on the front of the card.
FlightObject	setHexBackgroundColor(String hexBackgroundColor) The background color for the card.
FlightObject	setId(String id) Required.
FlightObject	setImageModulesData(List<ImageModuleData> imageModulesData) Image module data.
FlightObject	setInfoModuleData(InfoModuleData infoModuleData) Deprecated.
FlightObject	setKind(String kind) Identifies what kind of resource this is.
FlightObject	setLinksModuleData(LinksModuleData linksModuleData) Links module data.
FlightObject	setLocations(List<LatLongPoint> locations) Note: This field is currently not supported to trigger geo notifications.
FlightObject	setMessages(List<Message> messages) An array of messages displayed in the app.
FlightObject	setPassConstraints(PassConstraints passConstraints) Pass constraints for the object.
FlightObject	setPassengerName(String passengerName) Required.
FlightObject	setReservationInfo(ReservationInfo reservationInfo) Required.
FlightObject	setRotatingBarcode(RotatingBarcode rotatingBarcode) The rotating barcode type and value.
FlightObject	setSecurityProgramLogo(Image securityProgramLogo) An image for the security program that applies to the passenger.
FlightObject	setSmartTapRedemptionValue(String smartTapRedemptionValue) The value that will be transmitted to a Smart Tap certified terminal over NFC for this object.
FlightObject	setState(String state) Required.
FlightObject	setTextModulesData(List<TextModuleData> textModulesData) Text module data.
FlightObject	setValidTimeInterval(TimeInterval validTimeInterval) The time period this object will be `active` and object can be used.
FlightObject	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

FlightObject

public FlightObject()

Method Detail

getAppLinkData

public AppLinkData getAppLinkData()

Optional information about the partner app link.

Returns:

value or null for none

setAppLinkData

public FlightObject setAppLinkData(AppLinkData appLinkData)

Optional information about the partner app link.

Parameters:

appLinkData - appLinkData or null for none

getBarcode

public Barcode getBarcode()

The barcode type and value.

Returns:

value or null for none

setBarcode

public FlightObject setBarcode(Barcode barcode)

The barcode type and value.

Parameters:

barcode - barcode or null for none

getBoardingAndSeatingInfo

public BoardingAndSeatingInfo getBoardingAndSeatingInfo()

Passenger specific information about boarding and seating.

Returns:

value or null for none

setBoardingAndSeatingInfo

public FlightObject setBoardingAndSeatingInfo(BoardingAndSeatingInfo boardingAndSeatingInfo)

Passenger specific information about boarding and seating.

Parameters:

boardingAndSeatingInfo - boardingAndSeatingInfo 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 FlightObject 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 FlightClass 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 FlightObject setClassReference(FlightClass 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

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 Flights.

Returns:

value or null for none

setDisableExpirationNotification

public FlightObject 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 Flights.

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 FlightObject 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 FlightObject 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 FlightObject 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 FlightObject 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 FlightObject 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 FlightObject 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 FlightObject 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 FlightObject setInfoModuleData(InfoModuleData infoModuleData)

Deprecated. Use textModulesData instead.

Parameters:

infoModuleData - infoModuleData or null for none

getKind

public String getKind()

Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightObject"`.

Returns:

value or null for none

setKind

public FlightObject setKind(String kind)

Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightObject"`.

Parameters:

kind - kind 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 FlightObject 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 FlightObject setLocations(List<LatLongPoint> locations)

Note: This field is currently not supported to trigger geo notifications.

Parameters:

locations - locations 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 FlightObject 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

getPassConstraints

public PassConstraints getPassConstraints()

Pass constraints for the object. Includes limiting NFC and screenshot behaviors.

Returns:

value or null for none

setPassConstraints

public FlightObject setPassConstraints(PassConstraints passConstraints)

Pass constraints for the object. Includes limiting NFC and screenshot behaviors.

Parameters:

passConstraints - passConstraints or null for none

getPassengerName

public String getPassengerName()

Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"

Returns:

value or null for none

setPassengerName

public FlightObject setPassengerName(String passengerName)

Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM"

Parameters:

passengerName - passengerName or null for none

getReservationInfo

public ReservationInfo getReservationInfo()

Required. Information about flight reservation.

Returns:

value or null for none

setReservationInfo

public FlightObject setReservationInfo(ReservationInfo reservationInfo)

Required. Information about flight reservation.

Parameters:

reservationInfo - reservationInfo or null for none

getRotatingBarcode

public RotatingBarcode getRotatingBarcode()

The rotating barcode type and value.

Returns:

value or null for none

setRotatingBarcode

public FlightObject setRotatingBarcode(RotatingBarcode rotatingBarcode)

The rotating barcode type and value.

Parameters:

rotatingBarcode - rotatingBarcode or null for none

getSecurityProgramLogo

public Image getSecurityProgramLogo()

An image for the security program that applies to the passenger.

Returns:

value or null for none

setSecurityProgramLogo

public FlightObject setSecurityProgramLogo(Image securityProgramLogo)

An image for the security program that applies to the passenger.

Parameters:

securityProgramLogo - securityProgramLogo 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 FlightObject 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 FlightObject 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 FlightObject 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

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 FlightObject 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

getVersion

public Long getVersion()

Deprecated

Returns:

value or null for none

setVersion

public FlightObject setVersion(Long version)

Deprecated

Parameters:

version - version or null for none

set

public FlightObject set(String fieldName,
                        Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public FlightObject clone()

Overrides:

clone in class com.google.api.client.json.GenericJson