Class Catalog (2.2.2)

Version 2.2.2

• 2.56.0 (latest)
• 2.55.0
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

public final class Catalog extends GeneratedMessageV3 implements CatalogOrBuilder

The catalog configuration.

Protobuf type google.cloud.retail.v2alpha.Catalog

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Catalog

Implements

CatalogOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

Field Value

Type	Description
int

MERCHANT_CENTER_LINKING_CONFIG_FIELD_NUMBER

public static final int MERCHANT_CENTER_LINKING_CONFIG_FIELD_NUMBER

Field Value

Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value

Type	Description
int

PRODUCT_LEVEL_CONFIG_FIELD_NUMBER

public static final int PRODUCT_LEVEL_CONFIG_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static Catalog getDefaultInstance()

Returns

Type	Description
Catalog

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static Catalog.Builder newBuilder()

Returns

Type	Description
Catalog.Builder

newBuilder(Catalog prototype)

public static Catalog.Builder newBuilder(Catalog prototype)

Parameter

Name	Description
prototype	Catalog

Returns

Type	Description
Catalog.Builder

parseDelimitedFrom(InputStream input)

public static Catalog parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Catalog

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Catalog parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Catalog

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static Catalog parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
Catalog

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Catalog parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Catalog

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Catalog parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
Catalog

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Catalog parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Catalog

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Catalog parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
Catalog

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Catalog parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Catalog

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static Catalog parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Catalog

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Catalog parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Catalog

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static Catalog parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
Catalog

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Catalog parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Catalog

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Catalog> parser()

Returns

Type	Description
Parser<Catalog>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public Catalog getDefaultInstanceForType()

Returns

Type	Description
Catalog

getDisplayName()

public String getDisplayName()

Required. Immutable. The catalog display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. Immutable. The catalog display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
ByteString	The bytes for displayName.

getMerchantCenterLinkingConfig()

public MerchantCenterLinkingConfig getMerchantCenterLinkingConfig()

The Merchant Center linking configuration. Once a link is added, the data stream from Merchant Center to Cloud Retail will be enabled automatically. The requester must have access to the merchant center account in order to make changes to this field.

.google.cloud.retail.v2alpha.MerchantCenterLinkingConfig merchant_center_linking_config = 6;

Returns

Type	Description
MerchantCenterLinkingConfig	The merchantCenterLinkingConfig.

getMerchantCenterLinkingConfigOrBuilder()

public MerchantCenterLinkingConfigOrBuilder getMerchantCenterLinkingConfigOrBuilder()

The Merchant Center linking configuration. Once a link is added, the data stream from Merchant Center to Cloud Retail will be enabled automatically. The requester must have access to the merchant center account in order to make changes to this field.

.google.cloud.retail.v2alpha.MerchantCenterLinkingConfig merchant_center_linking_config = 6;

Returns

Type	Description
MerchantCenterLinkingConfigOrBuilder

getName()

public String getName()

Required. Immutable. The fully qualified resource name of the catalog.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Required. Immutable. The fully qualified resource name of the catalog.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
ByteString	The bytes for name.

getParserForType()

public Parser<Catalog> getParserForType()

Returns

Type	Description
Parser<Catalog>

Overrides

GeneratedMessageV3.getParserForType()

getProductLevelConfig()

public ProductLevelConfig getProductLevelConfig()

Required. The product level configuration.

.google.cloud.retail.v2alpha.ProductLevelConfig product_level_config = 4 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ProductLevelConfig	The productLevelConfig.

getProductLevelConfigOrBuilder()

public ProductLevelConfigOrBuilder getProductLevelConfigOrBuilder()

Required. The product level configuration.

.google.cloud.retail.v2alpha.ProductLevelConfig product_level_config = 4 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ProductLevelConfigOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

hasMerchantCenterLinkingConfig()

public boolean hasMerchantCenterLinkingConfig()

The Merchant Center linking configuration. Once a link is added, the data stream from Merchant Center to Cloud Retail will be enabled automatically. The requester must have access to the merchant center account in order to make changes to this field.

.google.cloud.retail.v2alpha.MerchantCenterLinkingConfig merchant_center_linking_config = 6;

Returns

Type	Description
boolean	Whether the merchantCenterLinkingConfig field is set.

hasProductLevelConfig()

public boolean hasProductLevelConfig()

Required. The product level configuration.

.google.cloud.retail.v2alpha.ProductLevelConfig product_level_config = 4 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
boolean	Whether the productLevelConfig field is set.

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Catalog.Builder newBuilderForType()

Returns

Type	Description
Catalog.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Catalog.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
Catalog.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Catalog.Builder toBuilder()

Returns

Type	Description
Catalog.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException