Class protos.google.privacy.dlp.v2.ListDlpJobsRequest (5.11.0)

Represents a ListDlpJobsRequest.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

constructor(properties?: google.privacy.dlp.v2.IListDlpJobsRequest);

Constructs a new ListDlpJobsRequest.

Parameter
Name Description
properties IListDlpJobsRequest

Properties to set

Properties

filter

public filter: string;

ListDlpJobsRequest filter.

locationId

public locationId: string;

ListDlpJobsRequest locationId.

orderBy

public orderBy: string;

ListDlpJobsRequest orderBy.

pageSize

public pageSize: number;

ListDlpJobsRequest pageSize.

pageToken

public pageToken: string;

ListDlpJobsRequest pageToken.

parent

public parent: string;

ListDlpJobsRequest parent.

type

public type: (google.privacy.dlp.v2.DlpJobType|keyof typeof google.privacy.dlp.v2.DlpJobType);

ListDlpJobsRequest type.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.IListDlpJobsRequest): google.privacy.dlp.v2.ListDlpJobsRequest;

Creates a new ListDlpJobsRequest instance using the specified properties.

Parameter
Name Description
properties IListDlpJobsRequest

Properties to set

Returns
Type Description
ListDlpJobsRequest

ListDlpJobsRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.privacy.dlp.v2.ListDlpJobsRequest;

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

ListDlpJobsRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.privacy.dlp.v2.ListDlpJobsRequest;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ListDlpJobsRequest

ListDlpJobsRequest

encode(message, writer)

public static encode(message: google.privacy.dlp.v2.IListDlpJobsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ListDlpJobsRequest message. Does not implicitly messages.

Parameters
Name Description
message IListDlpJobsRequest

ListDlpJobsRequest 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.privacy.dlp.v2.IListDlpJobsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IListDlpJobsRequest

ListDlpJobsRequest 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.privacy.dlp.v2.ListDlpJobsRequest;

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

ListDlpJobsRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ListDlpJobsRequest

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message ListDlpJobsRequest

ListDlpJobsRequest

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