Reference documentation and code samples for the Google Cloud Commerce Consumer Procurement V1 Client class ModifyOrderRequest.
Request message for ConsumerProcurementService.ModifyOrder.
Generated from protobuf message google.cloud.commerce.consumer.procurement.v1.ModifyOrderRequest
Namespace
Google \ Cloud \ Commerce \ Consumer \ Procurement \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. Name of the order to update. |
↳ modifications |
array<Google\Cloud\Commerce\Consumer\Procurement\V1\ModifyOrderRequest\Modification>
Optional. Modifications for an existing Order created by an Offer. Required when Offer based Order is being modified, except for when going from an offer to a public plan. |
↳ display_name |
string
Optional. Updated display name of the order, leave as empty if you do not want to update current display name. |
↳ etag |
string
Optional. The weak etag, which can be optionally populated, of the order that this modify request is based on. Validation checking will only happen if the invoker supplies this field. |
getName
Required. Name of the order to update.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. Name of the order to update.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getModifications
Optional. Modifications for an existing Order created by an Offer.
Required when Offer based Order is being modified, except for when going from an offer to a public plan.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setModifications
Optional. Modifications for an existing Order created by an Offer.
Required when Offer based Order is being modified, except for when going from an offer to a public plan.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Commerce\Consumer\Procurement\V1\ModifyOrderRequest\Modification>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Optional. Updated display name of the order, leave as empty if you do not want to update current display name.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Optional. Updated display name of the order, leave as empty if you do not want to update current display name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEtag
Optional. The weak etag, which can be optionally populated, of the order that this modify request is based on. Validation checking will only happen if the invoker supplies this field.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEtag
Optional. The weak etag, which can be optionally populated, of the order that this modify request is based on. Validation checking will only happen if the invoker supplies this field.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|