# Class protos.google.api.ResourceDescriptor (6.3.3)

6.3.3 (latest) 5.5.0 5.3.0 5.2.0 5.1.0 5.0.1 4.6.3 4.5.0 4.4.0 4.3.0 4.2.0 4.1.0 3.23.1 3.22.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.1 3.15.5 3.14.1 3.13.0 Represents a ResourceDescriptor.

## Package

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

## Constructors

### (constructor)(properties)

    constructor(properties?: google.api.IResourceDescriptor);

Constructs a new ResourceDescriptor.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `properties` | `https://docs.cloud.google.com/nodejs/docs/reference/asset/latest/asset/protos.google.api.iresourcedescriptor` Properties to set |

## Properties

### history

    public history: (google.api.ResourceDescriptor.History|keyof typeof google.api.ResourceDescriptor.History);

ResourceDescriptor history.

### nameField

    public nameField: string;

ResourceDescriptor nameField.

### pattern

    public pattern: string[];

ResourceDescriptor pattern.

### plural

    public plural: string;

ResourceDescriptor plural.

### singular

    public singular: string;

ResourceDescriptor singular.

### style

    public style: google.api.ResourceDescriptor.Style[];

ResourceDescriptor style.

### type

    public type: string;

ResourceDescriptor type.

## Methods

### create(properties)

    public static create(properties?: google.api.IResourceDescriptor): google.api.ResourceDescriptor;

Creates a new ResourceDescriptor instance using the specified properties.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `properties` | `https://docs.cloud.google.com/nodejs/docs/reference/asset/latest/asset/protos.google.api.iresourcedescriptor` Properties to set |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/nodejs/docs/reference/asset/latest/asset/protos.google.api.resourcedescriptor-class` | ResourceDescriptor instance |

### decode(reader, length)

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

Decodes a ResourceDescriptor 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/asset/latest/asset/protos.google.api.resourcedescriptor-class` | ResourceDescriptor |

### decodeDelimited(reader)

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

Decodes a ResourceDescriptor 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/asset/latest/asset/protos.google.api.resourcedescriptor-class` | ResourceDescriptor |

### encode(message, writer)

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

Encodes the specified ResourceDescriptor message. Does not implicitly messages.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `message` | `https://docs.cloud.google.com/nodejs/docs/reference/asset/latest/asset/protos.google.api.iresourcedescriptor` ResourceDescriptor 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.api.IResourceDescriptor, writer?: $protobuf.Writer): $protobuf.Writer;

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `message` | `https://docs.cloud.google.com/nodejs/docs/reference/asset/latest/asset/protos.google.api.iresourcedescriptor` ResourceDescriptor 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.api.ResourceDescriptor;

Creates a ResourceDescriptor 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/asset/latest/asset/protos.google.api.resourcedescriptor-class` | ResourceDescriptor |

### getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ResourceDescriptor

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

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

### toObject(message, options)

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

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `message` | `https://docs.cloud.google.com/nodejs/docs/reference/asset/latest/asset/protos.google.api.resourcedescriptor-class` ResourceDescriptor |
| `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 ResourceDescriptor 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 |