Package org.odpi.openmetadata.commonservices.ffdc.rest

Class DataFileRequestBody

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.SupplementaryProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.assets.AssetProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.assets.DataAssetProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.assets.DataStoreProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.assets.filesandfolders.DataFileProperties
org.odpi.openmetadata.commonservices.ffdc.rest.DataFileRequestBody
public class DataFileRequestBody extends org.odpi.openmetadata.frameworks.openmetadata.properties.assets.filesandfolders.DataFileProperties
DataFileRequestBody carries the parameters for creating a new file asset.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DataFileRequestBody()
    Default constructor
    DataFileRequestBody(DataFileRequestBody template)
    Copy/clone constructor
    DataFileRequestBody(org.odpi.openmetadata.frameworks.openmetadata.properties.assets.filesandfolders.DataFileProperties template)
    Copy/clone constructor for main properties

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Return comparison result based on the content of the properties.
    String
    getConnectorProviderClassName()
    Return the fully qualified class name of the connector provider for this type of file.
    String
    getExternalSourceGUID()
    Return the unique identifier of the software server capability entity that represented the external source - null for local.
    String
    getExternalSourceName()
    Return the unique name of the software server capability entity that represented the external source.
    int
    hashCode()
    Return hash code for this object
    void
    setConnectorProviderClassName(String connectorProviderClassName)
    Set up the fully qualified class name of the connector provider for this type of file.
    void
    setExternalSourceGUID(String externalSourceGUID)
    Set up the unique identifier of the software server capability entity that represented the external source - null for local.
    void
    setExternalSourceName(String externalSourceName)
    Set up the unique name of the software server capability entity that represented the external source.
    String
    toString()
    JSON-style toString

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.assets.filesandfolders.DataFileProperties

    getFileExtension, getFileName, getFileType, setFileExtension, setFileName, setFileType

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.assets.DataStoreProperties

    getCreateTime, getDeployedImplementationType, getEncodingDescription, getEncodingLanguage, getEncodingProperties, getEncodingType, getModifiedTime, getPathName, setCreateTime, setDeployedImplementationType, setEncodingDescription, setEncodingLanguage, setEncodingProperties, setEncodingType, setModifiedTime, setPathName

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.assets.DataAssetProperties

    cloneToAsset

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.assets.AssetProperties

    cloneToAsset, getDisplayDescription, getDisplayName, getName, getResourceDescription, getResourceName, getVersionIdentifier, setName, setResourceDescription, setResourceName, setVersionIdentifier

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.SupplementaryProperties

    getAbbreviation, getDisplaySummary, getUsage, setAbbreviation, setDisplayDescription, setDisplayName, setDisplaySummary, setUsage

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties

    getAdditionalProperties, getQualifiedName, getVendorProperties, setAdditionalProperties, setQualifiedName, setVendorProperties

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties

    getEffectiveFrom, getEffectiveTo, getExtendedProperties, getTypeName, setEffectiveFrom, setEffectiveTo, setExtendedProperties, setTypeName

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • DataFileRequestBody

      public DataFileRequestBody()
      Default constructor

    • DataFileRequestBody

      public DataFileRequestBody(DataFileRequestBody template)
      Copy/clone constructor
      Parameters:
      template - object to copy

    • DataFileRequestBody

      public DataFileRequestBody(org.odpi.openmetadata.frameworks.openmetadata.properties.assets.filesandfolders.DataFileProperties template)
      Copy/clone constructor for main properties
      Parameters:
      template - object to copy

  • Method Details

    • getExternalSourceGUID

      public String getExternalSourceGUID()
      Return the unique identifier of the software server capability entity that represented the external source - null for local.
      Returns:
      string guid

    • setExternalSourceGUID

      public void setExternalSourceGUID(String externalSourceGUID)
      Set up the unique identifier of the software server capability entity that represented the external source - null for local.
      Parameters:
      externalSourceGUID - string guid

    • getExternalSourceName

      public String getExternalSourceName()
      Return the unique name of the software server capability entity that represented the external source.
      Returns:
      string name

    • setExternalSourceName

      public void setExternalSourceName(String externalSourceName)
      Set up the unique name of the software server capability entity that represented the external source.
      Parameters:
      externalSourceName - string name

    • getConnectorProviderClassName

      public String getConnectorProviderClassName()
      Return the fully qualified class name of the connector provider for this type of file. If null is passed, the server uses the default file connector.
      Returns:
      string name

    • setConnectorProviderClassName

      public void setConnectorProviderClassName(String connectorProviderClassName)
      Set up the fully qualified class name of the connector provider for this type of file. If null is passed, the server uses the default file connector.
      Parameters:
      connectorProviderClassName - string name

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class org.odpi.openmetadata.frameworks.openmetadata.properties.assets.filesandfolders.DataFileProperties
      Returns:
      return string containing the property names and values

    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class org.odpi.openmetadata.frameworks.openmetadata.properties.assets.filesandfolders.DataFileProperties
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class org.odpi.openmetadata.frameworks.openmetadata.properties.assets.filesandfolders.DataFileProperties
      Returns:
      int hash code