com.google.api.services.content.model

Class OrderTrackingSignalShippingInfo

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.content.model.OrderTrackingSignalShippingInfo

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

The shipping information for the order.

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 Content API for Shopping. 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
OrderTrackingSignalShippingInfo()

Method Summary

Modifier and Type	Method and Description
OrderTrackingSignalShippingInfo	clone()
DateTime	getActualDeliveryTime() The time when the shipment was actually delivered.
String	getCarrierName() The name of the shipping carrier for the delivery.
String	getCarrierServiceName() The service type for fulfillment, e.g., GROUND, FIRST_CLASS, etc.
DateTime	getEarliestDeliveryPromiseTime() The earliest delivery promised time.
DateTime	getLatestDeliveryPromiseTime() The latest delivery promised time.
String	getOriginPostalCode() The origin postal code, as a continuous string without spaces or dashes, e.g.
String	getOriginRegionCode() The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping origin.
String	getShipmentId() Required.
DateTime	getShippedTime() The time when the shipment was shipped.
String	getShippingStatus() The status of the shipment.
String	getTrackingId() The tracking ID of the shipment.
OrderTrackingSignalShippingInfo	set(String fieldName, Object value)
OrderTrackingSignalShippingInfo	setActualDeliveryTime(DateTime actualDeliveryTime) The time when the shipment was actually delivered.
OrderTrackingSignalShippingInfo	setCarrierName(String carrierName) The name of the shipping carrier for the delivery.
OrderTrackingSignalShippingInfo	setCarrierServiceName(String carrierServiceName) The service type for fulfillment, e.g., GROUND, FIRST_CLASS, etc.
OrderTrackingSignalShippingInfo	setEarliestDeliveryPromiseTime(DateTime earliestDeliveryPromiseTime) The earliest delivery promised time.
OrderTrackingSignalShippingInfo	setLatestDeliveryPromiseTime(DateTime latestDeliveryPromiseTime) The latest delivery promised time.
OrderTrackingSignalShippingInfo	setOriginPostalCode(String originPostalCode) The origin postal code, as a continuous string without spaces or dashes, e.g.
OrderTrackingSignalShippingInfo	setOriginRegionCode(String originRegionCode) The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping origin.
OrderTrackingSignalShippingInfo	setShipmentId(String shipmentId) Required.
OrderTrackingSignalShippingInfo	setShippedTime(DateTime shippedTime) The time when the shipment was shipped.
OrderTrackingSignalShippingInfo	setShippingStatus(String shippingStatus) The status of the shipment.
OrderTrackingSignalShippingInfo	setTrackingId(String trackingId) The tracking ID of the shipment.

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

OrderTrackingSignalShippingInfo

public OrderTrackingSignalShippingInfo()

Method Detail

getActualDeliveryTime

public DateTime getActualDeliveryTime()

The time when the shipment was actually delivered. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.

Returns:

value or null for none

setActualDeliveryTime

public OrderTrackingSignalShippingInfo setActualDeliveryTime(DateTime actualDeliveryTime)

The time when the shipment was actually delivered. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.

Parameters:

actualDeliveryTime - actualDeliveryTime or null for none

getCarrierName

public String getCarrierName()

The name of the shipping carrier for the delivery. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.

Returns:

value or null for none

setCarrierName

public OrderTrackingSignalShippingInfo setCarrierName(String carrierName)

The name of the shipping carrier for the delivery. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.

Parameters:

carrierName - carrierName or null for none

getCarrierServiceName

public String getCarrierServiceName()

The service type for fulfillment, e.g., GROUND, FIRST_CLASS, etc.

Returns:

value or null for none

setCarrierServiceName

public OrderTrackingSignalShippingInfo setCarrierServiceName(String carrierServiceName)

The service type for fulfillment, e.g., GROUND, FIRST_CLASS, etc.

Parameters:

carrierServiceName - carrierServiceName or null for none

getEarliestDeliveryPromiseTime

public DateTime getEarliestDeliveryPromiseTime()

The earliest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.

Returns:

value or null for none

setEarliestDeliveryPromiseTime

public OrderTrackingSignalShippingInfo setEarliestDeliveryPromiseTime(DateTime earliestDeliveryPromiseTime)

The earliest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.

Parameters:

earliestDeliveryPromiseTime - earliestDeliveryPromiseTime or null for none

getLatestDeliveryPromiseTime

public DateTime getLatestDeliveryPromiseTime()

The latest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.

Returns:

value or null for none

setLatestDeliveryPromiseTime

public OrderTrackingSignalShippingInfo setLatestDeliveryPromiseTime(DateTime latestDeliveryPromiseTime)

The latest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.

Parameters:

latestDeliveryPromiseTime - latestDeliveryPromiseTime or null for none

getOriginPostalCode

public String getOriginPostalCode()

The origin postal code, as a continuous string without spaces or dashes, e.g. "95016". This field will be anonymized in returned OrderTrackingSignal creation response.

Returns:

value or null for none

setOriginPostalCode

public OrderTrackingSignalShippingInfo setOriginPostalCode(String originPostalCode)

The origin postal code, as a continuous string without spaces or dashes, e.g. "95016". This field will be anonymized in returned OrderTrackingSignal creation response.

Parameters:

originPostalCode - originPostalCode or null for none

getOriginRegionCode

public String getOriginRegionCode()

The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping origin.

Returns:

value or null for none

setOriginRegionCode

public OrderTrackingSignalShippingInfo setOriginRegionCode(String originRegionCode)

The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping origin.

Parameters:

originRegionCode - originRegionCode or null for none

getShipmentId

public String getShipmentId()

Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response.

Returns:

value or null for none

setShipmentId

public OrderTrackingSignalShippingInfo setShipmentId(String shipmentId)

Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response.

Parameters:

shipmentId - shipmentId or null for none

getShippedTime

public DateTime getShippedTime()

The time when the shipment was shipped. Include the year and timezone string, if available.

Returns:

value or null for none

setShippedTime

public OrderTrackingSignalShippingInfo setShippedTime(DateTime shippedTime)

The time when the shipment was shipped. Include the year and timezone string, if available.

Parameters:

shippedTime - shippedTime or null for none

getShippingStatus

public String getShippingStatus()

The status of the shipment.

Returns:

value or null for none

setShippingStatus

public OrderTrackingSignalShippingInfo setShippingStatus(String shippingStatus)

The status of the shipment.

Parameters:

shippingStatus - shippingStatus or null for none

getTrackingId

public String getTrackingId()

The tracking ID of the shipment. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.

Returns:

value or null for none

setTrackingId

public OrderTrackingSignalShippingInfo setTrackingId(String trackingId)

The tracking ID of the shipment. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.

Parameters:

trackingId - trackingId or null for none

set

public OrderTrackingSignalShippingInfo set(String fieldName,
                                           Object value)

Overrides:

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

clone

public OrderTrackingSignalShippingInfo clone()

Overrides:

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