Class protos.google.cloud.compute.v1.SecurityPolicy (3.0.0)

Represents a SecurityPolicy.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new SecurityPolicy.

Parameter
Name Description
properties ISecurityPolicy

Properties to set

Properties

_creationTimestamp

public _creationTimestamp?: "creationTimestamp";

SecurityPolicy _creationTimestamp.

_description

public _description?: "description";

SecurityPolicy _description.

_fingerprint

public _fingerprint?: "fingerprint";

SecurityPolicy _fingerprint.

_id

public _id?: "id";

SecurityPolicy _id.

_kind

public _kind?: "kind";

SecurityPolicy _kind.

_name

public _name?: "name";

SecurityPolicy _name.

_selfLink

public _selfLink?: "selfLink";

SecurityPolicy _selfLink.

creationTimestamp

public creationTimestamp?: (string|null);

SecurityPolicy creationTimestamp.

description

public description?: (string|null);

SecurityPolicy description.

fingerprint

public fingerprint?: (string|null);

SecurityPolicy fingerprint.

id

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

SecurityPolicy id.

kind

public kind?: (string|null);

SecurityPolicy kind.

name

public name?: (string|null);

SecurityPolicy name.

rules

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

SecurityPolicy rules.

selfLink

public selfLink?: (string|null);

SecurityPolicy selfLink.

Methods

create(properties)

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

Creates a new SecurityPolicy instance using the specified properties.

Parameter
Name Description
properties ISecurityPolicy

Properties to set
Returns
Type Description
google.cloud.compute.v1.SecurityPolicy

SecurityPolicy instance

decode(reader, length)

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

Decodes a SecurityPolicy message from the specified reader or buffer.

Parameters
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
google.cloud.compute.v1.SecurityPolicy

SecurityPolicy

decodeDelimited(reader)

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

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

Parameter
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
google.cloud.compute.v1.SecurityPolicy

SecurityPolicy

encode(message, writer)

public static encode(message: google.cloud.compute.v1.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.v1.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.v1.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
google.cloud.compute.v1.SecurityPolicy

SecurityPolicy

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.v1.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 google.cloud.compute.v1.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