- [Resource: MetadataImport](https://docs.cloud.google.com/dataproc-metastore/docs/reference/rest/v1/projects.locations.services.metadataImports#MetadataImport)
  - [JSON representation](https://docs.cloud.google.com/dataproc-metastore/docs/reference/rest/v1/projects.locations.services.metadataImports#MetadataImport.SCHEMA_REPRESENTATION)
- [DatabaseDump](https://docs.cloud.google.com/dataproc-metastore/docs/reference/rest/v1/projects.locations.services.metadataImports#DatabaseDump)
  - [JSON representation](https://docs.cloud.google.com/dataproc-metastore/docs/reference/rest/v1/projects.locations.services.metadataImports#DatabaseDump.SCHEMA_REPRESENTATION)
- [DatabaseType](https://docs.cloud.google.com/dataproc-metastore/docs/reference/rest/v1/projects.locations.services.metadataImports#DatabaseType)
- [State](https://docs.cloud.google.com/dataproc-metastore/docs/reference/rest/v1/projects.locations.services.metadataImports#State)
- [Methods](https://docs.cloud.google.com/dataproc-metastore/docs/reference/rest/v1/projects.locations.services.metadataImports#METHODS_SUMMARY)

## Resource: MetadataImport

A metastore resource that imports metadata.

| JSON representation |
|---|
| ``` { "name": string, "description": string, "createTime": string, "updateTime": string, "endTime": string, "state": enum (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rest/v1/projects.locations.services.metadataImports#State`), // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "databaseDump": { object (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rest/v1/projects.locations.services.metadataImports#DatabaseDump`) } // End of mutually exclusive fields. } ``` |

| Fields ||
|---|---|
| `name` | `string` Immutable. Identifier. The relative resource name of the metadata import, of the form: `projects/{projectNumber}/locations/{locationId}/services/{serviceId}/metadataImports/{metadataImportId}`. |
| `description` | `string` Optional. The description of the metadata import. |
| `createTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The time when the metadata import was started. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `updateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The time when the metadata import was last updated. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `endTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The time when the metadata import finished. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `state` | ``enum (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rest/v1/projects.locations.services.metadataImports#State`)`` Output only. The current state of the metadata import. |
| The metadata to be imported. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: ||
| `databaseDump` | ``object (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rest/v1/projects.locations.services.metadataImports#DatabaseDump`)`` Immutable. A database dump from a pre-existing metastore's database. |
| End of mutually exclusive fields. ||

## DatabaseDump

A specification of the location of and metadata about a database dump from a relational database management system.

| JSON representation |
|---|
| ``` { "databaseType": enum (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rest/v1/projects.locations.services.metadataImports#DatabaseType`), "gcsUri": string, "sourceDatabase": string, "type": enum (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rest/v1/Type`) } ``` |

| Fields ||
|---|---|
| `databaseType (deprecated)` | ``enum (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rest/v1/projects.locations.services.metadataImports#DatabaseType`)`` > [!WARNING] > This item is deprecated! The type of the database. |
| `gcsUri` | `string` Optional. A Cloud Storage object or folder URI that specifies the source from which to import metadata. It must begin with `gs://`. |
| `sourceDatabase (deprecated)` | `string` > [!WARNING] > This item is deprecated! Optional. The name of the source database. |
| `type` | ``enum (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rest/v1/Type`)`` Optional. The type of the database dump. If unspecified, defaults to `MYSQL`. |

## DatabaseType

The type of the database.

| Enums ||
|---|---|
| `DATABASE_TYPE_UNSPECIFIED` | The type of the source database is unknown. |
| `MYSQL` | The type of the source database is MySQL. |

## State

The current state of the metadata import.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The state of the metadata import is unknown. |
| `RUNNING` | The metadata import is running. |
| `SUCCEEDED` | The metadata import completed successfully. |
| `UPDATING` | The metadata import is being updated. |
| `FAILED` | The metadata import failed, and attempted metadata changes were rolled back. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rest/v1/projects.locations.services.metadataImports/create` | Creates a new MetadataImport in a given project and location. |
| ### `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rest/v1/projects.locations.services.metadataImports/get` | Gets details of a single import. |
| ### `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rest/v1/projects.locations.services.metadataImports/list` | Lists imports in a service. |
| ### `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rest/v1/projects.locations.services.metadataImports/patch` | Updates a single import. |