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

Represents a StorageConfig.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

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

Constructs a new StorageConfig.

Parameter
Name Description
properties IStorageConfig

Properties to set

Properties

bigQueryOptions

public bigQueryOptions?: (google.privacy.dlp.v2.IBigQueryOptions|null);

StorageConfig bigQueryOptions.

cloudStorageOptions

public cloudStorageOptions?: (google.privacy.dlp.v2.ICloudStorageOptions|null);

StorageConfig cloudStorageOptions.

datastoreOptions

public datastoreOptions?: (google.privacy.dlp.v2.IDatastoreOptions|null);

StorageConfig datastoreOptions.

hybridOptions

public hybridOptions?: (google.privacy.dlp.v2.IHybridOptions|null);

StorageConfig hybridOptions.

timespanConfig

public timespanConfig?: (google.privacy.dlp.v2.StorageConfig.ITimespanConfig|null);

StorageConfig timespanConfig.

type

public type?: ("datastoreOptions"|"cloudStorageOptions"|"bigQueryOptions"|"hybridOptions");

StorageConfig type.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.IStorageConfig): google.privacy.dlp.v2.StorageConfig;

Creates a new StorageConfig instance using the specified properties.

Parameter
Name Description
properties IStorageConfig

Properties to set

Returns
Type Description
StorageConfig

StorageConfig instance

decode(reader, length)

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

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

StorageConfig

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
StorageConfig

StorageConfig

encode(message, writer)

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

Encodes the specified StorageConfig message. Does not implicitly messages.

Parameters
Name Description
message IStorageConfig

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

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

Parameters
Name Description
message IStorageConfig

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

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

StorageConfig

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for StorageConfig

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message StorageConfig

StorageConfig

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