Class protos.google.cloud.compute.v1beta.SecurityPolicy (6.9.0)

Represents a SecurityPolicy.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1beta.ISecurityPolicy);

Constructs a new SecurityPolicy.

Parameter
Name Description
properties ISecurityPolicy

Properties to set

Properties

adaptiveProtectionConfig

public adaptiveProtectionConfig?: (google.cloud.compute.v1beta.ISecurityPolicyAdaptiveProtectionConfig|null);

SecurityPolicy adaptiveProtectionConfig.

advancedOptionsConfig

public advancedOptionsConfig?: (google.cloud.compute.v1beta.ISecurityPolicyAdvancedOptionsConfig|null);

SecurityPolicy advancedOptionsConfig.

associations

public associations: google.cloud.compute.v1beta.ISecurityPolicyAssociation[];

SecurityPolicy associations.

creationTimestamp

public creationTimestamp?: (string|null);

SecurityPolicy creationTimestamp.

ddosProtectionConfig

public ddosProtectionConfig?: (google.cloud.compute.v1beta.ISecurityPolicyDdosProtectionConfig|null);

SecurityPolicy ddosProtectionConfig.

description

public description?: (string|null);

SecurityPolicy description.

displayName

public displayName?: (string|null);

SecurityPolicy displayName.

fingerprint

public fingerprint?: (string|null);

SecurityPolicy fingerprint.

id

public id?: (number|Long|string|null);

SecurityPolicy id.

kind

public kind?: (string|null);

SecurityPolicy kind.

labelFingerprint

public labelFingerprint?: (string|null);

SecurityPolicy labelFingerprint.

labels

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

SecurityPolicy labels.

name

public name?: (string|null);

SecurityPolicy name.

parent

public parent?: (string|null);

SecurityPolicy parent.

recaptchaOptionsConfig

public recaptchaOptionsConfig?: (google.cloud.compute.v1beta.ISecurityPolicyRecaptchaOptionsConfig|null);

SecurityPolicy recaptchaOptionsConfig.

region

public region?: (string|null);

SecurityPolicy region.

rules

public rules: google.cloud.compute.v1beta.ISecurityPolicyRule[];

SecurityPolicy rules.

ruleTupleCount

public ruleTupleCount?: (number|null);

SecurityPolicy ruleTupleCount.

public selfLink?: (string|null);

SecurityPolicy selfLink.

selfLinkWithId

public selfLinkWithId?: (string|null);

SecurityPolicy selfLinkWithId.

shortName

public shortName?: (string|null);

SecurityPolicy shortName.

type

public type?: (string|null);

SecurityPolicy type.

userDefinedFields

public userDefinedFields: google.cloud.compute.v1beta.ISecurityPolicyUserDefinedField[];

SecurityPolicy userDefinedFields.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1beta.ISecurityPolicy): google.cloud.compute.v1beta.SecurityPolicy;

Creates a new SecurityPolicy instance using the specified properties.

Parameter
Name Description
properties ISecurityPolicy

Properties to set

Returns
Type Description
SecurityPolicy

SecurityPolicy instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1beta.SecurityPolicy;

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

SecurityPolicy

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1beta.SecurityPolicy;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
SecurityPolicy

SecurityPolicy

encode(message, writer)

public static encode(message: google.cloud.compute.v1beta.ISecurityPolicy, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SecurityPolicy message. Does not implicitly messages.

Parameters
Name Description
message ISecurityPolicy

SecurityPolicy 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.compute.v1beta.ISecurityPolicy, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ISecurityPolicy

SecurityPolicy 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.compute.v1beta.SecurityPolicy;

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

SecurityPolicy

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SecurityPolicy

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message SecurityPolicy

SecurityPolicy

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