Class LineItemDeliveryForecast (0.62.0)

public final class LineItemDeliveryForecast extends GeneratedMessage implements LineItemDeliveryForecastOrBuilder

The forecasted delivery of a [ProposalLineItem][] or LineItem.

Protobuf type google.ads.admanager.v1.LineItemDeliveryForecast

Static Fields

DELIVERED_UNITS_FIELD_NUMBER

public static final int DELIVERED_UNITS_FIELD_NUMBER
Field Value
Type Description
int

LINE_ITEM_FIELD_NUMBER

public static final int LINE_ITEM_FIELD_NUMBER
Field Value
Type Description
int

MATCHED_UNITS_FIELD_NUMBER

public static final int MATCHED_UNITS_FIELD_NUMBER
Field Value
Type Description
int

ORDER_FIELD_NUMBER

public static final int ORDER_FIELD_NUMBER
Field Value
Type Description
int

PREDICTED_DELIVERY_UNITS_FIELD_NUMBER

public static final int PREDICTED_DELIVERY_UNITS_FIELD_NUMBER
Field Value
Type Description
int

UNIT_TYPE_FIELD_NUMBER

public static final int UNIT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static LineItemDeliveryForecast getDefaultInstance()
Returns
Type Description
LineItemDeliveryForecast

getDescriptor()

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

newBuilder()

public static LineItemDeliveryForecast.Builder newBuilder()
Returns
Type Description
LineItemDeliveryForecast.Builder

newBuilder(LineItemDeliveryForecast prototype)

public static LineItemDeliveryForecast.Builder newBuilder(LineItemDeliveryForecast prototype)
Parameter
Name Description
prototype LineItemDeliveryForecast
Returns
Type Description
LineItemDeliveryForecast.Builder

parseDelimitedFrom(InputStream input)

public static LineItemDeliveryForecast parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LineItemDeliveryForecast
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LineItemDeliveryForecast parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LineItemDeliveryForecast
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static LineItemDeliveryForecast parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
LineItemDeliveryForecast
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LineItemDeliveryForecast parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LineItemDeliveryForecast
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LineItemDeliveryForecast parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
LineItemDeliveryForecast
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LineItemDeliveryForecast parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LineItemDeliveryForecast
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LineItemDeliveryForecast parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
LineItemDeliveryForecast
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LineItemDeliveryForecast parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LineItemDeliveryForecast
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static LineItemDeliveryForecast parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LineItemDeliveryForecast
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LineItemDeliveryForecast parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LineItemDeliveryForecast
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static LineItemDeliveryForecast parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
LineItemDeliveryForecast
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LineItemDeliveryForecast parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LineItemDeliveryForecast
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<LineItemDeliveryForecast> parser()
Returns
Type Description
Parser<LineItemDeliveryForecast>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

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.

getParserForType()

public Parser<LineItemDeliveryForecast> getParserForType()
Returns
Type Description
Parser<LineItemDeliveryForecast>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public LineItemDeliveryForecast.Builder newBuilderForType()
Returns
Type Description
LineItemDeliveryForecast.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected LineItemDeliveryForecast.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
LineItemDeliveryForecast.Builder
Overrides

toBuilder()

public LineItemDeliveryForecast.Builder toBuilder()
Returns
Type Description
LineItemDeliveryForecast.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException