Class protos.google.cloud.retail.v2beta.CatalogAttribute (2.0.0)

Represents a CatalogAttribute.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.retail.v2beta.ICatalogAttribute);

Constructs a new CatalogAttribute.

Parameter

Name	Description
properties	`ICatalogAttribute` Properties to set

Properties

dynamicFacetableOption

public dynamicFacetableOption: (google.cloud.retail.v2beta.CatalogAttribute.DynamicFacetableOption|keyof typeof google.cloud.retail.v2beta.CatalogAttribute.DynamicFacetableOption);

CatalogAttribute dynamicFacetableOption.

indexableOption

public indexableOption: (google.cloud.retail.v2beta.CatalogAttribute.IndexableOption|keyof typeof google.cloud.retail.v2beta.CatalogAttribute.IndexableOption);

CatalogAttribute indexableOption.

inUse

public inUse: boolean;

CatalogAttribute inUse.

key

public key: string;

CatalogAttribute key.

searchableOption

public searchableOption: (google.cloud.retail.v2beta.CatalogAttribute.SearchableOption|keyof typeof google.cloud.retail.v2beta.CatalogAttribute.SearchableOption);

CatalogAttribute searchableOption.

type

public type: (google.cloud.retail.v2beta.CatalogAttribute.AttributeType|keyof typeof google.cloud.retail.v2beta.CatalogAttribute.AttributeType);

CatalogAttribute type.

Methods

create(properties)

public static create(properties?: google.cloud.retail.v2beta.ICatalogAttribute): google.cloud.retail.v2beta.CatalogAttribute;

Creates a new CatalogAttribute instance using the specified properties.

Parameter

Name	Description
properties	`ICatalogAttribute` Properties to set

Returns

Type	Description
google.cloud.retail.v2beta.CatalogAttribute	CatalogAttribute instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.retail.v2beta.CatalogAttribute;

Decodes a CatalogAttribute message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.retail.v2beta.CatalogAttribute	CatalogAttribute

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.retail.v2beta.CatalogAttribute;

Decodes a CatalogAttribute message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.retail.v2beta.CatalogAttribute	CatalogAttribute

encode(message, writer)

public static encode(message: google.cloud.retail.v2beta.ICatalogAttribute, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CatalogAttribute message. Does not implicitly messages.

Parameters

Name	Description
message	`ICatalogAttribute` CatalogAttribute message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.retail.v2beta.ICatalogAttribute, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CatalogAttribute message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	`ICatalogAttribute` CatalogAttribute message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.retail.v2beta.CatalogAttribute;

Creates a CatalogAttribute message from a plain object. Also converts values to their respective internal types.

Parameter

Name	Description
object	`{ [k: string]: any }` Plain object

Returns

Type	Description
google.cloud.retail.v2beta.CatalogAttribute	CatalogAttribute

toJSON()

public toJSON(): { [k: string]: any };

Converts this CatalogAttribute to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.retail.v2beta.CatalogAttribute, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a CatalogAttribute message. Also converts values to other types if specified.

Parameters

Name	Description
message	`google.cloud.retail.v2beta.CatalogAttribute` CatalogAttribute
options	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a CatalogAttribute message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not