Class TrafficForecastSegment.Builder (0.62.0)

public static final class TrafficForecastSegment.Builder extends GeneratedMessage.Builder<TrafficForecastSegment.Builder> implements TrafficForecastSegmentOrBuilder

An entity that defines a segment of traffic that will be adjusted or explored.

Protobuf type google.ads.admanager.v1.TrafficForecastSegment

Static Methods

getDescriptor()

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

Methods

addAllTargetedAdUnits(Iterable<String> values)

public TrafficForecastSegment.Builder addAllTargetedAdUnits(Iterable<String> values)

Optional. The ad units that are targeted by the TrafficForecastSegment.

repeated string targeted_ad_units = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The targetedAdUnits to add.

Returns
Type Description
TrafficForecastSegment.Builder

This builder for chaining.

addTargetedAdUnits(String value)

public TrafficForecastSegment.Builder addTargetedAdUnits(String value)

Optional. The ad units that are targeted by the TrafficForecastSegment.

repeated string targeted_ad_units = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The targetedAdUnits to add.

Returns
Type Description
TrafficForecastSegment.Builder

This builder for chaining.

addTargetedAdUnitsBytes(ByteString value)

public TrafficForecastSegment.Builder addTargetedAdUnitsBytes(ByteString value)

Optional. The ad units that are targeted by the TrafficForecastSegment.

repeated string targeted_ad_units = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the targetedAdUnits to add.

Returns
Type Description
TrafficForecastSegment.Builder

This builder for chaining.

build()

public TrafficForecastSegment build()
Returns
Type Description
TrafficForecastSegment

buildPartial()

public TrafficForecastSegment buildPartial()
Returns
Type Description
TrafficForecastSegment

clear()

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

clearCreateTime()

public TrafficForecastSegment.Builder clearCreateTime()

Output only. The date and time that the TrafficForecastSegment was created.

optional .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TrafficForecastSegment.Builder

clearDisplayName()

public TrafficForecastSegment.Builder clearDisplayName()

Required. Name of the TrafficForecastSegment. This field must be unique among all segments for this network.

optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TrafficForecastSegment.Builder

This builder for chaining.

clearForecastAdjustmentCount()

public TrafficForecastSegment.Builder clearForecastAdjustmentCount()

Output only. The number of active forecast adjustments associated with the TrafficForecastSegment.

optional int32 forecast_adjustment_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TrafficForecastSegment.Builder

This builder for chaining.

clearName()

public TrafficForecastSegment.Builder clearName()

Identifier. The resource name of the TrafficForecastSegment. Format: networks/{network_code}/trafficForecastSegments/{trafficForecastSegmentId}

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

Returns
Type Description
TrafficForecastSegment.Builder

This builder for chaining.

clearTargetedAdUnits()

public TrafficForecastSegment.Builder clearTargetedAdUnits()

Optional. The ad units that are targeted by the TrafficForecastSegment.

repeated string targeted_ad_units = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
TrafficForecastSegment.Builder

This builder for chaining.

clearTargeting()

public TrafficForecastSegment.Builder clearTargeting()

Required. Immutable. The targeting that defines a segment of traffic.

optional .google.ads.admanager.v1.Targeting targeting = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
TrafficForecastSegment.Builder

getCreateTime()

public Timestamp getCreateTime()

Output only. The date and time that the TrafficForecastSegment was created.

optional .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The date and time that the TrafficForecastSegment was created.

optional .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The date and time that the TrafficForecastSegment was created.

optional .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public TrafficForecastSegment getDefaultInstanceForType()
Returns
Type Description
TrafficForecastSegment

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

Required. Name of the TrafficForecastSegment. This field must be unique among all segments for this network.

optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. Name of the TrafficForecastSegment. This field must be unique among all segments for this network.

optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getForecastAdjustmentCount()

public int getForecastAdjustmentCount()

Output only. The number of active forecast adjustments associated with the TrafficForecastSegment.

optional int32 forecast_adjustment_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The forecastAdjustmentCount.

getName()

public String getName()

Identifier. The resource name of the TrafficForecastSegment. Format: networks/{network_code}/trafficForecastSegments/{trafficForecastSegmentId}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the TrafficForecastSegment. Format: networks/{network_code}/trafficForecastSegments/{trafficForecastSegmentId}

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

Returns
Type Description
ByteString

The bytes for name.

getTargetedAdUnits(int index)

public String getTargetedAdUnits(int index)

Optional. The ad units that are targeted by the TrafficForecastSegment.

repeated string targeted_ad_units = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The targetedAdUnits at the given index.

getTargetedAdUnitsBytes(int index)

public ByteString getTargetedAdUnitsBytes(int index)

Optional. The ad units that are targeted by the TrafficForecastSegment.

repeated string targeted_ad_units = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the targetedAdUnits at the given index.

getTargetedAdUnitsCount()

public int getTargetedAdUnitsCount()

Optional. The ad units that are targeted by the TrafficForecastSegment.

repeated string targeted_ad_units = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of targetedAdUnits.

getTargetedAdUnitsList()

public ProtocolStringList getTargetedAdUnitsList()

Optional. The ad units that are targeted by the TrafficForecastSegment.

repeated string targeted_ad_units = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the targetedAdUnits.

getTargeting()

public Targeting getTargeting()

Required. Immutable. The targeting that defines a segment of traffic.

optional .google.ads.admanager.v1.Targeting targeting = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Targeting

The targeting.

getTargetingBuilder()

public Targeting.Builder getTargetingBuilder()

Required. Immutable. The targeting that defines a segment of traffic.

optional .google.ads.admanager.v1.Targeting targeting = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Targeting.Builder

getTargetingOrBuilder()

public TargetingOrBuilder getTargetingOrBuilder()

Required. Immutable. The targeting that defines a segment of traffic.

optional .google.ads.admanager.v1.Targeting targeting = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
TargetingOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The date and time that the TrafficForecastSegment was created.

optional .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDisplayName()

public boolean hasDisplayName()

Required. Name of the TrafficForecastSegment. This field must be unique among all segments for this network.

optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the displayName field is set.

hasForecastAdjustmentCount()

public boolean hasForecastAdjustmentCount()

Output only. The number of active forecast adjustments associated with the TrafficForecastSegment.

optional int32 forecast_adjustment_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the forecastAdjustmentCount field is set.

hasTargeting()

public boolean hasTargeting()

Required. Immutable. The targeting that defines a segment of traffic.

optional .google.ads.admanager.v1.Targeting targeting = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the targeting field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public TrafficForecastSegment.Builder mergeCreateTime(Timestamp value)

Output only. The date and time that the TrafficForecastSegment was created.

optional .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
TrafficForecastSegment.Builder

mergeFrom(TrafficForecastSegment other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeTargeting(Targeting value)

public TrafficForecastSegment.Builder mergeTargeting(Targeting value)

Required. Immutable. The targeting that defines a segment of traffic.

optional .google.ads.admanager.v1.Targeting targeting = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value Targeting
Returns
Type Description
TrafficForecastSegment.Builder

setCreateTime(Timestamp value)

public TrafficForecastSegment.Builder setCreateTime(Timestamp value)

Output only. The date and time that the TrafficForecastSegment was created.

optional .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
TrafficForecastSegment.Builder

setCreateTime(Timestamp.Builder builderForValue)

public TrafficForecastSegment.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The date and time that the TrafficForecastSegment was created.

optional .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
TrafficForecastSegment.Builder

setDisplayName(String value)

public TrafficForecastSegment.Builder setDisplayName(String value)

Required. Name of the TrafficForecastSegment. This field must be unique among all segments for this network.

optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
TrafficForecastSegment.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public TrafficForecastSegment.Builder setDisplayNameBytes(ByteString value)

Required. Name of the TrafficForecastSegment. This field must be unique among all segments for this network.

optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
TrafficForecastSegment.Builder

This builder for chaining.

setForecastAdjustmentCount(int value)

public TrafficForecastSegment.Builder setForecastAdjustmentCount(int value)

Output only. The number of active forecast adjustments associated with the TrafficForecastSegment.

optional int32 forecast_adjustment_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The forecastAdjustmentCount to set.

Returns
Type Description
TrafficForecastSegment.Builder

This builder for chaining.

setName(String value)

public TrafficForecastSegment.Builder setName(String value)

Identifier. The resource name of the TrafficForecastSegment. Format: networks/{network_code}/trafficForecastSegments/{trafficForecastSegmentId}

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
TrafficForecastSegment.Builder

This builder for chaining.

setNameBytes(ByteString value)

public TrafficForecastSegment.Builder setNameBytes(ByteString value)

Identifier. The resource name of the TrafficForecastSegment. Format: networks/{network_code}/trafficForecastSegments/{trafficForecastSegmentId}

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
TrafficForecastSegment.Builder

This builder for chaining.

setTargetedAdUnits(int index, String value)

public TrafficForecastSegment.Builder setTargetedAdUnits(int index, String value)

Optional. The ad units that are targeted by the TrafficForecastSegment.

repeated string targeted_ad_units = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The targetedAdUnits to set.

Returns
Type Description
TrafficForecastSegment.Builder

This builder for chaining.

setTargeting(Targeting value)

public TrafficForecastSegment.Builder setTargeting(Targeting value)

Required. Immutable. The targeting that defines a segment of traffic.

optional .google.ads.admanager.v1.Targeting targeting = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value Targeting
Returns
Type Description
TrafficForecastSegment.Builder

setTargeting(Targeting.Builder builderForValue)

public TrafficForecastSegment.Builder setTargeting(Targeting.Builder builderForValue)

Required. Immutable. The targeting that defines a segment of traffic.

optional .google.ads.admanager.v1.Targeting targeting = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
builderForValue Targeting.Builder
Returns
Type Description
TrafficForecastSegment.Builder