Class protos.google.cloud.retail.v2alpha.ImportProductsRequest (1.2.2)

Represents an ImportProductsRequest.

Package

@google-cloud/retail!

Constructors

(constructor)(properties)

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

Constructs a new ImportProductsRequest.

Parameter

Name	Description
properties	`google.cloud.retail.v2alpha.IImportProductsRequest` Properties to set

Properties

errorsConfig

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

ImportProductsRequest errorsConfig.

Property Value

Type	Description
(google.cloud.retail.v2alpha.IImportErrorsConfig\|null)

inputConfig

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

ImportProductsRequest inputConfig.

Property Value

Type	Description
(google.cloud.retail.v2alpha.IProductInputConfig\|null)

notificationPubsubTopic

public notificationPubsubTopic: string;

ImportProductsRequest notificationPubsubTopic.

Property Value

Type	Description
string

parent

public parent: string;

ImportProductsRequest parent.

Property Value

Type	Description
string

reconciliationMode

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

ImportProductsRequest reconciliationMode.

Property Value

Type	Description
(google.cloud.retail.v2alpha.ImportProductsRequest.ReconciliationMode\|keyof typeof google.cloud.retail.v2alpha.ImportProductsRequest.ReconciliationMode)

requestId

public requestId: string;

ImportProductsRequest requestId.

Property Value

Type	Description
string

updateMask

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

ImportProductsRequest updateMask.

Property Value

Type	Description
(google.protobuf.IFieldMask\|null)

Methods

create(properties)

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

Creates a new ImportProductsRequest instance using the specified properties.

Parameter

Name	Description
properties	`google.cloud.retail.v2alpha.IImportProductsRequest` Properties to set

Returns

Type	Description
google.cloud.retail.v2alpha.ImportProductsRequest	ImportProductsRequest instance

decode(reader, length)

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

Decodes an ImportProductsRequest 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.v2alpha.ImportProductsRequest	ImportProductsRequest

decodeDelimited(reader)

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

Decodes an ImportProductsRequest 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.v2alpha.ImportProductsRequest	ImportProductsRequest

encode(message, writer)

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

Encodes the specified ImportProductsRequest message. Does not implicitly messages.

Parameters

Name	Description
message	`google.cloud.retail.v2alpha.IImportProductsRequest` ImportProductsRequest 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.IImportProductsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`google.cloud.retail.v2alpha.IImportProductsRequest` ImportProductsRequest 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.ImportProductsRequest;

Creates an ImportProductsRequest 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.v2alpha.ImportProductsRequest	ImportProductsRequest

toJSON()

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

Converts this ImportProductsRequest to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.retail.v2alpha.ImportProductsRequest` ImportProductsRequest
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 an ImportProductsRequest 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