com.google.api.services.content.model

Class OrdersCancelLineItemRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class OrdersCancelLineItemRequest
extends GenericJson

Model definition for OrdersCancelLineItemRequest.

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>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
OrdersCancelLineItemRequest()

Method Summary

Modifier and Type	Method and Description
OrdersCancelLineItemRequest	clone()
Price	getAmount() Deprecated.
Price	getAmountPretax() Amount to refund for the cancelation.
Price	getAmountTax() Tax amount that corresponds to cancellation amount in amountPretax.
String	getLineItemId() The ID of the line item to cancel.
String	getOperationId() The ID of the operation.
String	getProductId() The ID of the product to cancel.
Long	getQuantity() The quantity to cancel.
String	getReason() The reason for the cancellation.
String	getReasonText() The explanation of the reason.
OrdersCancelLineItemRequest	set(String fieldName, Object value)
OrdersCancelLineItemRequest	setAmount(Price amount) Deprecated.
OrdersCancelLineItemRequest	setAmountPretax(Price amountPretax) Amount to refund for the cancelation.
OrdersCancelLineItemRequest	setAmountTax(Price amountTax) Tax amount that corresponds to cancellation amount in amountPretax.
OrdersCancelLineItemRequest	setLineItemId(String lineItemId) The ID of the line item to cancel.
OrdersCancelLineItemRequest	setOperationId(String operationId) The ID of the operation.
OrdersCancelLineItemRequest	setProductId(String productId) The ID of the product to cancel.
OrdersCancelLineItemRequest	setQuantity(Long quantity) The quantity to cancel.
OrdersCancelLineItemRequest	setReason(String reason) The reason for the cancellation.
OrdersCancelLineItemRequest	setReasonText(String reasonText) The explanation of the reason.

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

OrdersCancelLineItemRequest

public OrdersCancelLineItemRequest()

Method Detail

getAmount

public Price getAmount()

Deprecated. Please use amountPretax and amountTax instead.

Returns:

value or null for none

setAmount

public OrdersCancelLineItemRequest setAmount(Price amount)

Deprecated. Please use amountPretax and amountTax instead.

Parameters:

amount - amount or null for none

getAmountPretax

public Price getAmountPretax()

Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order.

Returns:

value or null for none

setAmountPretax

public OrdersCancelLineItemRequest setAmountPretax(Price amountPretax)

Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order.

Parameters:

amountPretax - amountPretax or null for none

getAmountTax

public Price getAmountTax()

Tax amount that corresponds to cancellation amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided.

Returns:

value or null for none

setAmountTax

public OrdersCancelLineItemRequest setAmountTax(Price amountTax)

Tax amount that corresponds to cancellation amount in amountPretax. Optional, but if filled, then amountPretax must be set. Calculated automatically if not provided.

Parameters:

amountTax - amountTax or null for none

getLineItemId

public String getLineItemId()

The ID of the line item to cancel. Either lineItemId or productId is required.

Returns:

value or null for none

setLineItemId

public OrdersCancelLineItemRequest setLineItemId(String lineItemId)

The ID of the line item to cancel. Either lineItemId or productId is required.

Parameters:

lineItemId - lineItemId 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 OrdersCancelLineItemRequest setOperationId(String operationId)

The ID of the operation. Unique across all operations for a given order.

Parameters:

operationId - operationId or null for none

getProductId

public String getProductId()

The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required.

Returns:

value or null for none

setProductId

public OrdersCancelLineItemRequest setProductId(String productId)

The ID of the product to cancel. This is the REST ID used in the products service. Either lineItemId or productId is required.

Parameters:

productId - productId or null for none

getQuantity

public Long getQuantity()

The quantity to cancel.

Returns:

value or null for none

setQuantity

public OrdersCancelLineItemRequest setQuantity(Long quantity)

The quantity to cancel.

Parameters:

quantity - quantity or null for none

getReason

public String getReason()

The reason for the cancellation. Acceptable values are: - "`customerInitiatedCancel`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`noInventory`" - "`other`" - "`priceError`" - "`shippingPriceError`" - "`taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`"

Returns:

value or null for none

setReason

public OrdersCancelLineItemRequest setReason(String reason)

The reason for the cancellation. Acceptable values are: - "`customerInitiatedCancel`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`noInventory`" - "`other`" - "`priceError`" - "`shippingPriceError`" - "`taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`"

Parameters:

reason - reason or null for none

getReasonText

public String getReasonText()

The explanation of the reason.

Returns:

value or null for none

setReasonText

public OrdersCancelLineItemRequest setReasonText(String reasonText)

The explanation of the reason.

Parameters:

reasonText - reasonText or null for none

set

public OrdersCancelLineItemRequest set(String fieldName,
                                       Object value)

Overrides:

set in class GenericJson

clone

public OrdersCancelLineItemRequest clone()

Overrides:

clone in class GenericJson