OrdersCustomBatchRequestEntry (Content API for Shopping v2-rev20210203-1.31.0)

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

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class OrdersCustomBatchRequestEntry
extends GenericJson
```
Model definition for OrdersCustomBatchRequestEntry.
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

OrdersCustomBatchRequestEntry()

Constructors
Constructor and Description
`OrdersCustomBatchRequestEntry()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OrdersCustomBatchRequestEntry`	`clone()`
`Long`	`getBatchId()` An entry ID, unique within the batch request.
`OrdersCustomBatchRequestEntryCancel`	`getCancel()` Required for `cancel` method.
`OrdersCustomBatchRequestEntryCancelLineItem`	`getCancelLineItem()` Required for `cancelLineItem` method.
`OrdersCustomBatchRequestEntryInStoreRefundLineItem`	`getInStoreRefundLineItem()` Required for `inStoreReturnLineItem` method.
`BigInteger`	`getMerchantId()` The ID of the managing account.
`String`	`getMerchantOrderId()` The merchant order ID.
`String`	`getMethod()` The method of the batch entry.
`String`	`getOperationId()` The ID of the operation.
`String`	`getOrderId()` The ID of the order.
`OrdersCustomBatchRequestEntryRefund`	`getRefund()` Required for `refund` method.
`OrdersCustomBatchRequestEntryRejectReturnLineItem`	`getRejectReturnLineItem()` Required for `rejectReturnLineItem` method.
`OrdersCustomBatchRequestEntryReturnLineItem`	`getReturnLineItem()` Required for `returnLineItem` method.
`OrdersCustomBatchRequestEntryReturnRefundLineItem`	`getReturnRefundLineItem()` Required for `returnRefundLineItem` method.
`OrdersCustomBatchRequestEntrySetLineItemMetadata`	`getSetLineItemMetadata()` Required for `setLineItemMetadata` method.
`OrdersCustomBatchRequestEntryShipLineItems`	`getShipLineItems()` Required for `shipLineItems` method.
`OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails`	`getUpdateLineItemShippingDetails()` Required for `updateLineItemShippingDate` method.
`OrdersCustomBatchRequestEntryUpdateShipment`	`getUpdateShipment()` Required for `updateShipment` method.
`OrdersCustomBatchRequestEntry`	`set(String fieldName, Object value)`
`OrdersCustomBatchRequestEntry`	`setBatchId(Long batchId)` An entry ID, unique within the batch request.
`OrdersCustomBatchRequestEntry`	`setCancel(OrdersCustomBatchRequestEntryCancel cancel)` Required for `cancel` method.
`OrdersCustomBatchRequestEntry`	`setCancelLineItem(OrdersCustomBatchRequestEntryCancelLineItem cancelLineItem)` Required for `cancelLineItem` method.
`OrdersCustomBatchRequestEntry`	`setInStoreRefundLineItem(OrdersCustomBatchRequestEntryInStoreRefundLineItem inStoreRefundLineItem)` Required for `inStoreReturnLineItem` method.
`OrdersCustomBatchRequestEntry`	`setMerchantId(BigInteger merchantId)` The ID of the managing account.
`OrdersCustomBatchRequestEntry`	`setMerchantOrderId(String merchantOrderId)` The merchant order ID.
`OrdersCustomBatchRequestEntry`	`setMethod(String method)` The method of the batch entry.
`OrdersCustomBatchRequestEntry`	`setOperationId(String operationId)` The ID of the operation.
`OrdersCustomBatchRequestEntry`	`setOrderId(String orderId)` The ID of the order.
`OrdersCustomBatchRequestEntry`	`setRefund(OrdersCustomBatchRequestEntryRefund refund)` Required for `refund` method.
`OrdersCustomBatchRequestEntry`	`setRejectReturnLineItem(OrdersCustomBatchRequestEntryRejectReturnLineItem rejectReturnLineItem)` Required for `rejectReturnLineItem` method.
`OrdersCustomBatchRequestEntry`	`setReturnLineItem(OrdersCustomBatchRequestEntryReturnLineItem returnLineItem)` Required for `returnLineItem` method.
`OrdersCustomBatchRequestEntry`	`setReturnRefundLineItem(OrdersCustomBatchRequestEntryReturnRefundLineItem returnRefundLineItem)` Required for `returnRefundLineItem` method.
`OrdersCustomBatchRequestEntry`	`setSetLineItemMetadata(OrdersCustomBatchRequestEntrySetLineItemMetadata setLineItemMetadata)` Required for `setLineItemMetadata` method.
`OrdersCustomBatchRequestEntry`	`setShipLineItems(OrdersCustomBatchRequestEntryShipLineItems shipLineItems)` Required for `shipLineItems` method.
`OrdersCustomBatchRequestEntry`	`setUpdateLineItemShippingDetails(OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails updateLineItemShippingDetails)` Required for `updateLineItemShippingDate` method.
`OrdersCustomBatchRequestEntry`	`setUpdateShipment(OrdersCustomBatchRequestEntryUpdateShipment updateShipment)` Required for `updateShipment` method.

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
  - OrdersCustomBatchRequestEntry
```
public OrdersCustomBatchRequestEntry()
```
- Method Detail
  - getBatchId
```
public Long getBatchId()
```
    An entry ID, unique within the batch request.
    
    Returns:
    
    value or null for none
  - setBatchId
```
public OrdersCustomBatchRequestEntry setBatchId(Long batchId)
```
    An entry ID, unique within the batch request.
    
    Parameters:
    
    batchId - batchId or null for none
  - getCancel
```
public OrdersCustomBatchRequestEntryCancel getCancel()
```
    Required for `cancel` method.
    
    Returns:
    
    value or null for none
  - setCancel
```
public OrdersCustomBatchRequestEntry setCancel(OrdersCustomBatchRequestEntryCancel cancel)
```
    Required for `cancel` method.
    
    Parameters:
    
    cancel - cancel or null for none
  - getCancelLineItem
```
public OrdersCustomBatchRequestEntryCancelLineItem getCancelLineItem()
```
    Required for `cancelLineItem` method.
    
    Returns:
    
    value or null for none
  - setCancelLineItem
```
public OrdersCustomBatchRequestEntry setCancelLineItem(OrdersCustomBatchRequestEntryCancelLineItem cancelLineItem)
```
    Required for `cancelLineItem` method.
    
    Parameters:
    
    cancelLineItem - cancelLineItem or null for none
  - getInStoreRefundLineItem
```
public OrdersCustomBatchRequestEntryInStoreRefundLineItem getInStoreRefundLineItem()
```
    Required for `inStoreReturnLineItem` method.
    
    Returns:
    
    value or null for none
  - setInStoreRefundLineItem
```
public OrdersCustomBatchRequestEntry setInStoreRefundLineItem(OrdersCustomBatchRequestEntryInStoreRefundLineItem inStoreRefundLineItem)
```
    Required for `inStoreReturnLineItem` method.
    
    Parameters:
    
    inStoreRefundLineItem - inStoreRefundLineItem or null for none
  - getMerchantId
```
public BigInteger getMerchantId()
```
    The ID of the managing account.
    
    Returns:
    
    value or null for none
  - setMerchantId
```
public OrdersCustomBatchRequestEntry setMerchantId(BigInteger merchantId)
```
    The ID of the managing account.
    
    Parameters:
    
    merchantId - merchantId or null for none
  - getMerchantOrderId
```
public String getMerchantOrderId()
```
    The merchant order ID. Required for `updateMerchantOrderId` and `getByMerchantOrderId` methods.
    
    Returns:
    
    value or null for none
  - setMerchantOrderId
```
public OrdersCustomBatchRequestEntry setMerchantOrderId(String merchantOrderId)
```
    The merchant order ID. Required for `updateMerchantOrderId` and `getByMerchantOrderId` methods.
    
    Parameters:
    
    merchantOrderId - merchantOrderId or null for none
  - getMethod
```
public String getMethod()
```
    The method of the batch entry. Acceptable values are: - "`acknowledge`" - "`cancel`" - "`cancelLineItem`" - "`get`" - "`getByMerchantOrderId`" - "`inStoreRefundLineItem`" - "`refund`" - "`rejectReturnLineItem`" - "`returnLineItem`" - "`returnRefundLineItem`" - "`setLineItemMetadata`" - "`shipLineItems`" - "`updateLineItemShippingDetails`" - "`updateMerchantOrderId`" - "`updateShipment`"
    
    Returns:
    
    value or null for none
  - setMethod
```
public OrdersCustomBatchRequestEntry setMethod(String method)
```
    The method of the batch entry. Acceptable values are: - "`acknowledge`" - "`cancel`" - "`cancelLineItem`" - "`get`" - "`getByMerchantOrderId`" - "`inStoreRefundLineItem`" - "`refund`" - "`rejectReturnLineItem`" - "`returnLineItem`" - "`returnRefundLineItem`" - "`setLineItemMetadata`" - "`shipLineItems`" - "`updateLineItemShippingDetails`" - "`updateMerchantOrderId`" - "`updateShipment`"
    
    Parameters:
    
    method - method or null for none
  - getOperationId
```
public String getOperationId()
```
    The ID of the operation. Unique across all operations for a given order. Required for all methods beside `get` and `getByMerchantOrderId`.
    
    Returns:
    
    value or null for none
  - setOperationId
```
public OrdersCustomBatchRequestEntry setOperationId(String operationId)
```
    The ID of the operation. Unique across all operations for a given order. Required for all methods beside `get` and `getByMerchantOrderId`.
    
    Parameters:
    
    operationId - operationId or null for none
  - getOrderId
```
public String getOrderId()
```
    The ID of the order. Required for all methods beside `getByMerchantOrderId`.
    
    Returns:
    
    value or null for none
  - setOrderId
```
public OrdersCustomBatchRequestEntry setOrderId(String orderId)
```
    The ID of the order. Required for all methods beside `getByMerchantOrderId`.
    
    Parameters:
    
    orderId - orderId or null for none
  - getRefund
```
public OrdersCustomBatchRequestEntryRefund getRefund()
```
    Required for `refund` method.
    
    Returns:
    
    value or null for none
  - setRefund
```
public OrdersCustomBatchRequestEntry setRefund(OrdersCustomBatchRequestEntryRefund refund)
```
    Required for `refund` method.
    
    Parameters:
    
    refund - refund or null for none
  - getRejectReturnLineItem
```
public OrdersCustomBatchRequestEntryRejectReturnLineItem getRejectReturnLineItem()
```
    Required for `rejectReturnLineItem` method.
    
    Returns:
    
    value or null for none
  - setRejectReturnLineItem
```
public OrdersCustomBatchRequestEntry setRejectReturnLineItem(OrdersCustomBatchRequestEntryRejectReturnLineItem rejectReturnLineItem)
```
    Required for `rejectReturnLineItem` method.
    
    Parameters:
    
    rejectReturnLineItem - rejectReturnLineItem or null for none
  - getReturnLineItem
```
public OrdersCustomBatchRequestEntryReturnLineItem getReturnLineItem()
```
    Required for `returnLineItem` method.
    
    Returns:
    
    value or null for none
  - setReturnLineItem
```
public OrdersCustomBatchRequestEntry setReturnLineItem(OrdersCustomBatchRequestEntryReturnLineItem returnLineItem)
```
    Required for `returnLineItem` method.
    
    Parameters:
    
    returnLineItem - returnLineItem or null for none
  - getReturnRefundLineItem
```
public OrdersCustomBatchRequestEntryReturnRefundLineItem getReturnRefundLineItem()
```
    Required for `returnRefundLineItem` method.
    
    Returns:
    
    value or null for none
  - setReturnRefundLineItem
```
public OrdersCustomBatchRequestEntry setReturnRefundLineItem(OrdersCustomBatchRequestEntryReturnRefundLineItem returnRefundLineItem)
```
    Required for `returnRefundLineItem` method.
    
    Parameters:
    
    returnRefundLineItem - returnRefundLineItem or null for none
  - getSetLineItemMetadata
```
public OrdersCustomBatchRequestEntrySetLineItemMetadata getSetLineItemMetadata()
```
    Required for `setLineItemMetadata` method.
    
    Returns:
    
    value or null for none
  - setSetLineItemMetadata
```
public OrdersCustomBatchRequestEntry setSetLineItemMetadata(OrdersCustomBatchRequestEntrySetLineItemMetadata setLineItemMetadata)
```
    Required for `setLineItemMetadata` method.
    
    Parameters:
    
    setLineItemMetadata - setLineItemMetadata or null for none
  - getShipLineItems
```
public OrdersCustomBatchRequestEntryShipLineItems getShipLineItems()
```
    Required for `shipLineItems` method.
    
    Returns:
    
    value or null for none
  - setShipLineItems
```
public OrdersCustomBatchRequestEntry setShipLineItems(OrdersCustomBatchRequestEntryShipLineItems shipLineItems)
```
    Required for `shipLineItems` method.
    
    Parameters:
    
    shipLineItems - shipLineItems or null for none
  - getUpdateLineItemShippingDetails
```
public OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails getUpdateLineItemShippingDetails()
```
    Required for `updateLineItemShippingDate` method.
    
    Returns:
    
    value or null for none
  - setUpdateLineItemShippingDetails
```
public OrdersCustomBatchRequestEntry setUpdateLineItemShippingDetails(OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails updateLineItemShippingDetails)
```
    Required for `updateLineItemShippingDate` method.
    
    Parameters:
    
    updateLineItemShippingDetails - updateLineItemShippingDetails or null for none
  - getUpdateShipment
```
public OrdersCustomBatchRequestEntryUpdateShipment getUpdateShipment()
```
    Required for `updateShipment` method.
    
    Returns:
    
    value or null for none
  - setUpdateShipment
```
public OrdersCustomBatchRequestEntry setUpdateShipment(OrdersCustomBatchRequestEntryUpdateShipment updateShipment)
```
    Required for `updateShipment` method.
    
    Parameters:
    
    updateShipment - updateShipment or null for none
  - set
```
public OrdersCustomBatchRequestEntry set(String fieldName,
                                         Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public OrdersCustomBatchRequestEntry clone()
```
    Overrides:
    
    clone in class GenericJson

Class OrdersCustomBatchRequestEntry

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

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

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

OrdersCustomBatchRequestEntry

Method Detail

getBatchId

setBatchId

getCancel

setCancel

getCancelLineItem

setCancelLineItem

getInStoreRefundLineItem

setInStoreRefundLineItem

getMerchantId

setMerchantId

getMerchantOrderId

setMerchantOrderId

getMethod

setMethod

getOperationId

setOperationId

getOrderId

setOrderId

getRefund

setRefund

getRejectReturnLineItem

setRejectReturnLineItem

getReturnLineItem

setReturnLineItem

getReturnRefundLineItem

setReturnRefundLineItem

getSetLineItemMetadata

setSetLineItemMetadata

getShipLineItems

setShipLineItems

getUpdateLineItemShippingDetails

setUpdateLineItemShippingDetails

getUpdateShipment

setUpdateShipment

set

clone