Class protos.google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest (1.9.0)

Represents a PurgeDocumentsRequest.

Package

@google-cloud/discoveryengine

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.discoveryengine.v1alpha.IPurgeDocumentsRequest);

Constructs a new PurgeDocumentsRequest.

Parameter
Name Description
properties IPurgeDocumentsRequest

Properties to set

Properties

errorConfig

public errorConfig?: (google.cloud.discoveryengine.v1alpha.IPurgeErrorConfig|null);

PurgeDocumentsRequest errorConfig.

filter

public filter: string;

PurgeDocumentsRequest filter.

force

public force: boolean;

PurgeDocumentsRequest force.

gcsSource

public gcsSource?: (google.cloud.discoveryengine.v1alpha.IGcsSource|null);

PurgeDocumentsRequest gcsSource.

parent

public parent: string;

PurgeDocumentsRequest parent.

source

public source?: "gcsSource";

PurgeDocumentsRequest source.

Methods

create(properties)

public static create(properties?: google.cloud.discoveryengine.v1alpha.IPurgeDocumentsRequest): google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest;

Creates a new PurgeDocumentsRequest instance using the specified properties.

Parameter
Name Description
properties IPurgeDocumentsRequest

Properties to set

Returns
Type Description
PurgeDocumentsRequest

PurgeDocumentsRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest;

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

PurgeDocumentsRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
PurgeDocumentsRequest

PurgeDocumentsRequest

encode(message, writer)

public static encode(message: google.cloud.discoveryengine.v1alpha.IPurgeDocumentsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified PurgeDocumentsRequest message. Does not implicitly messages.

Parameters
Name Description
message IPurgeDocumentsRequest

PurgeDocumentsRequest 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.discoveryengine.v1alpha.IPurgeDocumentsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IPurgeDocumentsRequest

PurgeDocumentsRequest 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.discoveryengine.v1alpha.PurgeDocumentsRequest;

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

PurgeDocumentsRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for PurgeDocumentsRequest

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message PurgeDocumentsRequest

PurgeDocumentsRequest

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