target.apidocs.com.google.api.services.content.model.OrdersCancelLineItemRequest.html Maven / Gradle / Ivy
OrdersCancelLineItemRequest (Content API for Shopping v2.1-rev20240609-2.0.0)
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
-
public final class OrdersCancelLineItemRequest
extends com.google.api.client.json.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
com.google.api.client.util.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
OrdersCancelLineItemRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
OrdersCancelLineItemRequest
clone()
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
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
-
-
Method Detail
-
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`" - "`failedToCaptureFunds`"
- 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`" - "`failedToCaptureFunds`"
- 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 com.google.api.client.json.GenericJson
-
clone
public OrdersCancelLineItemRequest clone()
- Overrides:
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy