com.google.api.services.content.model

Class Region

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes or, in some countries, using predefined geotargets.

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
Region()

Method Summary

Modifier and Type	Method and Description
Region	clone()
String	getDisplayName() The display name of the region.
RegionGeoTargetArea	getGeotargetArea() A list of geotargets that defines the region area.
Long	getMerchantId() Output only.
RegionPostalCodeArea	getPostalCodeArea() A list of postal codes that defines the region area.
Boolean	getRegionalInventoryEligible() Output only.
String	getRegionId() Output only.
Boolean	getShippingEligible() Output only.
Region	set(String fieldName, Object value)
Region	setDisplayName(String displayName) The display name of the region.
Region	setGeotargetArea(RegionGeoTargetArea geotargetArea) A list of geotargets that defines the region area.
Region	setMerchantId(Long merchantId) Output only.
Region	setPostalCodeArea(RegionPostalCodeArea postalCodeArea) A list of postal codes that defines the region area.
Region	setRegionalInventoryEligible(Boolean regionalInventoryEligible) Output only.
Region	setRegionId(String regionId) Output only.
Region	setShippingEligible(Boolean shippingEligible) Output only.

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

Region

public Region()

Method Detail

getDisplayName

public String getDisplayName()

The display name of the region.

Returns:

value or null for none

setDisplayName

public Region setDisplayName(String displayName)

The display name of the region.

Parameters:

displayName - displayName or null for none

getGeotargetArea

public RegionGeoTargetArea getGeotargetArea()

A list of geotargets that defines the region area.

Returns:

value or null for none

setGeotargetArea

public Region setGeotargetArea(RegionGeoTargetArea geotargetArea)

A list of geotargets that defines the region area.

Parameters:

geotargetArea - geotargetArea or null for none

getMerchantId

public Long getMerchantId()

Output only. Immutable. Merchant that owns the region.

Returns:

value or null for none

setMerchantId

public Region setMerchantId(Long merchantId)

Output only. Immutable. Merchant that owns the region.

Parameters:

merchantId - merchantId or null for none

getPostalCodeArea

public RegionPostalCodeArea getPostalCodeArea()

A list of postal codes that defines the region area.

Returns:

value or null for none

setPostalCodeArea

public Region setPostalCodeArea(RegionPostalCodeArea postalCodeArea)

A list of postal codes that defines the region area.

Parameters:

postalCodeArea - postalCodeArea or null for none

getRegionId

public String getRegionId()

Output only. Immutable. The ID uniquely identifying each region.

Returns:

value or null for none

setRegionId

public Region setRegionId(String regionId)

Output only. Immutable. The ID uniquely identifying each region.

Parameters:

regionId - regionId or null for none

getRegionalInventoryEligible

public Boolean getRegionalInventoryEligible()

Output only. Indicates if the region is eligible to use in the Regional Inventory configuration.

Returns:

value or null for none

setRegionalInventoryEligible

public Region setRegionalInventoryEligible(Boolean regionalInventoryEligible)

Output only. Indicates if the region is eligible to use in the Regional Inventory configuration.

Parameters:

regionalInventoryEligible - regionalInventoryEligible or null for none

getShippingEligible

public Boolean getShippingEligible()

Output only. Indicates if the region is eligible to use in the Shipping Services configuration.

Returns:

value or null for none

setShippingEligible

public Region setShippingEligible(Boolean shippingEligible)

Output only. Indicates if the region is eligible to use in the Shipping Services configuration.

Parameters:

shippingEligible - shippingEligible or null for none

set

public Region set(String fieldName,
                  Object value)

Overrides:

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

clone

public Region clone()

Overrides:

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