com.google.cloud.retail.v2.PriceInfoOrBuilder 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/common.proto

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

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

  /**
   *
   *
   *    * The 3-letter currency code defined in [ISO
   * 4217](https://www.iso.org/iso-4217-currency-codes.html).
   *
   * If this field is an unrecognizable currency code, an INVALID_ARGUMENT
   * error is returned.
   *
   * The [Product.Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]
   * [Product][google.cloud.retail.v2.Product]s with the same
   * [Product.primary_product_id][google.cloud.retail.v2.Product.primary_product_id]
   * must share the same
   * [currency_code][google.cloud.retail.v2.PriceInfo.currency_code]. Otherwise,
   * a FAILED_PRECONDITION error is returned.
   * 
   *
   * string currency_code = 1;
   *
   * @return The currencyCode.
   */
  java.lang.String getCurrencyCode();
  /**
   *
   *
   *    * The 3-letter currency code defined in [ISO
   * 4217](https://www.iso.org/iso-4217-currency-codes.html).
   *
   * If this field is an unrecognizable currency code, an INVALID_ARGUMENT
   * error is returned.
   *
   * The [Product.Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]
   * [Product][google.cloud.retail.v2.Product]s with the same
   * [Product.primary_product_id][google.cloud.retail.v2.Product.primary_product_id]
   * must share the same
   * [currency_code][google.cloud.retail.v2.PriceInfo.currency_code]. Otherwise,
   * a FAILED_PRECONDITION error is returned.
   * 
   *
   * string currency_code = 1;
   *
   * @return The bytes for currencyCode.
   */
  com.google.protobuf.ByteString getCurrencyCodeBytes();

  /**
   *
   *
   *    * Price of the product.
   *
   * Google Merchant Center property
   * [price](https://support.google.com/merchants/answer/6324371). Schema.org
   * property [Offer.price](https://schema.org/price).
   * 
   *
   * float price = 2;
   *
   * @return The price.
   */
  float getPrice();

  /**
   *
   *
   *    * Price of the product without any discount. If zero, by default set to be
   * the [price][google.cloud.retail.v2.PriceInfo.price]. If set,
   * [original_price][google.cloud.retail.v2.PriceInfo.original_price] should be
   * greater than or equal to [price][google.cloud.retail.v2.PriceInfo.price],
   * otherwise an INVALID_ARGUMENT error is thrown.
   * 
   *
   * float original_price = 3;
   *
   * @return The originalPrice.
   */
  float getOriginalPrice();

  /**
   *
   *
   *    * The costs associated with the sale of a particular product. Used for gross
   * profit reporting.
   *
   * * Profit = [price][google.cloud.retail.v2.PriceInfo.price] -
   * [cost][google.cloud.retail.v2.PriceInfo.cost]
   *
   * Google Merchant Center property
   * [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895).
   * 
   *
   * float cost = 4;
   *
   * @return The cost.
   */
  float getCost();

  /**
   *
   *
   *    * The timestamp when the [price][google.cloud.retail.v2.PriceInfo.price]
   * starts to be effective. This can be set as a future timestamp, and the
   * [price][google.cloud.retail.v2.PriceInfo.price] is only used for search
   * after
   * [price_effective_time][google.cloud.retail.v2.PriceInfo.price_effective_time].
   * If so, the
   * [original_price][google.cloud.retail.v2.PriceInfo.original_price] must be
   * set and [original_price][google.cloud.retail.v2.PriceInfo.original_price]
   * is used before
   * [price_effective_time][google.cloud.retail.v2.PriceInfo.price_effective_time].
   *
   * Do not set if [price][google.cloud.retail.v2.PriceInfo.price] is always
   * effective because it will cause additional latency during search.
   * 
   *
   * .google.protobuf.Timestamp price_effective_time = 5;
   *
   * @return Whether the priceEffectiveTime field is set.
   */
  boolean hasPriceEffectiveTime();
  /**
   *
   *
   *    * The timestamp when the [price][google.cloud.retail.v2.PriceInfo.price]
   * starts to be effective. This can be set as a future timestamp, and the
   * [price][google.cloud.retail.v2.PriceInfo.price] is only used for search
   * after
   * [price_effective_time][google.cloud.retail.v2.PriceInfo.price_effective_time].
   * If so, the
   * [original_price][google.cloud.retail.v2.PriceInfo.original_price] must be
   * set and [original_price][google.cloud.retail.v2.PriceInfo.original_price]
   * is used before
   * [price_effective_time][google.cloud.retail.v2.PriceInfo.price_effective_time].
   *
   * Do not set if [price][google.cloud.retail.v2.PriceInfo.price] is always
   * effective because it will cause additional latency during search.
   * 
   *
   * .google.protobuf.Timestamp price_effective_time = 5;
   *
   * @return The priceEffectiveTime.
   */
  com.google.protobuf.Timestamp getPriceEffectiveTime();
  /**
   *
   *
   *    * The timestamp when the [price][google.cloud.retail.v2.PriceInfo.price]
   * starts to be effective. This can be set as a future timestamp, and the
   * [price][google.cloud.retail.v2.PriceInfo.price] is only used for search
   * after
   * [price_effective_time][google.cloud.retail.v2.PriceInfo.price_effective_time].
   * If so, the
   * [original_price][google.cloud.retail.v2.PriceInfo.original_price] must be
   * set and [original_price][google.cloud.retail.v2.PriceInfo.original_price]
   * is used before
   * [price_effective_time][google.cloud.retail.v2.PriceInfo.price_effective_time].
   *
   * Do not set if [price][google.cloud.retail.v2.PriceInfo.price] is always
   * effective because it will cause additional latency during search.
   * 
   *
   * .google.protobuf.Timestamp price_effective_time = 5;
   */
  com.google.protobuf.TimestampOrBuilder getPriceEffectiveTimeOrBuilder();

  /**
   *
   *
   *    * The timestamp when the [price][google.cloud.retail.v2.PriceInfo.price]
   * stops to be effective. The [price][google.cloud.retail.v2.PriceInfo.price]
   * is used for search before
   * [price_expire_time][google.cloud.retail.v2.PriceInfo.price_expire_time]. If
   * this field is set, the
   * [original_price][google.cloud.retail.v2.PriceInfo.original_price] must be
   * set and [original_price][google.cloud.retail.v2.PriceInfo.original_price]
   * is used after
   * [price_expire_time][google.cloud.retail.v2.PriceInfo.price_expire_time].
   *
   * Do not set if [price][google.cloud.retail.v2.PriceInfo.price] is always
   * effective because it will cause additional latency during search.
   * 
   *
   * .google.protobuf.Timestamp price_expire_time = 6;
   *
   * @return Whether the priceExpireTime field is set.
   */
  boolean hasPriceExpireTime();
  /**
   *
   *
   *    * The timestamp when the [price][google.cloud.retail.v2.PriceInfo.price]
   * stops to be effective. The [price][google.cloud.retail.v2.PriceInfo.price]
   * is used for search before
   * [price_expire_time][google.cloud.retail.v2.PriceInfo.price_expire_time]. If
   * this field is set, the
   * [original_price][google.cloud.retail.v2.PriceInfo.original_price] must be
   * set and [original_price][google.cloud.retail.v2.PriceInfo.original_price]
   * is used after
   * [price_expire_time][google.cloud.retail.v2.PriceInfo.price_expire_time].
   *
   * Do not set if [price][google.cloud.retail.v2.PriceInfo.price] is always
   * effective because it will cause additional latency during search.
   * 
   *
   * .google.protobuf.Timestamp price_expire_time = 6;
   *
   * @return The priceExpireTime.
   */
  com.google.protobuf.Timestamp getPriceExpireTime();
  /**
   *
   *
   *    * The timestamp when the [price][google.cloud.retail.v2.PriceInfo.price]
   * stops to be effective. The [price][google.cloud.retail.v2.PriceInfo.price]
   * is used for search before
   * [price_expire_time][google.cloud.retail.v2.PriceInfo.price_expire_time]. If
   * this field is set, the
   * [original_price][google.cloud.retail.v2.PriceInfo.original_price] must be
   * set and [original_price][google.cloud.retail.v2.PriceInfo.original_price]
   * is used after
   * [price_expire_time][google.cloud.retail.v2.PriceInfo.price_expire_time].
   *
   * Do not set if [price][google.cloud.retail.v2.PriceInfo.price] is always
   * effective because it will cause additional latency during search.
   * 
   *
   * .google.protobuf.Timestamp price_expire_time = 6;
   */
  com.google.protobuf.TimestampOrBuilder getPriceExpireTimeOrBuilder();

  /**
   *
   *
   *    * Output only. The price range of all the child
   * [Product.Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]
   * [Product][google.cloud.retail.v2.Product]s grouped together on the
   * [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]
   * [Product][google.cloud.retail.v2.Product]. Only populated for
   * [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]
   * [Product][google.cloud.retail.v2.Product]s.
   *
   * Note: This field is OUTPUT_ONLY for
   * [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct].
   * Do not set this field in API requests.
   * 
   *
   * 
   * .google.cloud.retail.v2.PriceInfo.PriceRange price_range = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return Whether the priceRange field is set.
   */
  boolean hasPriceRange();
  /**
   *
   *
   *    * Output only. The price range of all the child
   * [Product.Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]
   * [Product][google.cloud.retail.v2.Product]s grouped together on the
   * [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]
   * [Product][google.cloud.retail.v2.Product]. Only populated for
   * [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]
   * [Product][google.cloud.retail.v2.Product]s.
   *
   * Note: This field is OUTPUT_ONLY for
   * [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct].
   * Do not set this field in API requests.
   * 
   *
   * 
   * .google.cloud.retail.v2.PriceInfo.PriceRange price_range = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The priceRange.
   */
  com.google.cloud.retail.v2.PriceInfo.PriceRange getPriceRange();
  /**
   *
   *
   *    * Output only. The price range of all the child
   * [Product.Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]
   * [Product][google.cloud.retail.v2.Product]s grouped together on the
   * [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]
   * [Product][google.cloud.retail.v2.Product]. Only populated for
   * [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]
   * [Product][google.cloud.retail.v2.Product]s.
   *
   * Note: This field is OUTPUT_ONLY for
   * [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct].
   * Do not set this field in API requests.
   * 
   *
   * 
   * .google.cloud.retail.v2.PriceInfo.PriceRange price_range = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   */
  com.google.cloud.retail.v2.PriceInfo.PriceRangeOrBuilder getPriceRangeOrBuilder();
}