Google Cloud Optimization V1 Client - Class SkippedShipment (0.2.0)

Reference documentation and code samples for the Google Cloud Optimization V1 Client class SkippedShipment.

Specifies details of unperformed shipments in a solution. For trivial cases and/or if we are able to identify the cause for skipping, we report the reason here.

Generated from protobuf message google.cloud.optimization.v1.SkippedShipment

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ index
int

The index corresponds to the index of the shipment in the source ShipmentModel .

↳ label
string

Copy of the corresponding Shipment.label , if specified in the Shipment .

↳ reasons
array< Google\Cloud\Optimization\V1\SkippedShipment\Reason >

A list of reasons that explain why the shipment was skipped. See comment above Reason .

getIndex

The index corresponds to the index of the shipment in the source ShipmentModel .

Returns
Type
Description
int

setIndex

The index corresponds to the index of the shipment in the source ShipmentModel .

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getLabel

Copy of the corresponding Shipment.label , if specified in the Shipment .

Returns
Type
Description
string

setLabel

Copy of the corresponding Shipment.label , if specified in the Shipment .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getReasons

A list of reasons that explain why the shipment was skipped. See comment above Reason .

Returns
Type
Description

setReasons

A list of reasons that explain why the shipment was skipped. See comment above Reason .

Parameter
Name
Description
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: