Class Order (0.25.0)

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.v1.Order

Implements

OrderOrBuilder

Static Fields

CANCELLED_LINE_ITEMS_FIELD_NUMBER

public static final int CANCELLED_LINE_ITEMS_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
TypeDescription
int

LINE_ITEMS_FIELD_NUMBER

public static final int LINE_ITEMS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Order getDefaultInstance()
Returns
TypeDescription
Order

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Order.Builder newBuilder()
Returns
TypeDescription
Order.Builder

newBuilder(Order prototype)

public static Order.Builder newBuilder(Order prototype)
Parameter
NameDescription
prototypeOrder
Returns
TypeDescription
Order.Builder

parseDelimitedFrom(InputStream input)

public static Order parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Order
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Order parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Order
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Order parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Order
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Order parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Order
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Order parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Order
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Order parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Order
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Order parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Order
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Order parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Order
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Order parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Order
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Order parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Order
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Order parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Order
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Order parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Order
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Order> parser()
Returns
TypeDescription
Parser<Order>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCancelledLineItems(int index)

public LineItem getCancelledLineItems(int index)

Output only. Line items that were cancelled.

repeated .google.cloud.commerce.consumer.procurement.v1.LineItem cancelled_line_items = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
LineItem

getCancelledLineItemsCount()

public int getCancelledLineItemsCount()

Output only. Line items that were cancelled.

repeated .google.cloud.commerce.consumer.procurement.v1.LineItem cancelled_line_items = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

getCancelledLineItemsList()

public List<LineItem> getCancelledLineItemsList()

Output only. Line items that were cancelled.

repeated .google.cloud.commerce.consumer.procurement.v1.LineItem cancelled_line_items = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<LineItem>

getCancelledLineItemsOrBuilder(int index)

public LineItemOrBuilder getCancelledLineItemsOrBuilder(int index)

Output only. Line items that were cancelled.

repeated .google.cloud.commerce.consumer.procurement.v1.LineItem cancelled_line_items = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
LineItemOrBuilder

getCancelledLineItemsOrBuilderList()

public List<? extends LineItemOrBuilder> getCancelledLineItemsOrBuilderList()

Output only. Line items that were cancelled.

repeated .google.cloud.commerce.consumer.procurement.v1.LineItem cancelled_line_items = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<? extends com.google.cloud.commerce.consumer.procurement.v1.LineItemOrBuilder>

getCreateTime()

public Timestamp getCreateTime()

Output only. The creation timestamp.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation timestamp.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Order getDefaultInstanceForType()
Returns
TypeDescription
Order

getDisplayName()

public String getDisplayName()

Required. The user-specified name of the order.

string display_name = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The user-specified name of the order.

string display_name = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for displayName.

getEtag()

public String getEtag()

The weak etag of the order.

string etag = 11;

Returns
TypeDescription
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

The weak etag of the order.

string etag = 11;

Returns
TypeDescription
ByteString

The bytes for etag.

getLineItems(int index)

public LineItem getLineItems(int index)

Output only. The items being purchased.

repeated .google.cloud.commerce.consumer.procurement.v1.LineItem line_items = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
LineItem

getLineItemsCount()

public int getLineItemsCount()

Output only. The items being purchased.

repeated .google.cloud.commerce.consumer.procurement.v1.LineItem line_items = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

getLineItemsList()

public List<LineItem> getLineItemsList()

Output only. The items being purchased.

repeated .google.cloud.commerce.consumer.procurement.v1.LineItem line_items = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<LineItem>

getLineItemsOrBuilder(int index)

public LineItemOrBuilder getLineItemsOrBuilder(int index)

Output only. The items being purchased.

repeated .google.cloud.commerce.consumer.procurement.v1.LineItem line_items = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
LineItemOrBuilder

getLineItemsOrBuilderList()

public List<? extends LineItemOrBuilder> getLineItemsOrBuilderList()

Output only. The items being purchased.

repeated .google.cloud.commerce.consumer.procurement.v1.LineItem line_items = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<? extends com.google.cloud.commerce.consumer.procurement.v1.LineItemOrBuilder>

getName()

public String 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];

Returns
TypeDescription
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];

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Order> getParserForType()
Returns
TypeDescription
Parser<Order>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The last update timestamp.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The last update timestamp.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The creation timestamp.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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];

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Order.Builder newBuilderForType()
Returns
TypeDescription
Order.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Order.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Order.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Order.Builder toBuilder()
Returns
TypeDescription
Order.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException