target.apidocs.com.google.api.services.content.model.OrdersUpdateShipmentRequest.html Maven / Gradle / Ivy
OrdersUpdateShipmentRequest (Content API for Shopping v2-rev20200902-1.30.10)
com.google.api.services.content.model
Class OrdersUpdateShipmentRequest
- 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.OrdersUpdateShipmentRequest
-
public final class OrdersUpdateShipmentRequest
extends GenericJson
Model definition for OrdersUpdateShipmentRequest.
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
GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
OrdersUpdateShipmentRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
OrdersUpdateShipmentRequest
clone()
String
getCarrier()
The carrier handling the shipment.
String
getDeliveryDate()
Date on which the shipment has been delivered, in ISO 8601 format.
String
getOperationId()
The ID of the operation.
String
getShipmentId()
The ID of the shipment.
String
getStatus()
New status for the shipment.
String
getTrackingId()
The tracking ID for the shipment.
OrdersUpdateShipmentRequest
set(String fieldName,
Object value)
OrdersUpdateShipmentRequest
setCarrier(String carrier)
The carrier handling the shipment.
OrdersUpdateShipmentRequest
setDeliveryDate(String deliveryDate)
Date on which the shipment has been delivered, in ISO 8601 format.
OrdersUpdateShipmentRequest
setOperationId(String operationId)
The ID of the operation.
OrdersUpdateShipmentRequest
setShipmentId(String shipmentId)
The ID of the shipment.
OrdersUpdateShipmentRequest
setStatus(String status)
New status for the shipment.
OrdersUpdateShipmentRequest
setTrackingId(String trackingId)
The tracking ID for 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
-
-
Method Detail
-
getCarrier
public String getCarrier()
The carrier handling the shipment. Not updated if missing. See `shipments[].carrier` in the
Orders resource representation for a list of acceptable values.
- Returns:
- value or
null
for none
-
setCarrier
public OrdersUpdateShipmentRequest setCarrier(String carrier)
The carrier handling the shipment. Not updated if missing. See `shipments[].carrier` in the
Orders resource representation for a list of acceptable values.
- Parameters:
carrier
- carrier or null
for none
-
getDeliveryDate
public String getDeliveryDate()
Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided
only if `status` is `delivered`.
- Returns:
- value or
null
for none
-
setDeliveryDate
public OrdersUpdateShipmentRequest setDeliveryDate(String deliveryDate)
Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided
only if `status` is `delivered`.
- Parameters:
deliveryDate
- deliveryDate or null
for none
-
getOperationId
public String getOperationId()
The ID of the operation. Unique across all operations for a given order.
- Returns:
- value or
null
for none
-
setOperationId
public OrdersUpdateShipmentRequest setOperationId(String operationId)
The ID of the operation. Unique across all operations for a given order.
- Parameters:
operationId
- operationId or null
for none
-
getShipmentId
public String getShipmentId()
The ID of the shipment.
- Returns:
- value or
null
for none
-
setShipmentId
public OrdersUpdateShipmentRequest setShipmentId(String shipmentId)
The ID of the shipment.
- Parameters:
shipmentId
- shipmentId or null
for none
-
getStatus
public String getStatus()
New status for the shipment. Not updated if missing.
Acceptable values are: - "`delivered`" - "`undeliverable`" - "`readyForPickup`"
- Returns:
- value or
null
for none
-
setStatus
public OrdersUpdateShipmentRequest setStatus(String status)
New status for the shipment. Not updated if missing.
Acceptable values are: - "`delivered`" - "`undeliverable`" - "`readyForPickup`"
- Parameters:
status
- status or null
for none
-
getTrackingId
public String getTrackingId()
The tracking ID for the shipment. Not updated if missing.
- Returns:
- value or
null
for none
-
setTrackingId
public OrdersUpdateShipmentRequest setTrackingId(String trackingId)
The tracking ID for the shipment. Not updated if missing.
- Parameters:
trackingId
- trackingId or null
for none
-
set
public OrdersUpdateShipmentRequest set(String fieldName,
Object value)
- Overrides:
set
in class GenericJson
-
clone
public OrdersUpdateShipmentRequest clone()
- Overrides:
clone
in class GenericJson
Copyright © 2011–2020 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy