com.google.api.services.content.model

Class ProductsCustomBatchRequestEntry

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ProductsCustomBatchRequestEntry
extends com.google.api.client.json.GenericJson

A batch entry encoding a single non-batch products request.

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>

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ProductsCustomBatchRequestEntry()

Method Summary

Modifier and Type	Method and Description
ProductsCustomBatchRequestEntry	clone()
Long	getBatchId() An entry ID, unique within the batch request.
BigInteger	getFeedId() The Content API Supplemental Feed ID.
BigInteger	getMerchantId() The ID of the managing account.
String	getMethod() The method of the batch entry.
Product	getProduct() The product to insert or update.
String	getProductId() The ID of the product to get or mutate.
String	getUpdateMask() The comma-separated list of product attributes to be updated.
ProductsCustomBatchRequestEntry	set(String fieldName, Object value)
ProductsCustomBatchRequestEntry	setBatchId(Long batchId) An entry ID, unique within the batch request.
ProductsCustomBatchRequestEntry	setFeedId(BigInteger feedId) The Content API Supplemental Feed ID.
ProductsCustomBatchRequestEntry	setMerchantId(BigInteger merchantId) The ID of the managing account.
ProductsCustomBatchRequestEntry	setMethod(String method) The method of the batch entry.
ProductsCustomBatchRequestEntry	setProduct(Product product) The product to insert or update.
ProductsCustomBatchRequestEntry	setProductId(String productId) The ID of the product to get or mutate.
ProductsCustomBatchRequestEntry	setUpdateMask(String updateMask) The comma-separated list of product attributes to be updated.

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

ProductsCustomBatchRequestEntry

public ProductsCustomBatchRequestEntry()

Method Detail

getBatchId

public Long getBatchId()

An entry ID, unique within the batch request.

Returns:

value or null for none

setBatchId

public ProductsCustomBatchRequestEntry setBatchId(Long batchId)

An entry ID, unique within the batch request.

Parameters:

batchId - batchId or null for none

getFeedId

public BigInteger getFeedId()

The Content API Supplemental Feed ID. If present then product insertion or deletion applies to a supplemental feed instead of primary Content API feed.

Returns:

value or null for none

setFeedId

public ProductsCustomBatchRequestEntry setFeedId(BigInteger feedId)

The Content API Supplemental Feed ID. If present then product insertion or deletion applies to a supplemental feed instead of primary Content API feed.

Parameters:

feedId - feedId or null for none

getMerchantId

public BigInteger getMerchantId()

The ID of the managing account.

Returns:

value or null for none

setMerchantId

public ProductsCustomBatchRequestEntry setMerchantId(BigInteger merchantId)

The ID of the managing account.

Parameters:

merchantId - merchantId or null for none

getMethod

public String getMethod()

The method of the batch entry. Acceptable values are: - "`delete`" - "`get`" - "`insert`" - "`update`"

Returns:

value or null for none

setMethod

public ProductsCustomBatchRequestEntry setMethod(String method)

The method of the batch entry. Acceptable values are: - "`delete`" - "`get`" - "`insert`" - "`update`"

Parameters:

method - method or null for none

getProduct

public Product getProduct()

The product to insert or update. Only required if the method is `insert` or `update`. If the `update` method is used with `updateMask` only to delete a field, then this isn't required. For example, setting `salePrice` on the `updateMask` and not providing a `product` will result in an existing sale price on the product specified by `productId` being deleted.

Returns:

value or null for none

setProduct

public ProductsCustomBatchRequestEntry setProduct(Product product)

The product to insert or update. Only required if the method is `insert` or `update`. If the `update` method is used with `updateMask` only to delete a field, then this isn't required. For example, setting `salePrice` on the `updateMask` and not providing a `product` will result in an existing sale price on the product specified by `productId` being deleted.

Parameters:

product - product or null for none

getProductId

public String getProductId()

The ID of the product to get or mutate. Only defined if the method is `get`, `delete`, or `update`.

Returns:

value or null for none

setProductId

public ProductsCustomBatchRequestEntry setProductId(String productId)

The ID of the product to get or mutate. Only defined if the method is `get`, `delete`, or `update`.

Parameters:

productId - productId or null for none

getUpdateMask

public String getUpdateMask()

The comma-separated list of product attributes to be updated. Example: `"title,salePrice"`. Attributes specified in the update mask without a value specified in the body will be deleted from the product. *You must specify the update mask to delete attributes.* Only top-level product attributes can be updated. If not defined, product attributes with set values will be updated and other attributes will stay unchanged. Only defined if the method is `update`.

Returns:

value or null for none

setUpdateMask

public ProductsCustomBatchRequestEntry setUpdateMask(String updateMask)

The comma-separated list of product attributes to be updated. Example: `"title,salePrice"`. Attributes specified in the update mask without a value specified in the body will be deleted from the product. *You must specify the update mask to delete attributes.* Only top-level product attributes can be updated. If not defined, product attributes with set values will be updated and other attributes will stay unchanged. Only defined if the method is `update`.

Parameters:

updateMask - updateMask or null for none

set

public ProductsCustomBatchRequestEntry set(String fieldName,
                                           Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ProductsCustomBatchRequestEntry clone()

Overrides:

clone in class com.google.api.client.json.GenericJson