public static final class LineItemDeliveryForecast.Builder extends GeneratedMessage.Builder<LineItemDeliveryForecast.Builder> implements LineItemDeliveryForecastOrBuilderThe forecasted delivery of a [ProposalLineItem][] or LineItem.
Protobuf type google.ads.admanager.v1.LineItemDeliveryForecast
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > LineItemDeliveryForecast.BuilderImplements
LineItemDeliveryForecastOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public LineItemDeliveryForecast build()| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecast |
|
buildPartial()
public LineItemDeliveryForecast buildPartial()| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecast |
|
clear()
public LineItemDeliveryForecast.Builder clear()| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecast.Builder |
|
clearDeliveredUnits()
public LineItemDeliveryForecast.Builder clearDeliveredUnits()The number of units, defined by Goal.unitType, that have already been served if the reservation is already running.
optional int64 delivered_units = 5;
| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecast.Builder |
This builder for chaining. |
clearLineItem()
public LineItemDeliveryForecast.Builder clearLineItem() Uniquely identifies this line item delivery forecast. This value is
read-only and will be either the resource name of the
LineItem resource it represents, or
unset if the forecast represents a prospective line item. Format:
networks/{network_code}/lineItems/{line_item_id}
optional string line_item = 1 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecast.Builder |
This builder for chaining. |
clearMatchedUnits()
public LineItemDeliveryForecast.Builder clearMatchedUnits()The number of units, defined by Goal.unitType, that match the specified LineItem#targeting and delivery settings.
optional int64 matched_units = 6;
| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecast.Builder |
This builder for chaining. |
clearOrder()
public LineItemDeliveryForecast.Builder clearOrder() The resource name of the Order object that
this line item belongs to, or null if the forecast represents a prospective
line item without an
LineItem.order set.
Format: networks/{network_code}/orders/{order_id}
optional string order = 2 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecast.Builder |
This builder for chaining. |
clearPredictedDeliveryUnits()
public LineItemDeliveryForecast.Builder clearPredictedDeliveryUnits()The number of units, defined by Goal.unitType, that will be delivered by the line item. Delivery of existing line items that are of same or lower priorities may be impacted.
optional int64 predicted_delivery_units = 4;
| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecast.Builder |
This builder for chaining. |
clearUnitType()
public LineItemDeliveryForecast.Builder clearUnitType()The unit with which the goal or cap of the LineItem is defined. Will be the same value as Goal.unitType for both a set line item or a prospective one.
optional .google.ads.admanager.v1.UnitTypeEnum.UnitType unit_type = 3;
| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecast.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public LineItemDeliveryForecast getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecast |
|
getDeliveredUnits()
public long getDeliveredUnits()The number of units, defined by Goal.unitType, that have already been served if the reservation is already running.
optional int64 delivered_units = 5;
| Returns | |
|---|---|
| Type | Description |
long |
The deliveredUnits. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getLineItem()
public String getLineItem() Uniquely identifies this line item delivery forecast. This value is
read-only and will be either the resource name of the
LineItem resource it represents, or
unset if the forecast represents a prospective line item. Format:
networks/{network_code}/lineItems/{line_item_id}
optional string line_item = 1 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The lineItem. |
getLineItemBytes()
public ByteString getLineItemBytes() Uniquely identifies this line item delivery forecast. This value is
read-only and will be either the resource name of the
LineItem resource it represents, or
unset if the forecast represents a prospective line item. Format:
networks/{network_code}/lineItems/{line_item_id}
optional string line_item = 1 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for lineItem. |
getMatchedUnits()
public long getMatchedUnits()The number of units, defined by Goal.unitType, that match the specified LineItem#targeting and delivery settings.
optional int64 matched_units = 6;
| Returns | |
|---|---|
| Type | Description |
long |
The matchedUnits. |
getOrder()
public String getOrder() The resource name of the Order object that
this line item belongs to, or null if the forecast represents a prospective
line item without an
LineItem.order set.
Format: networks/{network_code}/orders/{order_id}
optional string order = 2 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The order. |
getOrderBytes()
public ByteString getOrderBytes() The resource name of the Order object that
this line item belongs to, or null if the forecast represents a prospective
line item without an
LineItem.order set.
Format: networks/{network_code}/orders/{order_id}
optional string order = 2 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for order. |
getPredictedDeliveryUnits()
public long getPredictedDeliveryUnits()The number of units, defined by Goal.unitType, that will be delivered by the line item. Delivery of existing line items that are of same or lower priorities may be impacted.
optional int64 predicted_delivery_units = 4;
| Returns | |
|---|---|
| Type | Description |
long |
The predictedDeliveryUnits. |
getUnitType()
public UnitTypeEnum.UnitType getUnitType()The unit with which the goal or cap of the LineItem is defined. Will be the same value as Goal.unitType for both a set line item or a prospective one.
optional .google.ads.admanager.v1.UnitTypeEnum.UnitType unit_type = 3;
| Returns | |
|---|---|
| Type | Description |
UnitTypeEnum.UnitType |
The unitType. |
getUnitTypeValue()
public int getUnitTypeValue()The unit with which the goal or cap of the LineItem is defined. Will be the same value as Goal.unitType for both a set line item or a prospective one.
optional .google.ads.admanager.v1.UnitTypeEnum.UnitType unit_type = 3;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for unitType. |
hasDeliveredUnits()
public boolean hasDeliveredUnits()The number of units, defined by Goal.unitType, that have already been served if the reservation is already running.
optional int64 delivered_units = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the deliveredUnits field is set. |
hasLineItem()
public boolean hasLineItem() Uniquely identifies this line item delivery forecast. This value is
read-only and will be either the resource name of the
LineItem resource it represents, or
unset if the forecast represents a prospective line item. Format:
networks/{network_code}/lineItems/{line_item_id}
optional string line_item = 1 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the lineItem field is set. |
hasMatchedUnits()
public boolean hasMatchedUnits()The number of units, defined by Goal.unitType, that match the specified LineItem#targeting and delivery settings.
optional int64 matched_units = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the matchedUnits field is set. |
hasOrder()
public boolean hasOrder() The resource name of the Order object that
this line item belongs to, or null if the forecast represents a prospective
line item without an
LineItem.order set.
Format: networks/{network_code}/orders/{order_id}
optional string order = 2 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the order field is set. |
hasPredictedDeliveryUnits()
public boolean hasPredictedDeliveryUnits()The number of units, defined by Goal.unitType, that will be delivered by the line item. Delivery of existing line items that are of same or lower priorities may be impacted.
optional int64 predicted_delivery_units = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the predictedDeliveryUnits field is set. |
hasUnitType()
public boolean hasUnitType()The unit with which the goal or cap of the LineItem is defined. Will be the same value as Goal.unitType for both a set line item or a prospective one.
optional .google.ads.admanager.v1.UnitTypeEnum.UnitType unit_type = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the unitType field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(LineItemDeliveryForecast other)
public LineItemDeliveryForecast.Builder mergeFrom(LineItemDeliveryForecast other)| Parameter | |
|---|---|
| Name | Description |
other |
LineItemDeliveryForecast |
| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecast.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public LineItemDeliveryForecast.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecast.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public LineItemDeliveryForecast.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecast.Builder |
|
setDeliveredUnits(long value)
public LineItemDeliveryForecast.Builder setDeliveredUnits(long value)The number of units, defined by Goal.unitType, that have already been served if the reservation is already running.
optional int64 delivered_units = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe deliveredUnits to set. |
| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecast.Builder |
This builder for chaining. |
setLineItem(String value)
public LineItemDeliveryForecast.Builder setLineItem(String value) Uniquely identifies this line item delivery forecast. This value is
read-only and will be either the resource name of the
LineItem resource it represents, or
unset if the forecast represents a prospective line item. Format:
networks/{network_code}/lineItems/{line_item_id}
optional string line_item = 1 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe lineItem to set. |
| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecast.Builder |
This builder for chaining. |
setLineItemBytes(ByteString value)
public LineItemDeliveryForecast.Builder setLineItemBytes(ByteString value) Uniquely identifies this line item delivery forecast. This value is
read-only and will be either the resource name of the
LineItem resource it represents, or
unset if the forecast represents a prospective line item. Format:
networks/{network_code}/lineItems/{line_item_id}
optional string line_item = 1 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for lineItem to set. |
| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecast.Builder |
This builder for chaining. |
setMatchedUnits(long value)
public LineItemDeliveryForecast.Builder setMatchedUnits(long value)The number of units, defined by Goal.unitType, that match the specified LineItem#targeting and delivery settings.
optional int64 matched_units = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe matchedUnits to set. |
| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecast.Builder |
This builder for chaining. |
setOrder(String value)
public LineItemDeliveryForecast.Builder setOrder(String value) The resource name of the Order object that
this line item belongs to, or null if the forecast represents a prospective
line item without an
LineItem.order set.
Format: networks/{network_code}/orders/{order_id}
optional string order = 2 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe order to set. |
| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecast.Builder |
This builder for chaining. |
setOrderBytes(ByteString value)
public LineItemDeliveryForecast.Builder setOrderBytes(ByteString value) The resource name of the Order object that
this line item belongs to, or null if the forecast represents a prospective
line item without an
LineItem.order set.
Format: networks/{network_code}/orders/{order_id}
optional string order = 2 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for order to set. |
| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecast.Builder |
This builder for chaining. |
setPredictedDeliveryUnits(long value)
public LineItemDeliveryForecast.Builder setPredictedDeliveryUnits(long value)The number of units, defined by Goal.unitType, that will be delivered by the line item. Delivery of existing line items that are of same or lower priorities may be impacted.
optional int64 predicted_delivery_units = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe predictedDeliveryUnits to set. |
| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecast.Builder |
This builder for chaining. |
setUnitType(UnitTypeEnum.UnitType value)
public LineItemDeliveryForecast.Builder setUnitType(UnitTypeEnum.UnitType value)The unit with which the goal or cap of the LineItem is defined. Will be the same value as Goal.unitType for both a set line item or a prospective one.
optional .google.ads.admanager.v1.UnitTypeEnum.UnitType unit_type = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
UnitTypeEnum.UnitTypeThe unitType to set. |
| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecast.Builder |
This builder for chaining. |
setUnitTypeValue(int value)
public LineItemDeliveryForecast.Builder setUnitTypeValue(int value)The unit with which the goal or cap of the LineItem is defined. Will be the same value as Goal.unitType for both a set line item or a prospective one.
optional .google.ads.admanager.v1.UnitTypeEnum.UnitType unit_type = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for unitType to set. |
| Returns | |
|---|---|
| Type | Description |
LineItemDeliveryForecast.Builder |
This builder for chaining. |