Package com.google.cloud.retail.v2

Class AttributesConfig

  • All Implemented Interfaces:
    AttributesConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class AttributesConfig
extends com.google.protobuf.GeneratedMessageV3
implements AttributesConfigOrBuilder
     Catalog level attribute config.
    Protobuf type google.cloud.retail.v2.AttributesConfig
    See Also:
    Serialized Form

    • Field Detail

      • CATALOG_ATTRIBUTES_FIELD_NUMBER

        public static final int CATALOG_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ATTRIBUTE_CONFIG_LEVEL_FIELD_NUMBER

        public static final int ATTRIBUTE_CONFIG_LEVEL_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • getName

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

      • getNameBytes

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

      • getCatalogAttributesCount

        public int getCatalogAttributesCount()
        Description copied from interface: AttributesConfigOrBuilder
         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.v2.CatalogAttribute> catalog_attributes = 2;
        Specified by:
        getCatalogAttributesCount in interface AttributesConfigOrBuilder

      • containsCatalogAttributes

        public boolean containsCatalogAttributes​(String key)
         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.v2.CatalogAttribute> catalog_attributes = 2;
        Specified by:
        containsCatalogAttributes in interface AttributesConfigOrBuilder

      • getCatalogAttributesMap

        public Map<String,​CatalogAttribute> 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.v2.CatalogAttribute> catalog_attributes = 2;
        Specified by:
        getCatalogAttributesMap in interface AttributesConfigOrBuilder

      • getCatalogAttributesOrDefault

        public CatalogAttribute getCatalogAttributesOrDefault​(String key,
                                                      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.v2.CatalogAttribute> catalog_attributes = 2;
        Specified by:
        getCatalogAttributesOrDefault in interface AttributesConfigOrBuilder

      • getCatalogAttributesOrThrow

        public CatalogAttribute getCatalogAttributesOrThrow​(String key)
         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.v2.CatalogAttribute> catalog_attributes = 2;
        Specified by:
        getCatalogAttributesOrThrow in interface AttributesConfigOrBuilder

      • getAttributeConfigLevelValue

        public int getAttributeConfigLevelValue()
         Output only. The
 [AttributeConfigLevel][google.cloud.retail.v2.AttributeConfigLevel] used
 for this catalog.
        .google.cloud.retail.v2.AttributeConfigLevel attribute_config_level = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAttributeConfigLevelValue in interface AttributesConfigOrBuilder
        Returns:
        The enum numeric value on the wire for attributeConfigLevel.

      • getAttributeConfigLevel

        public AttributeConfigLevel getAttributeConfigLevel()
         Output only. The
 [AttributeConfigLevel][google.cloud.retail.v2.AttributeConfigLevel] used
 for this catalog.
        .google.cloud.retail.v2.AttributeConfigLevel attribute_config_level = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAttributeConfigLevel in interface AttributesConfigOrBuilder
        Returns:
        The attributeConfigLevel.

      • 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 AttributesConfig parseFrom​(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<AttributesConfig> 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 AttributesConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder