Class protos.google.shopping.merchant.datasources.v1beta.DataSource (0.3.0)

Represents a DataSource.

Package

@google-shopping/datasources

Constructors

(constructor)(properties)

constructor(properties?: google.shopping.merchant.datasources.v1beta.IDataSource);

Constructs a new DataSource.

Parameter
Name Description
properties IDataSource

Properties to set

Properties

dataSourceId

public dataSourceId: (number|Long|string);

DataSource dataSourceId.

displayName

public displayName: string;

DataSource displayName.

fileInput

public fileInput?: (google.shopping.merchant.datasources.v1beta.IFileInput|null);

DataSource fileInput.

input

public input: (google.shopping.merchant.datasources.v1beta.DataSource.Input|keyof typeof google.shopping.merchant.datasources.v1beta.DataSource.Input);

DataSource input.

localInventoryDataSource

public localInventoryDataSource?: (google.shopping.merchant.datasources.v1beta.ILocalInventoryDataSource|null);

DataSource localInventoryDataSource.

merchantReviewDataSource

public merchantReviewDataSource?: (google.shopping.merchant.datasources.v1beta.IMerchantReviewDataSource|null);

DataSource merchantReviewDataSource.

name

public name: string;

DataSource name.

primaryProductDataSource

public primaryProductDataSource?: (google.shopping.merchant.datasources.v1beta.IPrimaryProductDataSource|null);

DataSource primaryProductDataSource.

productReviewDataSource

public productReviewDataSource?: (google.shopping.merchant.datasources.v1beta.IProductReviewDataSource|null);

DataSource productReviewDataSource.

promotionDataSource

public promotionDataSource?: (google.shopping.merchant.datasources.v1beta.IPromotionDataSource|null);

DataSource promotionDataSource.

regionalInventoryDataSource

public regionalInventoryDataSource?: (google.shopping.merchant.datasources.v1beta.IRegionalInventoryDataSource|null);

DataSource regionalInventoryDataSource.

supplementalProductDataSource

public supplementalProductDataSource?: (google.shopping.merchant.datasources.v1beta.ISupplementalProductDataSource|null);

DataSource supplementalProductDataSource.

Type

public Type?: ("primaryProductDataSource"|"supplementalProductDataSource"|"localInventoryDataSource"|"regionalInventoryDataSource"|"promotionDataSource"|"productReviewDataSource"|"merchantReviewDataSource");

DataSource Type.

Methods

create(properties)

public static create(properties?: google.shopping.merchant.datasources.v1beta.IDataSource): google.shopping.merchant.datasources.v1beta.DataSource;

Creates a new DataSource instance using the specified properties.

Parameter
Name Description
properties IDataSource

Properties to set

Returns
Type Description
DataSource

DataSource instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.shopping.merchant.datasources.v1beta.DataSource;

Decodes a DataSource 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
DataSource

DataSource

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.shopping.merchant.datasources.v1beta.DataSource;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
DataSource

DataSource

encode(message, writer)

public static encode(message: google.shopping.merchant.datasources.v1beta.IDataSource, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified DataSource message. Does not implicitly messages.

Parameters
Name Description
message IDataSource

DataSource 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.shopping.merchant.datasources.v1beta.IDataSource, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IDataSource

DataSource 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.shopping.merchant.datasources.v1beta.DataSource;

Creates a DataSource 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
DataSource

DataSource

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for DataSource

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 DataSource to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.shopping.merchant.datasources.v1beta.DataSource, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message DataSource

DataSource

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 DataSource 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