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

Represents a ContentLocation.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

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

Constructs a new ContentLocation.

Parameter
Name Description
properties IContentLocation

Properties to set

Properties

containerName

public containerName: string;

ContentLocation containerName.

containerTimestamp

public containerTimestamp?: (google.protobuf.ITimestamp|null);

ContentLocation containerTimestamp.

containerVersion

public containerVersion: string;

ContentLocation containerVersion.

documentLocation

public documentLocation?: (google.privacy.dlp.v2.IDocumentLocation|null);

ContentLocation documentLocation.

imageLocation

public imageLocation?: (google.privacy.dlp.v2.IImageLocation|null);

ContentLocation imageLocation.

location

public location?: ("recordLocation"|"imageLocation"|"documentLocation"|"metadataLocation");

ContentLocation location.

metadataLocation

public metadataLocation?: (google.privacy.dlp.v2.IMetadataLocation|null);

ContentLocation metadataLocation.

recordLocation

public recordLocation?: (google.privacy.dlp.v2.IRecordLocation|null);

ContentLocation recordLocation.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.IContentLocation): google.privacy.dlp.v2.ContentLocation;

Creates a new ContentLocation instance using the specified properties.

Parameter
Name Description
properties IContentLocation

Properties to set

Returns
Type Description
ContentLocation

ContentLocation instance

decode(reader, length)

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

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

ContentLocation

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ContentLocation

ContentLocation

encode(message, writer)

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

Encodes the specified ContentLocation message. Does not implicitly messages.

Parameters
Name Description
message IContentLocation

ContentLocation 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.IContentLocation, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IContentLocation

ContentLocation 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.ContentLocation;

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

ContentLocation

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ContentLocation

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message ContentLocation

ContentLocation

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