Class protos.google.cloud.networksecurity.v1.SecurityProfile (3.6.0)

Represents a SecurityProfile.

Implements

Package

@google-cloud/network-security

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.networksecurity.v1.ISecurityProfile);

Constructs a new SecurityProfile.

Parameter
Name Description
properties ISecurityProfile

Properties to set

Properties

createTime

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

SecurityProfile createTime.

customInterceptProfile

public customInterceptProfile?: (google.cloud.networksecurity.v1.ICustomInterceptProfile|null);

SecurityProfile customInterceptProfile.

customMirroringProfile

public customMirroringProfile?: (google.cloud.networksecurity.v1.ICustomMirroringProfile|null);

SecurityProfile customMirroringProfile.

description

public description: string;

SecurityProfile description.

etag

public etag: string;

SecurityProfile etag.

labels

public labels: { [k: string]: string };

SecurityProfile labels.

name

public name: string;

SecurityProfile name.

profile

public profile?: ("threatPreventionProfile"|"customMirroringProfile"|"customInterceptProfile"|"urlFilteringProfile");

SecurityProfile profile.

threatPreventionProfile

public threatPreventionProfile?: (google.cloud.networksecurity.v1.IThreatPreventionProfile|null);

SecurityProfile threatPreventionProfile.

type

public type: (google.cloud.networksecurity.v1.SecurityProfile.ProfileType|keyof typeof google.cloud.networksecurity.v1.SecurityProfile.ProfileType);

SecurityProfile type.

updateTime

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

SecurityProfile updateTime.

urlFilteringProfile

public urlFilteringProfile?: (google.cloud.networksecurity.v1.IUrlFilteringProfile|null);

SecurityProfile urlFilteringProfile.

Methods

create(properties)

public static create(properties?: google.cloud.networksecurity.v1.ISecurityProfile): google.cloud.networksecurity.v1.SecurityProfile;

Creates a new SecurityProfile instance using the specified properties.

Parameter
Name Description
properties ISecurityProfile

Properties to set

Returns
Type Description
SecurityProfile

SecurityProfile instance

decode(reader, length)

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

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

SecurityProfile

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
SecurityProfile

SecurityProfile

encode(message, writer)

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

Encodes the specified SecurityProfile message. Does not implicitly messages.

Parameters
Name Description
message ISecurityProfile

SecurityProfile 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.networksecurity.v1.ISecurityProfile, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ISecurityProfile

SecurityProfile 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.networksecurity.v1.SecurityProfile;

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

SecurityProfile

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SecurityProfile

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message SecurityProfile

SecurityProfile

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