Class Catalog (2.31.0)

public final class Catalog extends GeneratedMessageV3 implements CatalogOrBuilder

The catalog configuration.

Protobuf type google.cloud.retail.v2beta.Catalog

Implements

CatalogOrBuilder

Static Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

MERCHANT_CENTER_LINKING_CONFIG_FIELD_NUMBER

public static final int MERCHANT_CENTER_LINKING_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PRODUCT_LEVEL_CONFIG_FIELD_NUMBER

public static final int PRODUCT_LEVEL_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Catalog getDefaultInstance()
Returns
TypeDescription
Catalog

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Catalog.Builder newBuilder()
Returns
TypeDescription
Catalog.Builder

newBuilder(Catalog prototype)

public static Catalog.Builder newBuilder(Catalog prototype)
Parameter
NameDescription
prototypeCatalog
Returns
TypeDescription
Catalog.Builder

parseDelimitedFrom(InputStream input)

public static Catalog parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Catalog
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Catalog parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Catalog
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Catalog parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Catalog
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Catalog parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Catalog
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Catalog parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Catalog
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Catalog parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Catalog
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Catalog parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Catalog
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Catalog parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Catalog
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Catalog parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Catalog
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Catalog parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Catalog
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Catalog parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Catalog
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Catalog parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Catalog
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Catalog> parser()
Returns
TypeDescription
Parser<Catalog>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Catalog getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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.v2beta.MerchantCenterLinkingConfig merchant_center_linking_config = 6;

Returns
TypeDescription
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.v2beta.MerchantCenterLinkingConfig merchant_center_linking_config = 6;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Catalog> getParserForType()
Returns
TypeDescription
Parser<Catalog>
Overrides

getProductLevelConfig()

public ProductLevelConfig getProductLevelConfig()

Required. The product level configuration.

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

Returns
TypeDescription
ProductLevelConfig

The productLevelConfig.

getProductLevelConfigOrBuilder()

public ProductLevelConfigOrBuilder getProductLevelConfigOrBuilder()

Required. The product level configuration.

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

Returns
TypeDescription
ProductLevelConfigOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.v2beta.MerchantCenterLinkingConfig merchant_center_linking_config = 6;

Returns
TypeDescription
boolean

Whether the merchantCenterLinkingConfig field is set.

hasProductLevelConfig()

public boolean hasProductLevelConfig()

Required. The product level configuration.

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

Returns
TypeDescription
boolean

Whether the productLevelConfig field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Catalog.Builder newBuilderForType()
Returns
TypeDescription
Catalog.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Catalog.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Catalog.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Catalog.Builder toBuilder()
Returns
TypeDescription
Catalog.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException