com.google.cloud.retail.v2alpha.AttributesConfigOrBuilder 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-v2alpha Show documentation
Proto library for google-cloud-retail
There is a newer version: 2.55.0
Show 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/v2alpha/catalog.proto

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

public interface AttributesConfigOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.retail.v2alpha.AttributesConfig)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. Immutable. The fully qualified resource name of the attribute
   * config. Format: `projects/*/locations/*/catalogs/*/attributesConfig`
   * 
   *
   * 
   * string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
   * 
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   *    * Required. Immutable. The fully qualified resource name of the attribute
   * config. Format: `projects/*/locations/*/catalogs/*/attributesConfig`
   * 
   *
   * 
   * string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
   * 
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * Enable attribute(s) config at catalog level.
   * For example, indexable, dynamic_facetable, or searchable for each
   * attribute.
   *
   * The key is catalog attribute's name.
   * For example: `color`, `brands`, `attributes.custom_attribute`, such as
   * `attributes.xyz`.
   *
   * The maximum number of catalog attributes allowed in a request is 1000.
   * 
   *
   * map<string, .google.cloud.retail.v2alpha.CatalogAttribute> catalog_attributes = 2;
   * 
   */
  int getCatalogAttributesCount();
  /**
   *
   *
   *    * Enable attribute(s) config at catalog level.
   * For example, indexable, dynamic_facetable, or searchable for each
   * attribute.
   *
   * The key is catalog attribute's name.
   * For example: `color`, `brands`, `attributes.custom_attribute`, such as
   * `attributes.xyz`.
   *
   * The maximum number of catalog attributes allowed in a request is 1000.
   * 
   *
   * map<string, .google.cloud.retail.v2alpha.CatalogAttribute> catalog_attributes = 2;
   * 
   */
  boolean containsCatalogAttributes(java.lang.String key);
  /** Use {@link #getCatalogAttributesMap()} instead. */
  @java.lang.Deprecated
  java.util.Map
      getCatalogAttributes();
  /**
   *
   *
   *    * Enable attribute(s) config at catalog level.
   * For example, indexable, dynamic_facetable, or searchable for each
   * attribute.
   *
   * The key is catalog attribute's name.
   * For example: `color`, `brands`, `attributes.custom_attribute`, such as
   * `attributes.xyz`.
   *
   * The maximum number of catalog attributes allowed in a request is 1000.
   * 
   *
   * map<string, .google.cloud.retail.v2alpha.CatalogAttribute> catalog_attributes = 2;
   * 
   */
  java.util.Map
      getCatalogAttributesMap();
  /**
   *
   *
   *    * Enable attribute(s) config at catalog level.
   * For example, indexable, dynamic_facetable, or searchable for each
   * attribute.
   *
   * The key is catalog attribute's name.
   * For example: `color`, `brands`, `attributes.custom_attribute`, such as
   * `attributes.xyz`.
   *
   * The maximum number of catalog attributes allowed in a request is 1000.
   * 
   *
   * map<string, .google.cloud.retail.v2alpha.CatalogAttribute> catalog_attributes = 2;
   * 
   */
  /* nullable */
  com.google.cloud.retail.v2alpha.CatalogAttribute getCatalogAttributesOrDefault(
      java.lang.String key,
      /* nullable */
      com.google.cloud.retail.v2alpha.CatalogAttribute defaultValue);
  /**
   *
   *
   *    * Enable attribute(s) config at catalog level.
   * For example, indexable, dynamic_facetable, or searchable for each
   * attribute.
   *
   * The key is catalog attribute's name.
   * For example: `color`, `brands`, `attributes.custom_attribute`, such as
   * `attributes.xyz`.
   *
   * The maximum number of catalog attributes allowed in a request is 1000.
   * 
   *
   * map<string, .google.cloud.retail.v2alpha.CatalogAttribute> catalog_attributes = 2;
   * 
   */
  com.google.cloud.retail.v2alpha.CatalogAttribute getCatalogAttributesOrThrow(
      java.lang.String key);

  /**
   *
   *
   *    * Output only. The
   * [AttributeConfigLevel][google.cloud.retail.v2alpha.AttributeConfigLevel]
   * used for this catalog.
   * 
   *
   * 
   * .google.cloud.retail.v2alpha.AttributeConfigLevel attribute_config_level = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The enum numeric value on the wire for attributeConfigLevel.
   */
  int getAttributeConfigLevelValue();
  /**
   *
   *
   *    * Output only. The
   * [AttributeConfigLevel][google.cloud.retail.v2alpha.AttributeConfigLevel]
   * used for this catalog.
   * 
   *
   * 
   * .google.cloud.retail.v2alpha.AttributeConfigLevel attribute_config_level = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The attributeConfigLevel.
   */
  com.google.cloud.retail.v2alpha.AttributeConfigLevel getAttributeConfigLevel();
}