Class Region (1.16.0)

public final class Region extends GeneratedMessage implements RegionOrBuilder

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, radius areas or, in some countries, using predefined geotargets.

A region must be defined by specifying exactly one of postal_code_area, geotarget_area, or radius_area.

For more information, see Set up regions for more information.

Protobuf type google.shopping.merchant.accounts.v1.Region

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > Region

Implements

RegionOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

GEOTARGET_AREA_FIELD_NUMBER

public static final int GEOTARGET_AREA_FIELD_NUMBER

Field Value
Type	Description
`int`

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

POSTAL_CODE_AREA_FIELD_NUMBER

public static final int POSTAL_CODE_AREA_FIELD_NUMBER

Field Value
Type	Description
`int`

RADIUS_AREA_FIELD_NUMBER

public static final int RADIUS_AREA_FIELD_NUMBER

Field Value
Type	Description
`int`

REGIONAL_INVENTORY_ELIGIBLE_FIELD_NUMBER

public static final int REGIONAL_INVENTORY_ELIGIBLE_FIELD_NUMBER

Field Value
Type	Description
`int`

SHIPPING_ELIGIBLE_FIELD_NUMBER

public static final int SHIPPING_ELIGIBLE_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static Region getDefaultInstance()

Returns
Type	Description
`Region`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static Region.Builder newBuilder()

Returns
Type	Description
`Region.Builder`

newBuilder(Region prototype)

public static Region.Builder newBuilder(Region prototype)

Parameter
Name	Description
`prototype`	`Region`

Returns
Type	Description
`Region.Builder`

parseDelimitedFrom(InputStream input)

public static Region parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Region`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Region parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Region`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static Region parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`Region`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Region parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Region`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static Region parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`Region`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Region parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Region`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static Region parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`Region`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Region parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Region`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static Region parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Region`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Region parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Region`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static Region parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`Region`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Region parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Region`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<Region> parser()

Returns
Type	Description
`Parser<Region>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public Region getDefaultInstanceForType()

Returns
Type	Description
`Region`

getDisplayName()

public String getDisplayName()

Optional. The display name of the region.

optional string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. The display name of the region.

optional string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for displayName.

getGeotargetArea()

public Region.GeoTargetArea getGeotargetArea()

Optional. A list of geotargets that defines the region area.

.google.shopping.merchant.accounts.v1.Region.GeoTargetArea geotarget_area = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Region.GeoTargetArea`	The geotargetArea.

getGeotargetAreaOrBuilder()

public Region.GeoTargetAreaOrBuilder getGeotargetAreaOrBuilder()

Optional. A list of geotargets that defines the region area.

.google.shopping.merchant.accounts.v1.Region.GeoTargetArea geotarget_area = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Region.GeoTargetAreaOrBuilder`

getName()

public String getName()

Identifier. The resource name of the region. Format: accounts/{account}/regions/{region}

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

Returns
Type	Description
`String`	The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the region. Format: accounts/{account}/regions/{region}

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

Returns
Type	Description
`ByteString`	The bytes for name.

getParserForType()

public Parser<Region> getParserForType()

Returns
Type	Description
`Parser<Region>`

Overrides

GeneratedMessage.getParserForType()

getPostalCodeArea()

public Region.PostalCodeArea getPostalCodeArea()

Optional. A list of postal codes that defines the region area.

.google.shopping.merchant.accounts.v1.Region.PostalCodeArea postal_code_area = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Region.PostalCodeArea`	The postalCodeArea.

getPostalCodeAreaOrBuilder()

public Region.PostalCodeAreaOrBuilder getPostalCodeAreaOrBuilder()

Optional. A list of postal codes that defines the region area.

.google.shopping.merchant.accounts.v1.Region.PostalCodeArea postal_code_area = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Region.PostalCodeAreaOrBuilder`

getRadiusArea()

public Region.RadiusArea getRadiusArea()

Optional. A radius area that defines the region area.

.google.shopping.merchant.accounts.v1.Region.RadiusArea radius_area = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Region.RadiusArea`	The radiusArea.

getRadiusAreaOrBuilder()

public Region.RadiusAreaOrBuilder getRadiusAreaOrBuilder()

Optional. A radius area that defines the region area.

.google.shopping.merchant.accounts.v1.Region.RadiusArea radius_area = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Region.RadiusAreaOrBuilder`

getRegionalInventoryEligible()

public BoolValue getRegionalInventoryEligible()

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

.google.protobuf.BoolValue regional_inventory_eligible = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`BoolValue`	The regionalInventoryEligible.

getRegionalInventoryEligibleOrBuilder()

public BoolValueOrBuilder getRegionalInventoryEligibleOrBuilder()

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

.google.protobuf.BoolValue regional_inventory_eligible = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`BoolValueOrBuilder`

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessage.getSerializedSize()

getShippingEligible()

public BoolValue getShippingEligible()

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

.google.protobuf.BoolValue shipping_eligible = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`BoolValue`	The shippingEligible.

getShippingEligibleOrBuilder()

public BoolValueOrBuilder getShippingEligibleOrBuilder()

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

.google.protobuf.BoolValue shipping_eligible = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`BoolValueOrBuilder`

hasDisplayName()

public boolean hasDisplayName()

Optional. The display name of the region.

optional string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the displayName field is set.

hasGeotargetArea()

public boolean hasGeotargetArea()

Optional. A list of geotargets that defines the region area.

.google.shopping.merchant.accounts.v1.Region.GeoTargetArea geotarget_area = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the geotargetArea field is set.

hasPostalCodeArea()

public boolean hasPostalCodeArea()

Optional. A list of postal codes that defines the region area.

.google.shopping.merchant.accounts.v1.Region.PostalCodeArea postal_code_area = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the postalCodeArea field is set.

hasRadiusArea()

public boolean hasRadiusArea()

Optional. A radius area that defines the region area.

.google.shopping.merchant.accounts.v1.Region.RadiusArea radius_area = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the radiusArea field is set.

hasRegionalInventoryEligible()

public boolean hasRegionalInventoryEligible()

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

.google.protobuf.BoolValue regional_inventory_eligible = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the regionalInventoryEligible field is set.

hasShippingEligible()

public boolean hasShippingEligible()

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

.google.protobuf.BoolValue shipping_eligible = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the shippingEligible field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public Region.Builder newBuilderForType()

Returns
Type	Description
`Region.Builder`

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Region.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`Region.Builder`

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public Region.Builder toBuilder()

Returns
Type	Description
`Region.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`

Class Region (1.16.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Implements

Inherited Members

Static Fields

DISPLAY_NAME_FIELD_NUMBER

GEOTARGET_AREA_FIELD_NUMBER

NAME_FIELD_NUMBER

POSTAL_CODE_AREA_FIELD_NUMBER

RADIUS_AREA_FIELD_NUMBER

REGIONAL_INVENTORY_ELIGIBLE_FIELD_NUMBER

SHIPPING_ELIGIBLE_FIELD_NUMBER

Static Methods

getDefaultInstance()

getDescriptor()

newBuilder()

newBuilder(Region prototype)

parseDelimitedFrom(InputStream input)

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(byte[] data)

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

parseFrom(ByteString data)

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

parseFrom(CodedInputStream input)

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(InputStream input)

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(ByteBuffer data)

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

parser()

Methods

equals(Object obj)

getDefaultInstanceForType()

getDisplayName()

getDisplayNameBytes()

getGeotargetArea()

getGeotargetAreaOrBuilder()

getName()

getNameBytes()

getParserForType()

getPostalCodeArea()

getPostalCodeAreaOrBuilder()

getRadiusArea()

getRadiusAreaOrBuilder()

getRegionalInventoryEligible()

getRegionalInventoryEligibleOrBuilder()

getSerializedSize()

getShippingEligible()

getShippingEligibleOrBuilder()

hasDisplayName()

hasGeotargetArea()

hasPostalCodeArea()

hasRadiusArea()

hasRegionalInventoryEligible()

hasShippingEligible()

hashCode()

internalGetFieldAccessorTable()

isInitialized()

newBuilderForType()

newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

writeTo(CodedOutputStream output)

Class Region (1.16.0)