OpenMetadata/docs/openmetadata-apis/schemas/entities/storageservice.md

Storage Service

This schema defines the Storage Service entity, such as S3, GCS, HDFS.

$id:https://open-metadata.org/schema/entity/services/storageService.json

Type: object

This schema does not accept additional properties.

Properties

• id required
  • Unique identifier of this storage service instance.
  • $ref: ../../type/basic.json#/definitions/uuid
• name required
  • Name that identifies this storage service.
  • Type: string
  • The value must match this pattern: ^[^.]*$
  • Length: between 1 and 128
• displayName
  • Display Name that identifies this storage service.
  • Type: string
• serviceType required
  • Type of storage service such as S3, GCS, HDFS...
  • $ref: ../../type/storage.json#/definitions/storageServiceType
• description
  • Description of a storage service instance.
  • Type: string
• version
  • Metadata version of the entity.
  • $ref: ../../type/entityHistory.json#/definitions/entityVersion
• updatedAt
  • Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.
  • $ref: ../../type/basic.json#/definitions/timestamp
• updatedBy
  • User who made the update.
  • Type: string
• href required
  • Link to the resource corresponding to this storage service.
  • $ref: ../../type/basic.json#/definitions/href
• owner
  • Owner of this storage service.
  • $ref: ../../type/entityReference.json
• changeDescription
  • Change that lead to this version of the entity.
  • $ref: ../../type/entityHistory.json#/definitions/changeDescription
• deleted
  • When true indicates the entity has been soft deleted.
  • Type: boolean
  • Default: false

This document was updated on: Wednesday, March 9, 2022