Represents a QualityMetric.
Package
@google-cloud/retailConstructors
(constructor)(properties)
constructor(properties?: google.cloud.retail.v2alpha.Branch.IQualityMetric);
Constructs a new QualityMetric.
Parameter | |
---|---|
Name | Description |
properties |
IQualityMetric
Properties to set |
Properties
qualifiedProductCount
public qualifiedProductCount: number;
QualityMetric qualifiedProductCount.
requirementKey
public requirementKey: string;
QualityMetric requirementKey.
suggestedQualityPercentThreshold
public suggestedQualityPercentThreshold: number;
QualityMetric suggestedQualityPercentThreshold.
unqualifiedProductCount
public unqualifiedProductCount: number;
QualityMetric unqualifiedProductCount.
unqualifiedSampleProducts
public unqualifiedSampleProducts: google.cloud.retail.v2alpha.IProduct[];
QualityMetric unqualifiedSampleProducts.
Methods
create(properties)
public static create(properties?: google.cloud.retail.v2alpha.Branch.IQualityMetric): google.cloud.retail.v2alpha.Branch.QualityMetric;
Creates a new QualityMetric instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IQualityMetric
Properties to set |
Returns | |
---|---|
Type | Description |
QualityMetric |
QualityMetric instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.retail.v2alpha.Branch.QualityMetric;
Decodes a QualityMetric message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
QualityMetric |
QualityMetric |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.retail.v2alpha.Branch.QualityMetric;
Decodes a QualityMetric message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
QualityMetric |
QualityMetric |
encode(message, writer)
public static encode(message: google.cloud.retail.v2alpha.Branch.IQualityMetric, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified QualityMetric message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IQualityMetric
QualityMetric 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.v2alpha.Branch.IQualityMetric, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified QualityMetric message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IQualityMetric
QualityMetric 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.v2alpha.Branch.QualityMetric;
Creates a QualityMetric 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 |
QualityMetric |
QualityMetric |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for QualityMetric
Parameter | |
---|---|
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns | |
---|---|
Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this QualityMetric to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.retail.v2alpha.Branch.QualityMetric, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a QualityMetric message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
QualityMetric
QualityMetric |
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 QualityMetric message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|