com.google.api.services.retail.v2.model.GoogleCloudRetailV2PurchaseTransaction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-retail Show documentation
The newest version!
/*
 * 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
 *
 * http://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.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.retail.v2.model;

/**
 * A transaction represents the entire purchase transaction.
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Vertex AI Search for Retail API. For a detailed
 * explanation see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GoogleCloudRetailV2PurchaseTransaction extends com.google.api.client.json.GenericJson {

  /**
   * 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 - tax - cost
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Float cost;

  /**
   * Required. Currency code. Use three-character ISO-4217 code.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String currencyCode;

  /**
   * The transaction ID with a length limit of 128 characters.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String id;

  /**
   * 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.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Float revenue;

  /**
   * All the taxes associated with the transaction.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Float tax;

  /**
   * 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 - tax - cost
   * @return value or {@code null} for none
   */
  public java.lang.Float getCost() {
    return cost;
  }

  /**
   * 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 - tax - cost
   * @param cost cost or {@code null} for none
   */
  public GoogleCloudRetailV2PurchaseTransaction setCost(java.lang.Float cost) {
    this.cost = cost;
    return this;
  }

  /**
   * Required. Currency code. Use three-character ISO-4217 code.
   * @return value or {@code null} for none
   */
  public java.lang.String getCurrencyCode() {
    return currencyCode;
  }

  /**
   * Required. Currency code. Use three-character ISO-4217 code.
   * @param currencyCode currencyCode or {@code null} for none
   */
  public GoogleCloudRetailV2PurchaseTransaction setCurrencyCode(java.lang.String currencyCode) {
    this.currencyCode = currencyCode;
    return this;
  }

  /**
   * The transaction ID with a length limit of 128 characters.
   * @return value or {@code null} for none
   */
  public java.lang.String getId() {
    return id;
  }

  /**
   * The transaction ID with a length limit of 128 characters.
   * @param id id or {@code null} for none
   */
  public GoogleCloudRetailV2PurchaseTransaction setId(java.lang.String id) {
    this.id = id;
    return this;
  }

  /**
   * 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.
   * @return value or {@code null} for none
   */
  public java.lang.Float getRevenue() {
    return revenue;
  }

  /**
   * 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.
   * @param revenue revenue or {@code null} for none
   */
  public GoogleCloudRetailV2PurchaseTransaction setRevenue(java.lang.Float revenue) {
    this.revenue = revenue;
    return this;
  }

  /**
   * All the taxes associated with the transaction.
   * @return value or {@code null} for none
   */
  public java.lang.Float getTax() {
    return tax;
  }

  /**
   * All the taxes associated with the transaction.
   * @param tax tax or {@code null} for none
   */
  public GoogleCloudRetailV2PurchaseTransaction setTax(java.lang.Float tax) {
    this.tax = tax;
    return this;
  }

  @Override
  public GoogleCloudRetailV2PurchaseTransaction set(String fieldName, Object value) {
    return (GoogleCloudRetailV2PurchaseTransaction) super.set(fieldName, value);
  }

  @Override
  public GoogleCloudRetailV2PurchaseTransaction clone() {
    return (GoogleCloudRetailV2PurchaseTransaction) super.clone();
  }

}