Interface OrderTrackingSignal.ShippingInfoOrBuilder (0.2.0) 

public static interface OrderTrackingSignal.ShippingInfoOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getActualDeliveryTime()

public abstract DateTime getActualDeliveryTime()

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

.google.type.DateTime actual_delivery_time = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.DateTime

The actualDeliveryTime.

getActualDeliveryTimeOrBuilder()

public abstract DateTimeOrBuilder getActualDeliveryTimeOrBuilder()

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

.google.type.DateTime actual_delivery_time = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.DateTimeOrBuilder

getCarrier()

public abstract String getCarrier()

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

string carrier = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The carrier.

getCarrierBytes()

public abstract ByteString getCarrierBytes()

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

string carrier = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for carrier.

getCarrierService()

public abstract String getCarrierService()

Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS, etc.

string carrier_service = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The carrierService.

getCarrierServiceBytes()

public abstract ByteString getCarrierServiceBytes()

Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS, etc.

string carrier_service = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for carrierService.

getEarliestDeliveryPromiseTime()

public abstract DateTime getEarliestDeliveryPromiseTime()

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

.google.type.DateTime earliest_delivery_promise_time = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.DateTime

The earliestDeliveryPromiseTime.

getEarliestDeliveryPromiseTimeOrBuilder()

public abstract DateTimeOrBuilder getEarliestDeliveryPromiseTimeOrBuilder()

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

.google.type.DateTime earliest_delivery_promise_time = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.DateTimeOrBuilder

getLatestDeliveryPromiseTime()

public abstract DateTime getLatestDeliveryPromiseTime()

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

.google.type.DateTime latest_delivery_promise_time = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.DateTime

The latestDeliveryPromiseTime.

getLatestDeliveryPromiseTimeOrBuilder()

public abstract DateTimeOrBuilder getLatestDeliveryPromiseTimeOrBuilder()

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

.google.type.DateTime latest_delivery_promise_time = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.DateTimeOrBuilder

getOriginPostalCode()

public abstract String getOriginPostalCode()

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

string origin_postal_code = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The originPostalCode.

getOriginPostalCodeBytes()

public abstract ByteString getOriginPostalCodeBytes()

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

string origin_postal_code = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for originPostalCode.

getOriginRegionCode()

public abstract String getOriginRegionCode()

Required. The CLDR territory code for the shipping origin.

string origin_region_code = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The originRegionCode.

getOriginRegionCodeBytes()

public abstract ByteString getOriginRegionCodeBytes()

Required. The CLDR territory code for the shipping origin.

string origin_region_code = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for originRegionCode.

getShipmentId()

public abstract String getShipmentId()

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

string shipment_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The shipmentId.

getShipmentIdBytes()

public abstract ByteString getShipmentIdBytes()

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

string shipment_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for shipmentId.

getShippedTime()

public abstract DateTime getShippedTime()

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

.google.type.DateTime shipped_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.DateTime

The shippedTime.

getShippedTimeOrBuilder()

public abstract DateTimeOrBuilder getShippedTimeOrBuilder()

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

.google.type.DateTime shipped_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.DateTimeOrBuilder

getShippingStatus()

public abstract OrderTrackingSignal.ShippingInfo.ShippingState getShippingStatus()

Required. The status of the shipment.

.google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo.ShippingState shipping_status = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OrderTrackingSignal.ShippingInfo.ShippingState

The shippingStatus.

getShippingStatusValue()

public abstract int getShippingStatusValue()

Required. The status of the shipment.

.google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo.ShippingState shipping_status = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for shippingStatus.

getTrackingId()

public abstract String getTrackingId()

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

string tracking_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The trackingId.

getTrackingIdBytes()

public abstract ByteString getTrackingIdBytes()

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

string tracking_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for trackingId.

hasActualDeliveryTime()

public abstract boolean hasActualDeliveryTime()

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

.google.type.DateTime actual_delivery_time = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the actualDeliveryTime field is set.

hasEarliestDeliveryPromiseTime()

public abstract boolean hasEarliestDeliveryPromiseTime()

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

.google.type.DateTime earliest_delivery_promise_time = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the earliestDeliveryPromiseTime field is set.

hasLatestDeliveryPromiseTime()

public abstract boolean hasLatestDeliveryPromiseTime()

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

.google.type.DateTime latest_delivery_promise_time = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the latestDeliveryPromiseTime field is set.

hasShippedTime()

public abstract boolean hasShippedTime()

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

.google.type.DateTime shipped_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the shippedTime field is set.