com.google.cloud.retail.v2.PurchaseTransactionOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-retail-v2 Show documentation
Proto library for google-cloud-retail
The newest version!
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/retail/v2/user_event.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.retail.v2;

public interface PurchaseTransactionOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.retail.v2.PurchaseTransaction)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * The transaction ID with a length limit of 128 characters.
   * 
   *
   * string id = 1;
   *
   * @return The id.
   */
  java.lang.String getId();
  /**
   *
   *
   *    * The transaction ID with a length limit of 128 characters.
   * 
   *
   * string id = 1;
   *
   * @return The bytes for id.
   */
  com.google.protobuf.ByteString getIdBytes();

  /**
   *
   *
   *    * Required. Total non-zero revenue or grand total associated with the
   * transaction. This value include shipping, tax, or other adjustments to
   * total revenue that you want to include as part of your revenue
   * calculations.
   * 
   *
   * float revenue = 2 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The revenue.
   */
  float getRevenue();

  /**
   *
   *
   *    * All the taxes associated with the transaction.
   * 
   *
   * float tax = 3;
   *
   * @return The tax.
   */
  float getTax();

  /**
   *
   *
   *    * All the costs associated with the products. These can be manufacturing
   * costs, shipping expenses not borne by the end user, or any other costs,
   * such that:
   *
   * * Profit = [revenue][google.cloud.retail.v2.PurchaseTransaction.revenue] -
   * [tax][google.cloud.retail.v2.PurchaseTransaction.tax] -
   * [cost][google.cloud.retail.v2.PurchaseTransaction.cost]
   * 
   *
   * float cost = 4;
   *
   * @return The cost.
   */
  float getCost();

  /**
   *
   *
   *    * Required. Currency code. Use three-character ISO-4217 code.
   * 
   *
   * string currency_code = 5 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The currencyCode.
   */
  java.lang.String getCurrencyCode();
  /**
   *
   *
   *    * Required. Currency code. Use three-character ISO-4217 code.
   * 
   *
   * string currency_code = 5 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for currencyCode.
   */
  com.google.protobuf.ByteString getCurrencyCodeBytes();
}