Represents an IpRules.
Package
@google-cloud/security-centerConstructors
(constructor)(properties)
constructor(properties?: google.cloud.securitycenter.v2.IIpRules);Constructs a new IpRules.
| Parameter | |
|---|---|
| Name | Description |
properties |
IIpRules
Properties to set |
Properties
allowed
public allowed?: (google.cloud.securitycenter.v2.IAllowed|null);IpRules allowed.
denied
public denied?: (google.cloud.securitycenter.v2.IDenied|null);IpRules denied.
destinationIpRanges
public destinationIpRanges: string[];IpRules destinationIpRanges.
direction
public direction: (google.cloud.securitycenter.v2.IpRules.Direction|keyof typeof google.cloud.securitycenter.v2.IpRules.Direction);IpRules direction.
exposedServices
public exposedServices: string[];IpRules exposedServices.
rules
public rules?: ("allowed"|"denied");IpRules rules.
sourceIpRanges
public sourceIpRanges: string[];IpRules sourceIpRanges.
Methods
create(properties)
public static create(properties?: google.cloud.securitycenter.v2.IIpRules): google.cloud.securitycenter.v2.IpRules;Creates a new IpRules instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IIpRules
Properties to set |
| Returns | |
|---|---|
| Type | Description |
IpRules |
IpRules instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.securitycenter.v2.IpRules;Decodes an IpRules 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 |
IpRules |
IpRules |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.securitycenter.v2.IpRules;Decodes an IpRules message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
IpRules |
IpRules |
encode(message, writer)
public static encode(message: google.cloud.securitycenter.v2.IIpRules, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified IpRules message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IIpRules
IpRules 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.securitycenter.v2.IIpRules, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified IpRules message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IIpRules
IpRules 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.securitycenter.v2.IpRules;Creates an IpRules 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 |
IpRules |
IpRules |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for IpRules
| 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 IpRules to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.securitycenter.v2.IpRules, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an IpRules message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
IpRules
IpRules |
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 an IpRules message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|