Class ShippingSettings (0.5.0)

public final class ShippingSettings extends GeneratedMessageV3 implements ShippingSettingsOrBuilder

The merchant account's shipping setting.

Protobuf type google.shopping.merchant.accounts.v1beta.ShippingSettings

Static Fields

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SERVICES_FIELD_NUMBER

public static final int SERVICES_FIELD_NUMBER
Field Value
Type Description
int

WAREHOUSES_FIELD_NUMBER

public static final int WAREHOUSES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ShippingSettings getDefaultInstance()
Returns
Type Description
ShippingSettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ShippingSettings.Builder newBuilder()
Returns
Type Description
ShippingSettings.Builder

newBuilder(ShippingSettings prototype)

public static ShippingSettings.Builder newBuilder(ShippingSettings prototype)
Parameter
Name Description
prototype ShippingSettings
Returns
Type Description
ShippingSettings.Builder

parseDelimitedFrom(InputStream input)

public static ShippingSettings parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ShippingSettings
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ShippingSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShippingSettings
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ShippingSettings parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ShippingSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ShippingSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShippingSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ShippingSettings parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ShippingSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ShippingSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShippingSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ShippingSettings parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ShippingSettings
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ShippingSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShippingSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ShippingSettings parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ShippingSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ShippingSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShippingSettings
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ShippingSettings parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ShippingSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ShippingSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShippingSettings
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ShippingSettings> parser()
Returns
Type Description
Parser<ShippingSettings>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ShippingSettings getDefaultInstanceForType()
Returns
Type Description
ShippingSettings

getEtag()

public String getEtag()

Required. This field is used for avoid async issue. Make sure shipping setting data didn't change between get call and insert call. The user should do following steps:

  1. Set etag field as empty string for initial shipping setting creation.

  2. After initial creation, call get method to obtain an etag and current shipping setting data before call insert.

  3. Modify to wanted shipping setting information.

  4. Call insert method with the wanted shipping setting information with the etag obtained from step 2.

  5. If shipping setting data changed between step 2 and step 4. Insert request will fail because the etag changes every time the shipping setting data changes. User should repeate step 2-4 with the new etag.

string etag = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Required. This field is used for avoid async issue. Make sure shipping setting data didn't change between get call and insert call. The user should do following steps:

  1. Set etag field as empty string for initial shipping setting creation.

  2. After initial creation, call get method to obtain an etag and current shipping setting data before call insert.

  3. Modify to wanted shipping setting information.

  4. Call insert method with the wanted shipping setting information with the etag obtained from step 2.

  5. If shipping setting data changed between step 2 and step 4. Insert request will fail because the etag changes every time the shipping setting data changes. User should repeate step 2-4 with the new etag.

string etag = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for etag.

getName()

public String getName()

Identifier. The resource name of the shipping setting. Format: accounts/{account}/shippingSetting

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the shipping setting. Format: accounts/{account}/shippingSetting

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<ShippingSettings> getParserForType()
Returns
Type Description
Parser<ShippingSettings>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServices(int index)

public Service getServices(int index)

Optional. The target account's list of services.

repeated .google.shopping.merchant.accounts.v1beta.Service services = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Service

getServicesCount()

public int getServicesCount()

Optional. The target account's list of services.

repeated .google.shopping.merchant.accounts.v1beta.Service services = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getServicesList()

public List<Service> getServicesList()

Optional. The target account's list of services.

repeated .google.shopping.merchant.accounts.v1beta.Service services = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Service>

getServicesOrBuilder(int index)

public ServiceOrBuilder getServicesOrBuilder(int index)

Optional. The target account's list of services.

repeated .google.shopping.merchant.accounts.v1beta.Service services = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ServiceOrBuilder

getServicesOrBuilderList()

public List<? extends ServiceOrBuilder> getServicesOrBuilderList()

Optional. The target account's list of services.

repeated .google.shopping.merchant.accounts.v1beta.Service services = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.shopping.merchant.accounts.v1beta.ServiceOrBuilder>

getWarehouses(int index)

public Warehouse getWarehouses(int index)

Optional. A list of warehouses which can be referred to in services.

repeated .google.shopping.merchant.accounts.v1beta.Warehouse warehouses = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Warehouse

getWarehousesCount()

public int getWarehousesCount()

Optional. A list of warehouses which can be referred to in services.

repeated .google.shopping.merchant.accounts.v1beta.Warehouse warehouses = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getWarehousesList()

public List<Warehouse> getWarehousesList()

Optional. A list of warehouses which can be referred to in services.

repeated .google.shopping.merchant.accounts.v1beta.Warehouse warehouses = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Warehouse>

getWarehousesOrBuilder(int index)

public WarehouseOrBuilder getWarehousesOrBuilder(int index)

Optional. A list of warehouses which can be referred to in services.

repeated .google.shopping.merchant.accounts.v1beta.Warehouse warehouses = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
WarehouseOrBuilder

getWarehousesOrBuilderList()

public List<? extends WarehouseOrBuilder> getWarehousesOrBuilderList()

Optional. A list of warehouses which can be referred to in services.

repeated .google.shopping.merchant.accounts.v1beta.Warehouse warehouses = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.shopping.merchant.accounts.v1beta.WarehouseOrBuilder>

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ShippingSettings.Builder newBuilderForType()
Returns
Type Description
ShippingSettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ShippingSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ShippingSettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ShippingSettings.Builder toBuilder()
Returns
Type Description
ShippingSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException