Class protos.google.cloud.retail.v2.ImportProductsRequest (1.3.0)

Represents an ImportProductsRequest.

Package

@google-cloud/retail

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.retail.v2.IImportProductsRequest);

Constructs a new ImportProductsRequest.

Parameter
NameDescription
properties google.cloud.retail.v2.IImportProductsRequest

Properties to set

Properties

errorsConfig

public errorsConfig?: (google.cloud.retail.v2.IImportErrorsConfig|null);

ImportProductsRequest errorsConfig.

Property Value
TypeDescription
(google.cloud.retail.v2.IImportErrorsConfig|null)

inputConfig

public inputConfig?: (google.cloud.retail.v2.IProductInputConfig|null);

ImportProductsRequest inputConfig.

Property Value
TypeDescription
(google.cloud.retail.v2.IProductInputConfig|null)

notificationPubsubTopic

public notificationPubsubTopic: string;

ImportProductsRequest notificationPubsubTopic.

Property Value
TypeDescription
string

parent

public parent: string;

ImportProductsRequest parent.

Property Value
TypeDescription
string

reconciliationMode

public reconciliationMode: (google.cloud.retail.v2.ImportProductsRequest.ReconciliationMode|keyof typeof google.cloud.retail.v2.ImportProductsRequest.ReconciliationMode);

ImportProductsRequest reconciliationMode.

Property Value
TypeDescription
(google.cloud.retail.v2.ImportProductsRequest.ReconciliationMode|keyof typeof google.cloud.retail.v2.ImportProductsRequest.ReconciliationMode)

requestId

public requestId: string;

ImportProductsRequest requestId.

Property Value
TypeDescription
string

updateMask

public updateMask?: (google.protobuf.IFieldMask|null);

ImportProductsRequest updateMask.

Property Value
TypeDescription
(google.protobuf.IFieldMask|null)

Methods

create(properties)

public static create(properties?: google.cloud.retail.v2.IImportProductsRequest): google.cloud.retail.v2.ImportProductsRequest;

Creates a new ImportProductsRequest instance using the specified properties.

Parameter
NameDescription
properties google.cloud.retail.v2.IImportProductsRequest

Properties to set

Returns
TypeDescription
google.cloud.retail.v2.ImportProductsRequest

ImportProductsRequest instance

decode(reader, length)

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

Decodes an ImportProductsRequest message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.retail.v2.ImportProductsRequest

ImportProductsRequest

decodeDelimited(reader)

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

Decodes an ImportProductsRequest message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.retail.v2.ImportProductsRequest

ImportProductsRequest

encode(message, writer)

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

Encodes the specified ImportProductsRequest message. Does not implicitly messages.

Parameters
NameDescription
message google.cloud.retail.v2.IImportProductsRequest

ImportProductsRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message google.cloud.retail.v2.IImportProductsRequest

ImportProductsRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.retail.v2.ImportProductsRequest

ImportProductsRequest

toJSON()

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

Converts this ImportProductsRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.retail.v2.ImportProductsRequest

ImportProductsRequest

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an ImportProductsRequest message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not