Package com.google.cloud.commerce.consumer.procurement.v1

Class Order

  • All Implemented Interfaces:
    OrderOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Order
extends com.google.protobuf.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
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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];
        Specified by:
        getName in interface OrderOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.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];
        Specified by:
        getNameBytes in interface OrderOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         Required. The user-specified name of the order.
        string display_name = 10 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayName in interface OrderOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Required. The user-specified name of the order.
        string display_name = 10 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayNameBytes in interface OrderOrBuilder
        Returns:
        The bytes for displayName.

      • 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];
        Specified by:
        getLineItemsList in interface OrderOrBuilder

      • 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];
        Specified by:
        getLineItemsOrBuilderList in interface OrderOrBuilder

      • 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];
        Specified by:
        getLineItemsCount in interface OrderOrBuilder

      • getLineItems

        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];
        Specified by:
        getLineItems in interface OrderOrBuilder

      • getLineItemsOrBuilder

        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];
        Specified by:
        getLineItemsOrBuilder in interface OrderOrBuilder

      • 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];
        Specified by:
        getCancelledLineItemsList in interface OrderOrBuilder

      • 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];
        Specified by:
        getCancelledLineItemsOrBuilderList in interface OrderOrBuilder

      • 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];
        Specified by:
        getCancelledLineItemsCount in interface OrderOrBuilder

      • getCancelledLineItems

        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];
        Specified by:
        getCancelledLineItems in interface OrderOrBuilder

      • getCancelledLineItemsOrBuilder

        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];
        Specified by:
        getCancelledLineItemsOrBuilder in interface OrderOrBuilder

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The creation timestamp.
        .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface OrderOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The creation timestamp.
        .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface OrderOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The creation timestamp.
        .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface OrderOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. The last update timestamp.
        .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface OrderOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. The last update timestamp.
        .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface OrderOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The last update timestamp.
        .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface OrderOrBuilder

      • getEtag

        public String getEtag()
         The weak etag of the order.
        string etag = 11;
        Specified by:
        getEtag in interface OrderOrBuilder
        Returns:
        The etag.

      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         The weak etag of the order.
        string etag = 11;
        Specified by:
        getEtagBytes in interface OrderOrBuilder
        Returns:
        The bytes for etag.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Order parseFrom​(ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Order parseFrom​(ByteBuffer data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Order parseFrom​(com.google.protobuf.ByteString data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Order parseFrom​(com.google.protobuf.ByteString data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Order parseFrom​(byte[] data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Order parseFrom​(byte[] data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Order parseFrom​(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Order.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Order.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Order.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Order getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Order> parser()

      • getParserForType

        public com.google.protobuf.Parser<Order> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Order getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder