Send feedback
Class Region (0.12.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 0.12.0 keyboard_arrow_down
public final class Region extends GeneratedMessageV3 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 or, in some countries, using predefined
geotargets. For more information, see Set up regions
for more information.
Protobuf type google.shopping.merchant.accounts.v1beta.Region
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type
Description
int
public static final int GEOTARGET_AREA_FIELD_NUMBER
Field Value
Type
Description
int
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
public static final int REGIONAL_INVENTORY_ELIGIBLE_FIELD_NUMBER
Field Value
Type
Description
int
public static final int SHIPPING_ELIGIBLE_FIELD_NUMBER
Field Value
Type
Description
int
Static Methods
public static Region getDefaultInstance ()
Returns
Type
Description
Region
public static final Descriptors . Descriptor getDescriptor ()
public static Region . Builder newBuilder ()
public static Region . Builder newBuilder ( Region prototype )
Parameter
Name
Description
prototype
Region
public static Region parseDelimitedFrom ( InputStream input )
Returns
Type
Description
Region
public static Region parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type
Description
Region
public static Region parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
Returns
Type
Description
Region
public static Region parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Returns
Type
Description
Region
public static Region parseFrom ( ByteString data )
Returns
Type
Description
Region
public static Region parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Returns
Type
Description
Region
public static Region parseFrom ( CodedInputStream input )
Returns
Type
Description
Region
public static Region parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type
Description
Region
public static Region parseFrom ( InputStream input )
Returns
Type
Description
Region
public static Region parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type
Description
Region
public static Region parseFrom ( ByteBuffer data )
Returns
Type
Description
Region
public static Region parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Returns
Type
Description
Region
public static Parser<Region> parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
Overrides
public Region getDefaultInstanceForType ()
Returns
Type
Description
Region
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.
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.
public Region . GeoTargetArea getGeotargetArea ()
Optional. A list of geotargets that defines the region area.
.google.shopping.merchant.accounts.v1beta.Region.GeoTargetArea geotarget_area = 4 [(.google.api.field_behavior) = OPTIONAL];
public Region . GeoTargetAreaOrBuilder getGeotargetAreaOrBuilder ()
Optional. A list of geotargets that defines the region area.
.google.shopping.merchant.accounts.v1beta.Region.GeoTargetArea geotarget_area = 4 [(.google.api.field_behavior) = OPTIONAL];
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.
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.
public Parser<Region> getParserForType ()
Overrides
getPostalCodeArea()
public Region . PostalCodeArea getPostalCodeArea ()
Optional. A list of postal codes that defines the region area.
.google.shopping.merchant.accounts.v1beta.Region.PostalCodeArea postal_code_area = 3 [(.google.api.field_behavior) = OPTIONAL];
getPostalCodeAreaOrBuilder()
public Region . PostalCodeAreaOrBuilder getPostalCodeAreaOrBuilder ()
Optional. A list of postal codes that defines the region area.
.google.shopping.merchant.accounts.v1beta.Region.PostalCodeArea postal_code_area = 3 [(.google.api.field_behavior) = OPTIONAL];
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.
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];
public int getSerializedSize ()
Returns
Type
Description
int
Overrides
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.
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];
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.
public boolean hasGeotargetArea ()
Optional. A list of geotargets that defines the region area.
.google.shopping.merchant.accounts.v1beta.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.v1beta.Region.PostalCodeArea postal_code_area = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type
Description
boolean
Whether the postalCodeArea field is set.
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.
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.
Returns
Type
Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public Region . Builder newBuilderForType ()
protected Region . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type
Description
Object
Overrides
public Region . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-04 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-04 UTC."],[],[]]