ShoppingContent.Orders.Cancel (Content API for Shopping v2.1-rev20240325-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.content.ShoppingContentRequest<OrdersCancelResponse>
        
        com.google.api.services.content.ShoppingContent.Orders.Cancel

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

Enclosing class:: ShoppingContent.Orders

public class ShoppingContent.Orders.Cancel
extends ShoppingContentRequest<OrdersCancelResponse>

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>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Cancel(BigInteger merchantId, String orderId, OrdersCancelRequest content)` Cancels all line items in an order, making a full refund.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BigInteger`	`getMerchantId()` The ID of the account that manages the order.
`String`	`getOrderId()` The ID of the order to cancel.
`ShoppingContent.Orders.Cancel`	`set(String parameterName, Object value)`
`ShoppingContent.Orders.Cancel`	`set$Xgafv(String $Xgafv)` V1 error format.
`ShoppingContent.Orders.Cancel`	`setAccessToken(String accessToken)` OAuth access token.
`ShoppingContent.Orders.Cancel`	`setAlt(String alt)` Data format for response.
`ShoppingContent.Orders.Cancel`	`setCallback(String callback)` JSONP
`ShoppingContent.Orders.Cancel`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`ShoppingContent.Orders.Cancel`	`setKey(String key)` API key.
`ShoppingContent.Orders.Cancel`	`setMerchantId(BigInteger merchantId)` The ID of the account that manages the order.
`ShoppingContent.Orders.Cancel`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`ShoppingContent.Orders.Cancel`	`setOrderId(String orderId)` The ID of the order to cancel.
`ShoppingContent.Orders.Cancel`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`ShoppingContent.Orders.Cancel`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`ShoppingContent.Orders.Cancel`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`ShoppingContent.Orders.Cancel`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.content.ShoppingContentRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

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
  - Cancel
```
protected Cancel(BigInteger merchantId,
                 String orderId,
                 OrdersCancelRequest content)
```
    Cancels all line items in an order, making a full refund. Create a request for the method "orders.cancel". This request holds the parameters needed by the the content server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    ShoppingContent.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    merchantId - The ID of the account that manages the order. This cannot be a multi-client account.
    
    orderId - The ID of the order to cancel.
    
    content - the OrdersCancelRequest
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public ShoppingContent.Orders.Cancel set$Xgafv(String $Xgafv)
```
    Description copied from class: ShoppingContentRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class ShoppingContentRequest<OrdersCancelResponse>
  - setAccessToken
```
public ShoppingContent.Orders.Cancel setAccessToken(String accessToken)
```
    Description copied from class: ShoppingContentRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class ShoppingContentRequest<OrdersCancelResponse>
  - setAlt
```
public ShoppingContent.Orders.Cancel setAlt(String alt)
```
    Description copied from class: ShoppingContentRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class ShoppingContentRequest<OrdersCancelResponse>
  - setCallback
```
public ShoppingContent.Orders.Cancel setCallback(String callback)
```
    Description copied from class: ShoppingContentRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class ShoppingContentRequest<OrdersCancelResponse>
  - setFields
```
public ShoppingContent.Orders.Cancel setFields(String fields)
```
    Description copied from class: ShoppingContentRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class ShoppingContentRequest<OrdersCancelResponse>
  - setKey
```
public ShoppingContent.Orders.Cancel setKey(String key)
```
    Description copied from class: ShoppingContentRequest
    
    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    
    Overrides:
    
    setKey in class ShoppingContentRequest<OrdersCancelResponse>
  - setOauthToken
```
public ShoppingContent.Orders.Cancel setOauthToken(String oauthToken)
```
    Description copied from class: ShoppingContentRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class ShoppingContentRequest<OrdersCancelResponse>
  - setPrettyPrint
```
public ShoppingContent.Orders.Cancel setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: ShoppingContentRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class ShoppingContentRequest<OrdersCancelResponse>
  - setQuotaUser
```
public ShoppingContent.Orders.Cancel setQuotaUser(String quotaUser)
```
    Description copied from class: ShoppingContentRequest
    
    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class ShoppingContentRequest<OrdersCancelResponse>
  - setUploadType
```
public ShoppingContent.Orders.Cancel setUploadType(String uploadType)
```
    Description copied from class: ShoppingContentRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class ShoppingContentRequest<OrdersCancelResponse>
  - setUploadProtocol
```
public ShoppingContent.Orders.Cancel setUploadProtocol(String uploadProtocol)
```
    Description copied from class: ShoppingContentRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class ShoppingContentRequest<OrdersCancelResponse>
  - getMerchantId
```
public BigInteger getMerchantId()
```
    The ID of the account that manages the order. This cannot be a multi-client account.
  - setMerchantId
```
public ShoppingContent.Orders.Cancel setMerchantId(BigInteger merchantId)
```
    The ID of the account that manages the order. This cannot be a multi-client account.
  - getOrderId
```
public String getOrderId()
```
    The ID of the order to cancel.
  - setOrderId
```
public ShoppingContent.Orders.Cancel setOrderId(String orderId)
```
    The ID of the order to cancel.
  - set
```
public ShoppingContent.Orders.Cancel set(String parameterName,
                                         Object value)
```
    Overrides:
    
    set in class ShoppingContentRequest<OrdersCancelResponse>

Class ShoppingContent.Orders.Cancel

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

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.content.ShoppingContentRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

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

Cancel

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getMerchantId

setMerchantId

getOrderId

setOrderId

set