Google Cloud Retail V2 Client - Class Catalog (1.0.1)

Reference documentation and code samples for the Google Cloud Retail V2 Client class Catalog.

The catalog configuration.

Generated from protobuf message google.cloud.retail.v2.Catalog

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

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

↳ display_name string

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.

↳ product_level_config Google\Cloud\Retail\V2\ProductLevelConfig

Required. The product level configuration.

getName

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

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

Returns
TypeDescription
string

setName

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

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

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.

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

Returns
TypeDescription
string

setDisplayName

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.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getProductLevelConfig

Required. The product level configuration.

Generated from protobuf field .google.cloud.retail.v2.ProductLevelConfig product_level_config = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Google\Cloud\Retail\V2\ProductLevelConfig|null

hasProductLevelConfig

clearProductLevelConfig

setProductLevelConfig

Required. The product level configuration.

Generated from protobuf field .google.cloud.retail.v2.ProductLevelConfig product_level_config = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var Google\Cloud\Retail\V2\ProductLevelConfig
Returns
TypeDescription
$this