com.google.api.services.content

Class ShoppingContent.Orders.Cancel

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

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	setAlt(String alt) Data format for the response.
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) An opaque string that represents a user for quota purposes.
ShoppingContent.Orders.Cancel	setUserIp(String userIp) Deprecated.

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

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, 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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, 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

setAlt

public ShoppingContent.Orders.Cancel setAlt(String alt)

Description copied from class: ShoppingContentRequest

Data format for the response.

Overrides:

setAlt 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

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class ShoppingContentRequest<OrdersCancelResponse>

setUserIp

public ShoppingContent.Orders.Cancel setUserIp(String userIp)

Description copied from class: ShoppingContentRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp 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>