com.google.api.services.content.model

Class CarrierRate

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Model definition for CarrierRate.

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

Method Summary

Modifier and Type	Method and Description
CarrierRate	clone()
String	getCarrierName() Carrier service, such as `"UPS"` or `"Fedex"`.
String	getCarrierService() Carrier service, such as `"ground"` or `"2 days"`.
Price	getFlatAdjustment() Additive shipping rate modifier.
String	getName() Name of the carrier rate.
String	getOriginPostalCode() Shipping origin for this carrier rate.
String	getPercentageAdjustment() Multiplicative shipping rate modifier as a number in decimal notation.
CarrierRate	set(String fieldName, Object value)
CarrierRate	setCarrierName(String carrierName) Carrier service, such as `"UPS"` or `"Fedex"`.
CarrierRate	setCarrierService(String carrierService) Carrier service, such as `"ground"` or `"2 days"`.
CarrierRate	setFlatAdjustment(Price flatAdjustment) Additive shipping rate modifier.
CarrierRate	setName(String name) Name of the carrier rate.
CarrierRate	setOriginPostalCode(String originPostalCode) Shipping origin for this carrier rate.
CarrierRate	setPercentageAdjustment(String percentageAdjustment) Multiplicative shipping rate modifier as a number in decimal notation.

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

CarrierRate

public CarrierRate()

Method Detail

getCarrierName

public String getCarrierName()

Carrier service, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved through the `getSupportedCarriers` method. Required.

Returns:

value or null for none

setCarrierName

public CarrierRate setCarrierName(String carrierName)

Carrier service, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved through the `getSupportedCarriers` method. Required.

Parameters:

carrierName - carrierName or null for none

getCarrierService

public String getCarrierService()

Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved through the `getSupportedCarriers` method. Required.

Returns:

value or null for none

setCarrierService

public CarrierRate setCarrierService(String carrierService)

Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved through the `getSupportedCarriers` method. Required.

Parameters:

carrierService - carrierService or null for none

getFlatAdjustment

public Price getFlatAdjustment()

Additive shipping rate modifier. Can be negative. For example `{ "value": "1", "currency" : "USD" }` adds $1 to the rate, `{ "value": "-3", "currency" : "USD" }` removes $3 from the rate. Optional.

Returns:

value or null for none

setFlatAdjustment

public CarrierRate setFlatAdjustment(Price flatAdjustment)

Additive shipping rate modifier. Can be negative. For example `{ "value": "1", "currency" : "USD" }` adds $1 to the rate, `{ "value": "-3", "currency" : "USD" }` removes $3 from the rate. Optional.

Parameters:

flatAdjustment - flatAdjustment or null for none

getName

public String getName()

Name of the carrier rate. Must be unique per rate group. Required.

Returns:

value or null for none

setName

public CarrierRate setName(String name)

Name of the carrier rate. Must be unique per rate group. Required.

Parameters:

name - name or null for none

getOriginPostalCode

public String getOriginPostalCode()

Shipping origin for this carrier rate. Required.

Returns:

value or null for none

setOriginPostalCode

public CarrierRate setOriginPostalCode(String originPostalCode)

Shipping origin for this carrier rate. Required.

Parameters:

originPostalCode - originPostalCode or null for none

getPercentageAdjustment

public String getPercentageAdjustment()

Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example `"5.4"` increases the rate by 5.4%, `"-3"` decreases the rate by 3%. Optional.

Returns:

value or null for none

setPercentageAdjustment

public CarrierRate setPercentageAdjustment(String percentageAdjustment)

Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example `"5.4"` increases the rate by 5.4%, `"-3"` decreases the rate by 3%. Optional.

Parameters:

percentageAdjustment - percentageAdjustment or null for none

set

public CarrierRate set(String fieldName,
                       Object value)

Overrides:

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

clone

public CarrierRate clone()

Overrides:

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