Interface GeoTargetOrBuilder (0.27.0)

public interface GeoTargetOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCanonicalParent()

public abstract String getCanonicalParent()

Output only. The name of the direct parent that defines the canonical name of the geo target. For example, if the current geo target is "San Francisco", its canonical name would be "San Francisco, California, United States" thus the canonical_parent would be the name of California and the canonical_parent of California would be the name of United states Format: networks/{network_code}/geoTargets/{geo_target}

optional string canonical_parent = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The canonicalParent.

getCanonicalParentBytes()

public abstract ByteString getCanonicalParentBytes()

Output only. The name of the direct parent that defines the canonical name of the geo target. For example, if the current geo target is "San Francisco", its canonical name would be "San Francisco, California, United States" thus the canonical_parent would be the name of California and the canonical_parent of California would be the name of United states Format: networks/{network_code}/geoTargets/{geo_target}

optional string canonical_parent = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for canonicalParent.

getDisplayName()

public abstract String getDisplayName()

Output only. The display name of the GeoTarget.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Output only. The display name of the GeoTarget.

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

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public abstract String getName()

Identifier. The resource name of the GeoTarget. Format: networks/{network_code}/geoTargets/{geo_target_id}

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

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. The resource name of the GeoTarget. Format: networks/{network_code}/geoTargets/{geo_target_id}

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

Returns
Type Description
ByteString

The bytes for name.

getParentNames(int index)

public abstract String getParentNames(int index)

Output only. All parents of the geo target ordered by ascending size.

repeated string parent_names = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The parentNames at the given index.

getParentNamesBytes(int index)

public abstract ByteString getParentNamesBytes(int index)

Output only. All parents of the geo target ordered by ascending size.

repeated string parent_names = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the parentNames at the given index.

getParentNamesCount()

public abstract int getParentNamesCount()

Output only. All parents of the geo target ordered by ascending size.

repeated string parent_names = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of parentNames.

getParentNamesList()

public abstract List<String> getParentNamesList()

Output only. All parents of the geo target ordered by ascending size.

repeated string parent_names = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<String>

A list containing the parentNames.

getRegionCode()

public abstract String getRegionCode()

Output only. The Unicode CLDR region code of the geo target.

optional string region_code = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The regionCode.

getRegionCodeBytes()

public abstract ByteString getRegionCodeBytes()

Output only. The Unicode CLDR region code of the geo target.

optional string region_code = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for regionCode.

getTargetable()

public abstract boolean getTargetable()

Output only. Whether the geo target is targetable.

optional bool targetable = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The targetable.

getType()

public abstract String getType()

Output only. The location type (unlocalized) for this geographical entity.

optional string type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The type.

getTypeBytes()

public abstract ByteString getTypeBytes()

Output only. The location type (unlocalized) for this geographical entity.

optional string type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for type.

hasCanonicalParent()

public abstract boolean hasCanonicalParent()

Output only. The name of the direct parent that defines the canonical name of the geo target. For example, if the current geo target is "San Francisco", its canonical name would be "San Francisco, California, United States" thus the canonical_parent would be the name of California and the canonical_parent of California would be the name of United states Format: networks/{network_code}/geoTargets/{geo_target}

optional string canonical_parent = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the canonicalParent field is set.

hasDisplayName()

public abstract boolean hasDisplayName()

Output only. The display name of the GeoTarget.

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

Returns
Type Description
boolean

Whether the displayName field is set.

hasRegionCode()

public abstract boolean hasRegionCode()

Output only. The Unicode CLDR region code of the geo target.

optional string region_code = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the regionCode field is set.

hasTargetable()

public abstract boolean hasTargetable()

Output only. Whether the geo target is targetable.

optional bool targetable = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the targetable field is set.

hasType()

public abstract boolean hasType()

Output only. The location type (unlocalized) for this geographical entity.

optional string type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the type field is set.