Class protos.google.cloud.vision.v1.PurgeProductsRequest

Represents a PurgeProductsRequest.

Package

@google-cloud/vision!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.vision.v1.IPurgeProductsRequest);

Constructs a new PurgeProductsRequest.

Parameter
TypeNameDescription
google.cloud.vision.v1.IPurgeProductsRequestproperties

Properties to set

Properties

deleteOrphanProducts

public deleteOrphanProducts?: (boolean|null);

PurgeProductsRequest deleteOrphanProducts.

Property Value
TypeDescription
(boolean|null)

force

public force: boolean;

PurgeProductsRequest force.

Property Value
TypeDescription
boolean

parent

public parent: string;

PurgeProductsRequest parent.

Property Value
TypeDescription
string

productSetPurgeConfig

public productSetPurgeConfig?: (google.cloud.vision.v1.IProductSetPurgeConfig|null);

PurgeProductsRequest productSetPurgeConfig.

Property Value
TypeDescription
(google.cloud.vision.v1.IProductSetPurgeConfig|null)

target

public target?: ("productSetPurgeConfig"|"deleteOrphanProducts");

PurgeProductsRequest target.

Property Value
TypeDescription
("productSetPurgeConfig"|"deleteOrphanProducts")

Methods

create(properties)

public static create(properties?: google.cloud.vision.v1.IPurgeProductsRequest): google.cloud.vision.v1.PurgeProductsRequest;

Creates a new PurgeProductsRequest instance using the specified properties.

Parameter
TypeNameDescription
google.cloud.vision.v1.IPurgeProductsRequestproperties

Properties to set

Returns
TypeDescription
google.cloud.vision.v1.PurgeProductsRequest

PurgeProductsRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.vision.v1.PurgeProductsRequest;

Decodes a PurgeProductsRequest message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.cloud.vision.v1.PurgeProductsRequest

PurgeProductsRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.vision.v1.PurgeProductsRequest;

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

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.vision.v1.PurgeProductsRequest

PurgeProductsRequest

encode(message, writer)

public static encode(message: google.cloud.vision.v1.IPurgeProductsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified PurgeProductsRequest message. Does not implicitly messages.

Parameters
TypeNameDescription
google.cloud.vision.v1.IPurgeProductsRequestmessage

PurgeProductsRequest message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.vision.v1.IPurgeProductsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
TypeNameDescription
google.cloud.vision.v1.IPurgeProductsRequestmessage

PurgeProductsRequest message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.vision.v1.PurgeProductsRequest;

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

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

Plain object

Returns
TypeDescription
google.cloud.vision.v1.PurgeProductsRequest

PurgeProductsRequest

toJSON()

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

Converts this PurgeProductsRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
TypeNameDescription
google.cloud.vision.v1.PurgeProductsRequestmessage

PurgeProductsRequest

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a PurgeProductsRequest message.

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

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not