Class GeoTarget.Builder (0.27.0)

public static final class GeoTarget.Builder extends GeneratedMessageV3.Builder<GeoTarget.Builder> implements GeoTargetOrBuilder

Represents a location in the world, for targeting.

Protobuf type google.ads.admanager.v1.GeoTarget

Implements

GeoTargetOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllParentNames(Iterable<String> values)

public GeoTarget.Builder addAllParentNames(Iterable<String> values)

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
values Iterable<String>

The parentNames to add.

Returns
Type Description
GeoTarget.Builder

This builder for chaining.

addParentNames(String value)

public GeoTarget.Builder addParentNames(String value)

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
value String

The parentNames to add.

Returns
Type Description
GeoTarget.Builder

This builder for chaining.

addParentNamesBytes(ByteString value)

public GeoTarget.Builder addParentNamesBytes(ByteString value)

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
value ByteString

The bytes of the parentNames to add.

Returns
Type Description
GeoTarget.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GeoTarget.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GeoTarget.Builder
Overrides

build()

public GeoTarget build()
Returns
Type Description
GeoTarget

buildPartial()

public GeoTarget buildPartial()
Returns
Type Description
GeoTarget

clear()

public GeoTarget.Builder clear()
Returns
Type Description
GeoTarget.Builder
Overrides

clearCanonicalParent()

public GeoTarget.Builder clearCanonicalParent()

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
GeoTarget.Builder

This builder for chaining.

clearDisplayName()

public GeoTarget.Builder clearDisplayName()

Output only. The display name of the GeoTarget.

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

Returns
Type Description
GeoTarget.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public GeoTarget.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
GeoTarget.Builder
Overrides

clearName()

public GeoTarget.Builder clearName()

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
GeoTarget.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GeoTarget.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
GeoTarget.Builder
Overrides

clearParentNames()

public GeoTarget.Builder clearParentNames()

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
GeoTarget.Builder

This builder for chaining.

clearRegionCode()

public GeoTarget.Builder clearRegionCode()

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
GeoTarget.Builder

This builder for chaining.

clearTargetable()

public GeoTarget.Builder clearTargetable()

Output only. Whether the geo target is targetable.

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

Returns
Type Description
GeoTarget.Builder

This builder for chaining.

clearType()

public GeoTarget.Builder clearType()

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

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

Returns
Type Description
GeoTarget.Builder

This builder for chaining.

clone()

public GeoTarget.Builder clone()
Returns
Type Description
GeoTarget.Builder
Overrides

getCanonicalParent()

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

getDefaultInstanceForType()

public GeoTarget getDefaultInstanceForType()
Returns
Type Description
GeoTarget

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public 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 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 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 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 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the parentNames.

getRegionCode()

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(GeoTarget other)

public GeoTarget.Builder mergeFrom(GeoTarget other)
Parameter
Name Description
other GeoTarget
Returns
Type Description
GeoTarget.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GeoTarget.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GeoTarget.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public GeoTarget.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
GeoTarget.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GeoTarget.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GeoTarget.Builder
Overrides

setCanonicalParent(String value)

public GeoTarget.Builder setCanonicalParent(String value)

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) = { ... }

Parameter
Name Description
value String

The canonicalParent to set.

Returns
Type Description
GeoTarget.Builder

This builder for chaining.

setCanonicalParentBytes(ByteString value)

public GeoTarget.Builder setCanonicalParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for canonicalParent to set.

Returns
Type Description
GeoTarget.Builder

This builder for chaining.

setDisplayName(String value)

public GeoTarget.Builder setDisplayName(String value)

Output only. The display name of the GeoTarget.

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

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
GeoTarget.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public GeoTarget.Builder setDisplayNameBytes(ByteString value)

Output only. The display name of the GeoTarget.

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
GeoTarget.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public GeoTarget.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GeoTarget.Builder
Overrides

setName(String value)

public GeoTarget.Builder setName(String value)

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

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
GeoTarget.Builder

This builder for chaining.

setNameBytes(ByteString value)

public GeoTarget.Builder setNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
GeoTarget.Builder

This builder for chaining.

setParentNames(int index, String value)

public GeoTarget.Builder setParentNames(int index, String value)

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

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

Parameters
Name Description
index int

The index to set the value at.

value String

The parentNames to set.

Returns
Type Description
GeoTarget.Builder

This builder for chaining.

setRegionCode(String value)

public GeoTarget.Builder setRegionCode(String value)

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

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

Parameter
Name Description
value String

The regionCode to set.

Returns
Type Description
GeoTarget.Builder

This builder for chaining.

setRegionCodeBytes(ByteString value)

public GeoTarget.Builder setRegionCodeBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for regionCode to set.

Returns
Type Description
GeoTarget.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GeoTarget.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
GeoTarget.Builder
Overrides

setTargetable(boolean value)

public GeoTarget.Builder setTargetable(boolean value)

Output only. Whether the geo target is targetable.

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

Parameter
Name Description
value boolean

The targetable to set.

Returns
Type Description
GeoTarget.Builder

This builder for chaining.

setType(String value)

public GeoTarget.Builder setType(String value)

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

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

Parameter
Name Description
value String

The type to set.

Returns
Type Description
GeoTarget.Builder

This builder for chaining.

setTypeBytes(ByteString value)

public GeoTarget.Builder setTypeBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for type to set.

Returns
Type Description
GeoTarget.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final GeoTarget.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GeoTarget.Builder
Overrides