Class OrderTrackingSignal.ShippingInfo (0.2.0)

public static final class OrderTrackingSignal.ShippingInfo extends GeneratedMessageV3 implements OrderTrackingSignal.ShippingInfoOrBuilder

The shipping information for the order.

Protobuf type google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal.ShippingInfo

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > OrderTrackingSignal.ShippingInfo

Static Fields

ACTUAL_DELIVERY_TIME_FIELD_NUMBER

public static final int ACTUAL_DELIVERY_TIME_FIELD_NUMBER
Field Value
Type Description
int

CARRIER_FIELD_NUMBER

public static final int CARRIER_FIELD_NUMBER
Field Value
Type Description
int

CARRIER_SERVICE_FIELD_NUMBER

public static final int CARRIER_SERVICE_FIELD_NUMBER
Field Value
Type Description
int

EARLIEST_DELIVERY_PROMISE_TIME_FIELD_NUMBER

public static final int EARLIEST_DELIVERY_PROMISE_TIME_FIELD_NUMBER
Field Value
Type Description
int

LATEST_DELIVERY_PROMISE_TIME_FIELD_NUMBER

public static final int LATEST_DELIVERY_PROMISE_TIME_FIELD_NUMBER
Field Value
Type Description
int

ORIGIN_POSTAL_CODE_FIELD_NUMBER

public static final int ORIGIN_POSTAL_CODE_FIELD_NUMBER
Field Value
Type Description
int

ORIGIN_REGION_CODE_FIELD_NUMBER

public static final int ORIGIN_REGION_CODE_FIELD_NUMBER
Field Value
Type Description
int

SHIPMENT_ID_FIELD_NUMBER

public static final int SHIPMENT_ID_FIELD_NUMBER
Field Value
Type Description
int

SHIPPED_TIME_FIELD_NUMBER

public static final int SHIPPED_TIME_FIELD_NUMBER
Field Value
Type Description
int

SHIPPING_STATUS_FIELD_NUMBER

public static final int SHIPPING_STATUS_FIELD_NUMBER
Field Value
Type Description
int

TRACKING_ID_FIELD_NUMBER

public static final int TRACKING_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static OrderTrackingSignal.ShippingInfo getDefaultInstance()
Returns
Type Description
OrderTrackingSignal.ShippingInfo

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static OrderTrackingSignal.ShippingInfo.Builder newBuilder()
Returns
Type Description
OrderTrackingSignal.ShippingInfo.Builder

newBuilder(OrderTrackingSignal.ShippingInfo prototype)

public static OrderTrackingSignal.ShippingInfo.Builder newBuilder(OrderTrackingSignal.ShippingInfo prototype)
Parameter
Name Description
prototype OrderTrackingSignal.ShippingInfo
Returns
Type Description
OrderTrackingSignal.ShippingInfo.Builder

parseDelimitedFrom(InputStream input)

public static OrderTrackingSignal.ShippingInfo parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
OrderTrackingSignal.ShippingInfo
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OrderTrackingSignal.ShippingInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrderTrackingSignal.ShippingInfo
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static OrderTrackingSignal.ShippingInfo parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
OrderTrackingSignal.ShippingInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static OrderTrackingSignal.ShippingInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrderTrackingSignal.ShippingInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static OrderTrackingSignal.ShippingInfo parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
OrderTrackingSignal.ShippingInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static OrderTrackingSignal.ShippingInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrderTrackingSignal.ShippingInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static OrderTrackingSignal.ShippingInfo parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
OrderTrackingSignal.ShippingInfo
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static OrderTrackingSignal.ShippingInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrderTrackingSignal.ShippingInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static OrderTrackingSignal.ShippingInfo parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
OrderTrackingSignal.ShippingInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OrderTrackingSignal.ShippingInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrderTrackingSignal.ShippingInfo
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static OrderTrackingSignal.ShippingInfo parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
OrderTrackingSignal.ShippingInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static OrderTrackingSignal.ShippingInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrderTrackingSignal.ShippingInfo
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<OrderTrackingSignal.ShippingInfo> parser()
Returns
Type Description
Parser<ShippingInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getActualDeliveryTime()

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

getDefaultInstanceForType()

public OrderTrackingSignal.ShippingInfo getDefaultInstanceForType()
Returns
Type Description
OrderTrackingSignal.ShippingInfo

getEarliestDeliveryPromiseTime()

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

getParserForType()

public Parser<OrderTrackingSignal.ShippingInfo> getParserForType()
Returns
Type Description
Parser<ShippingInfo>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getShipmentId()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public OrderTrackingSignal.ShippingInfo.Builder newBuilderForType()
Returns
Type Description
OrderTrackingSignal.ShippingInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected OrderTrackingSignal.ShippingInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
OrderTrackingSignal.ShippingInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public OrderTrackingSignal.ShippingInfo.Builder toBuilder()
Returns
Type Description
OrderTrackingSignal.ShippingInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException