0.4.1 (latest) 0.4.0 0.3.0 0.1.0 Represents an EdgeRule.

## Implements

[protos.google.cloud.apptopology.v1.IEdgeRule](https://docs.cloud.google.com/nodejs/docs/reference/apptopology/latest/apptopology/protos.google.cloud.apptopology.v1.iedgerule)

## Package

[@google-cloud/apptopology](https://docs.cloud.google.com/nodejs/docs/reference/apptopology/latest/overview.html)

## Constructors

### (constructor)(properties)

    constructor(properties?: google.cloud.apptopology.v1.IEdgeRule);

Constructs a new EdgeRule.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `properties` | `https://docs.cloud.google.com/nodejs/docs/reference/apptopology/latest/apptopology/protos.google.cloud.apptopology.v1.iedgerule` Properties to set |

## Properties

### destinationNode

    public destinationNode?: ("destNodeType"|"destNodeGroup");

EdgeRule destinationNode.

### destNodeGroup

    public destNodeGroup?: (google.cloud.apptopology.v1.INodeGroup|null);

EdgeRule destNodeGroup.

### destNodeType

    public destNodeType?: (string|null);

EdgeRule destNodeType.

### edgeType

    public edgeType: string;

EdgeRule edgeType.

### sourceNode

    public sourceNode?: ("srcNodeType"|"srcNodeGroup");

EdgeRule sourceNode.

### srcNodeGroup

    public srcNodeGroup?: (google.cloud.apptopology.v1.INodeGroup|null);

EdgeRule srcNodeGroup.

### srcNodeType

    public srcNodeType?: (string|null);

EdgeRule srcNodeType.

## Methods

### create(properties)

    public static create(properties?: google.cloud.apptopology.v1.IEdgeRule): google.cloud.apptopology.v1.EdgeRule;

Creates a new EdgeRule instance using the specified properties.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `properties` | `https://docs.cloud.google.com/nodejs/docs/reference/apptopology/latest/apptopology/protos.google.cloud.apptopology.v1.iedgerule` Properties to set |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/nodejs/docs/reference/apptopology/latest/apptopology/protos.google.cloud.apptopology.v1.edgerule` | EdgeRule instance |

### decode(reader, length)

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

Decodes an EdgeRule 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** |
| `https://docs.cloud.google.com/nodejs/docs/reference/apptopology/latest/apptopology/protos.google.cloud.apptopology.v1.edgerule` | EdgeRule |

### decodeDelimited(reader)

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

Decodes an EdgeRule message from the specified reader or buffer, length delimited.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `reader` | `(Reader|Uint8Array)` Reader or buffer to decode from |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/nodejs/docs/reference/apptopology/latest/apptopology/protos.google.cloud.apptopology.v1.edgerule` | EdgeRule |

### encode(message, writer)

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

Encodes the specified EdgeRule message. Does not implicitly messages.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `message` | `https://docs.cloud.google.com/nodejs/docs/reference/apptopology/latest/apptopology/protos.google.cloud.apptopology.v1.iedgerule` EdgeRule 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.apptopology.v1.IEdgeRule, writer?: $protobuf.Writer): $protobuf.Writer;

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `message` | `https://docs.cloud.google.com/nodejs/docs/reference/apptopology/latest/apptopology/protos.google.cloud.apptopology.v1.iedgerule` EdgeRule 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.apptopology.v1.EdgeRule;

Creates an EdgeRule 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** |
| `https://docs.cloud.google.com/nodejs/docs/reference/apptopology/latest/apptopology/protos.google.cloud.apptopology.v1.edgerule` | EdgeRule |

### getTypeUrl(typeUrlPrefix)

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

Gets the default type url for EdgeRule

| **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 EdgeRule to JSON.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `{ [k: string]: any }` | JSON object |

### toObject(message, options)

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

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `message` | `https://docs.cloud.google.com/nodejs/docs/reference/apptopology/latest/apptopology/protos.google.cloud.apptopology.v1.edgerule` EdgeRule |
| `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 EdgeRule 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 |