# Class protos.google.cloud.securesourcemanager.v1.Hook (0.10.0)

0.10.0 (latest) 0.1.0 Represents a Hook.

## Package

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

## Constructors

### (constructor)(properties)

    constructor(properties?: google.cloud.securesourcemanager.v1.IHook);

Constructs a new Hook.

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

## Properties

### createTime

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

Hook createTime.

### disabled

    public disabled: boolean;

Hook disabled.

### events

    public events: google.cloud.securesourcemanager.v1.Hook.HookEventType[];

Hook events.

### name

    public name: string;

Hook name.

### pushOption

    public pushOption?: (google.cloud.securesourcemanager.v1.Hook.IPushOption|null);

Hook pushOption.

### sensitiveQueryString

    public sensitiveQueryString: string;

Hook sensitiveQueryString.

### targetUri

    public targetUri: string;

Hook targetUri.

### uid

    public uid: string;

Hook uid.

### updateTime

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

Hook updateTime.

## Methods

### create(properties)

    public static create(properties?: google.cloud.securesourcemanager.v1.IHook): google.cloud.securesourcemanager.v1.Hook;

Creates a new Hook instance using the specified properties.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/nodejs/docs/reference/securesourcemanager/latest/securesourcemanager/protos.google.cloud.securesourcemanager.v1.hook-class` | Hook instance |

### decode(reader, length)

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

Decodes a Hook 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/securesourcemanager/latest/securesourcemanager/protos.google.cloud.securesourcemanager.v1.hook-class` | Hook |

### decodeDelimited(reader)

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

Decodes a Hook 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/securesourcemanager/latest/securesourcemanager/protos.google.cloud.securesourcemanager.v1.hook-class` | Hook |

### encode(message, writer)

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

Encodes the specified Hook message. Does not implicitly messages.

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

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

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

Creates a Hook 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/securesourcemanager/latest/securesourcemanager/protos.google.cloud.securesourcemanager.v1.hook-class` | Hook |

### getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Hook

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

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

### toObject(message, options)

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

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `message` | `https://docs.cloud.google.com/nodejs/docs/reference/securesourcemanager/latest/securesourcemanager/protos.google.cloud.securesourcemanager.v1.hook-class` Hook |
| `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 Hook 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 |