public final class Order extends GeneratedMessageV3 implements OrderOrBuilder
Represents a purchase made by a customer on Cloud Marketplace.
Creating an order makes sure that both the Google backend systems
as well as external service provider's systems (if needed) allow use of
purchased products and ensures the appropriate billing events occur.
An Order can be made against one Product with multiple add-ons (optional) or
one Quote which might reference multiple products.
Customers typically choose a price plan for each Product purchased when
they create an order and can change their plan later, if the product allows.
Protobuf type google.cloud.commerce.consumer.procurement.v1alpha1.Order
Static Fields
CANCELLED_LINE_ITEMS_FIELD_NUMBER
public static final int CANCELLED_LINE_ITEMS_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
Field Value
LINE_ITEMS_FIELD_NUMBER
public static final int LINE_ITEMS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Order getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Order.Builder newBuilder()
Returns
newBuilder(Order prototype)
public static Order.Builder newBuilder(Order prototype)
Parameter
| Name | Description |
| prototype | Order
|
Returns
public static Order parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Order parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Order parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Order parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Order parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Order parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Order parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Order parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Order parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Order parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Order parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Order parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Order> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getCancelledLineItems(int index)
public LineItem getCancelledLineItems(int index)
Output only. Line items that were cancelled.
repeated .google.cloud.commerce.consumer.procurement.v1alpha1.LineItem cancelled_line_items = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCancelledLineItemsCount()
public int getCancelledLineItemsCount()
Output only. Line items that were cancelled.
repeated .google.cloud.commerce.consumer.procurement.v1alpha1.LineItem cancelled_line_items = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCancelledLineItemsList()
public List<LineItem> getCancelledLineItemsList()
Output only. Line items that were cancelled.
repeated .google.cloud.commerce.consumer.procurement.v1alpha1.LineItem cancelled_line_items = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCancelledLineItemsOrBuilder(int index)
public LineItemOrBuilder getCancelledLineItemsOrBuilder(int index)
Output only. Line items that were cancelled.
repeated .google.cloud.commerce.consumer.procurement.v1alpha1.LineItem cancelled_line_items = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCancelledLineItemsOrBuilderList()
public List<? extends LineItemOrBuilder> getCancelledLineItemsOrBuilderList()
Output only. Line items that were cancelled.
repeated .google.cloud.commerce.consumer.procurement.v1alpha1.LineItem cancelled_line_items = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| List<? extends com.google.cloud.commerce.consumer.procurement.v1alpha1.LineItemOrBuilder> | |
getCreateTime()
public Timestamp getCreateTime()
Output only. The creation timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The creation timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Order getDefaultInstanceForType()
Returns
getDisplayName()
public String getDisplayName()
Required. The user-specified name of the order.
Must be unique within a billing account.
string display_name = 10 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Required. The user-specified name of the order.
Must be unique within a billing account.
string display_name = 10 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| ByteString | The bytes for displayName.
|
getEtag()
The weak etag of the order.
string etag = 11;
| Type | Description |
| String | The etag.
|
getEtagBytes()
public ByteString getEtagBytes()
The weak etag of the order.
string etag = 11;
getLineItems(int index)
public LineItem getLineItems(int index)
Output only. The items being purchased.
repeated .google.cloud.commerce.consumer.procurement.v1alpha1.LineItem line_items = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getLineItemsCount()
public int getLineItemsCount()
Output only. The items being purchased.
repeated .google.cloud.commerce.consumer.procurement.v1alpha1.LineItem line_items = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getLineItemsList()
public List<LineItem> getLineItemsList()
Output only. The items being purchased.
repeated .google.cloud.commerce.consumer.procurement.v1alpha1.LineItem line_items = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getLineItemsOrBuilder(int index)
public LineItemOrBuilder getLineItemsOrBuilder(int index)
Output only. The items being purchased.
repeated .google.cloud.commerce.consumer.procurement.v1alpha1.LineItem line_items = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getLineItemsOrBuilderList()
public List<? extends LineItemOrBuilder> getLineItemsOrBuilderList()
Output only. The items being purchased.
repeated .google.cloud.commerce.consumer.procurement.v1alpha1.LineItem line_items = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| List<? extends com.google.cloud.commerce.consumer.procurement.v1alpha1.LineItemOrBuilder> | |
getName()
Output only. The resource name of the order.
Has the form
billingAccounts/{billing_account}/orders/{order}.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. The resource name of the order.
Has the form
billingAccounts/{billing_account}/orders/{order}.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
getParserForType()
public Parser<Order> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The last update timestamp.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The last update timestamp.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. The creation timestamp.
.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The last update timestamp.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Order.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Order.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Order.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
