target.apidocs.com.google.api.services.content.model.OrdersCancelRequest.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-content Show documentation

There is a newer version: v2.1-rev20241217-2.0.0

Show newest version







OrdersCancelRequest (Content API for Shopping v2.1-rev20220413-1.32.1)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.content.model
Class OrdersCancelRequest



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













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class OrdersCancelRequest
extends GenericJson
Model definition for OrdersCancelRequest.

  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


OrdersCancelRequest() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


OrdersCancelRequest
clone() 


String
getOperationId()
The ID of the operation.



String
getReason()
The reason for the cancellation.



String
getReasonText()
The explanation of the reason.



OrdersCancelRequest
set(String fieldName,
   Object value) 


OrdersCancelRequest
setOperationId(String operationId)
The ID of the operation.



OrdersCancelRequest
setReason(String reason)
The reason for the cancellation.



OrdersCancelRequest
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





OrdersCancelRequest
public OrdersCancelRequest()









Method Detail





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 OrdersCancelRequest setOperationId(String operationId)
The ID of the operation. Unique across all operations for a given order.

Parameters:
operationId - operationId 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 OrdersCancelRequest 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 OrdersCancelRequest setReasonText(String reasonText)
The explanation of the reason.

Parameters:
reasonText - reasonText or null for none








set
public OrdersCancelRequest set(String fieldName,
                               Object value)

Overrides:
set in class GenericJson








clone
public OrdersCancelRequest clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2022 Google. All rights reserved.

Modifier and Type	Method and Description
`OrdersCancelRequest`	`clone()`
`String`	`getOperationId()` The ID of the operation.
`String`	`getReason()` The reason for the cancellation.
`String`	`getReasonText()` The explanation of the reason.
`OrdersCancelRequest`	`set(String fieldName, Object value)`
`OrdersCancelRequest`	`setOperationId(String operationId)` The ID of the operation.
`OrdersCancelRequest`	`setReason(String reason)` The reason for the cancellation.
`OrdersCancelRequest`	`setReasonText(String reasonText)` The explanation of the reason.