# Class protos.google.protobuf.FieldMask (0.8.2)

0.8.2 (latest) 0.8.1 0.7.0 0.1.1 Represents a FieldMask.

## Package

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

## Constructors

### (constructor)(properties)

    constructor(properties?: google.protobuf.IFieldMask);

Constructs a new FieldMask.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `properties` | `https://docs.cloud.google.com/nodejs/docs/reference/storage-control/latest/storage-control/protos.google.protobuf.ifieldmask` Properties to set |

## Properties

### paths

    public paths: string[];

FieldMask paths.

## Methods

### create(properties)

    public static create(properties?: google.protobuf.IFieldMask): google.protobuf.FieldMask;

Creates a new FieldMask instance using the specified properties.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `properties` | `https://docs.cloud.google.com/nodejs/docs/reference/storage-control/latest/storage-control/protos.google.protobuf.ifieldmask` Properties to set |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/nodejs/docs/reference/storage-control/latest/storage-control/protos.google.protobuf.fieldmask` | FieldMask instance |

### decode(reader, length)

    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.protobuf.FieldMask;

Decodes a FieldMask 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/storage-control/latest/storage-control/protos.google.protobuf.fieldmask` | FieldMask |

### decodeDelimited(reader)

    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.protobuf.FieldMask;

Decodes a FieldMask 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/storage-control/latest/storage-control/protos.google.protobuf.fieldmask` | FieldMask |

### encode(message, writer)

    public static encode(message: google.protobuf.IFieldMask, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified FieldMask message. Does not implicitly messages.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `message` | `https://docs.cloud.google.com/nodejs/docs/reference/storage-control/latest/storage-control/protos.google.protobuf.ifieldmask` FieldMask 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.protobuf.IFieldMask, writer?: $protobuf.Writer): $protobuf.Writer;

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `message` | `https://docs.cloud.google.com/nodejs/docs/reference/storage-control/latest/storage-control/protos.google.protobuf.ifieldmask` FieldMask 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.protobuf.FieldMask;

Creates a FieldMask 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/storage-control/latest/storage-control/protos.google.protobuf.fieldmask` | FieldMask |

### getTypeUrl(typeUrlPrefix)

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

Gets the default type url for FieldMask

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

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

### toObject(message, options)

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

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `message` | `https://docs.cloud.google.com/nodejs/docs/reference/storage-control/latest/storage-control/protos.google.protobuf.fieldmask` FieldMask |
| `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 FieldMask 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 |