Class Catalog.Builder (2.45.0)

public static final class Catalog.Builder extends GeneratedMessageV3.Builder<Catalog.Builder> implements CatalogOrBuilder

The catalog configuration.

Protobuf type google.cloud.retail.v2alpha.Catalog

Implements

CatalogOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Catalog.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Catalog.Builder
Overrides

build()

public Catalog build()
Returns
Type Description
Catalog

buildPartial()

public Catalog buildPartial()
Returns
Type Description
Catalog

clear()

public Catalog.Builder clear()
Returns
Type Description
Catalog.Builder
Overrides

clearDisplayName()

public Catalog.Builder clearDisplayName()

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
Catalog.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Catalog.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Catalog.Builder
Overrides

clearMerchantCenterLinkingConfig()

public Catalog.Builder clearMerchantCenterLinkingConfig()

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
Catalog.Builder

clearName()

public Catalog.Builder clearName()

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
Catalog.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Catalog.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Catalog.Builder
Overrides

clearProductLevelConfig()

public Catalog.Builder clearProductLevelConfig()

Required. The product level configuration.

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

Returns
Type Description
Catalog.Builder

clone()

public Catalog.Builder clone()
Returns
Type Description
Catalog.Builder
Overrides

getDefaultInstanceForType()

public Catalog getDefaultInstanceForType()
Returns
Type Description
Catalog

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getMerchantCenterLinkingConfigBuilder()

public MerchantCenterLinkingConfig.Builder getMerchantCenterLinkingConfigBuilder()

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.Builder

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.

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.

getProductLevelConfigBuilder()

public ProductLevelConfig.Builder getProductLevelConfigBuilder()

Required. The product level configuration.

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

Returns
Type Description
ProductLevelConfig.Builder

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

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Catalog other)

public Catalog.Builder mergeFrom(Catalog other)
Parameter
Name Description
other Catalog
Returns
Type Description
Catalog.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Catalog.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Catalog.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Catalog.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Catalog.Builder
Overrides

mergeMerchantCenterLinkingConfig(MerchantCenterLinkingConfig value)

public Catalog.Builder mergeMerchantCenterLinkingConfig(MerchantCenterLinkingConfig value)

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;

Parameter
Name Description
value MerchantCenterLinkingConfig
Returns
Type Description
Catalog.Builder

mergeProductLevelConfig(ProductLevelConfig value)

public Catalog.Builder mergeProductLevelConfig(ProductLevelConfig value)

Required. The product level configuration.

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

Parameter
Name Description
value ProductLevelConfig
Returns
Type Description
Catalog.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Catalog.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Catalog.Builder
Overrides

setDisplayName(String value)

public Catalog.Builder setDisplayName(String value)

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];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Catalog.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Catalog.Builder setDisplayNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Catalog.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Catalog.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Catalog.Builder
Overrides

setMerchantCenterLinkingConfig(MerchantCenterLinkingConfig value)

public Catalog.Builder setMerchantCenterLinkingConfig(MerchantCenterLinkingConfig value)

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;

Parameter
Name Description
value MerchantCenterLinkingConfig
Returns
Type Description
Catalog.Builder

setMerchantCenterLinkingConfig(MerchantCenterLinkingConfig.Builder builderForValue)

public Catalog.Builder setMerchantCenterLinkingConfig(MerchantCenterLinkingConfig.Builder builderForValue)

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;

Parameter
Name Description
builderForValue MerchantCenterLinkingConfig.Builder
Returns
Type Description
Catalog.Builder

setName(String value)

public Catalog.Builder setName(String value)

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

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Catalog.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Catalog.Builder setNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Catalog.Builder

This builder for chaining.

setProductLevelConfig(ProductLevelConfig value)

public Catalog.Builder setProductLevelConfig(ProductLevelConfig value)

Required. The product level configuration.

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

Parameter
Name Description
value ProductLevelConfig
Returns
Type Description
Catalog.Builder

setProductLevelConfig(ProductLevelConfig.Builder builderForValue)

public Catalog.Builder setProductLevelConfig(ProductLevelConfig.Builder builderForValue)

Required. The product level configuration.

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

Parameter
Name Description
builderForValue ProductLevelConfig.Builder
Returns
Type Description
Catalog.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Catalog.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Catalog.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Catalog.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Catalog.Builder
Overrides