Package org.odpi.openmetadata.frameworks.integration.bitol.odcs

Class DataContractServer

java.lang.Object
org.odpi.openmetadata.frameworks.integration.bitol.odcs.DataContractServer
public class DataContractServer extends Object
This class represents a server (infrastructure location) where the data described by an Open Data Contract Standard (ODCS) data contract resides. The "type" of server (postgresql, kafka, s3, bigquery, ...) determines which of the location properties are relevant. This bean holds the union of the location properties defined for all server types by the standard, and captures any others in additionalProperties so that nothing is lost on a round trip.

  • Constructor Details

    • DataContractServer

      public DataContractServer()
      Default constructor

  • Method Details

    • getId

      public String getId()
      Return the stable identifier of this element (alphanumeric, hyphen and underscore characters only).
      Returns:
      string identifier

    • setId

      public void setId(String id)
      Set up the stable identifier of this element (alphanumeric, hyphen and underscore characters only).
      Parameters:
      id - string identifier

    • getServer

      public String getServer()
      Return the identifier of the server.
      Returns:
      string name

    • setServer

      public void setServer(String server)
      Set up the identifier of the server.
      Parameters:
      server - string name

    • getType

      public String getType()
      Return the type of server. Standard values are defined in DataContractServerType.
      Returns:
      string type name

    • setType

      public void setType(String type)
      Set up the type of server. Standard values are defined in DataContractServerType.
      Parameters:
      type - string type name

    • getDescription

      public String getDescription()
      Return the description of the server.
      Returns:
      string description

    • setDescription

      public void setDescription(String description)
      Set up the description of the server.
      Parameters:
      description - string description

    • getEnvironment

      public String getEnvironment()
      Return the environment of the server, for example production or development.
      Returns:
      string environment name

    • setEnvironment

      public void setEnvironment(String environment)
      Set up the environment of the server, for example production or development.
      Parameters:
      environment - string environment name

    • getRoles

      public List<DataContractRole> getRoles()
      Return the list of access roles specific to this server.
      Returns:
      list of roles

    • setRoles

      public void setRoles(List<DataContractRole> roles)
      Set up the list of access roles specific to this server.
      Parameters:
      roles - list of roles

    • getAccount

      public String getAccount()
      Return the account (for example Snowflake, Redshift, Glue).
      Returns:
      string account name

    • setAccount

      public void setAccount(String account)
      Set up the account (for example Snowflake, Redshift, Glue).
      Parameters:
      account - string account name

    • getCatalog

      public String getCatalog()
      Return the catalog (for example Databricks, Trino, Presto, Athena).
      Returns:
      string catalog name

    • setCatalog

      public void setCatalog(String catalog)
      Set up the catalog (for example Databricks, Trino, Presto, Athena).
      Parameters:
      catalog - string catalog name

    • getDatabase

      public String getDatabase()
      Return the database.
      Returns:
      string database name

    • setDatabase

      public void setDatabase(String database)
      Set up the database.
      Parameters:
      database - string database name

    • getDataset

      public String getDataset()
      Return the dataset (for example BigQuery).
      Returns:
      string dataset name

    • setDataset

      public void setDataset(String dataset)
      Set up the dataset (for example BigQuery).
      Parameters:
      dataset - string dataset name

    • getSchema

      public String getSchema()
      Return the schema within the database.
      Returns:
      string schema name

    • setSchema

      public void setSchema(String schema)
      Set up the schema within the database.
      Parameters:
      schema - string schema name

    • getHost

      public String getHost()
      Return the host name (and optionally port) of the server.
      Returns:
      string host name

    • setHost

      public void setHost(String host)
      Set up the host name (and optionally port) of the server.
      Parameters:
      host - string host name

    • getPort

      public Object getPort()
      Return the port number of the server. It is normally an integer but may be a string holding a variable reference such as ${DB_PORT}.
      Returns:
      integer value or null if not specified

    • setPort

      public void setPort(Object port)
      Set up the port number of the server. It is normally an integer but may be a string holding a variable reference such as ${DB_PORT}.
      Parameters:
      port - integer value or null if not specified

    • getLocation

      public String getLocation()
      Return the location URI (for example s3://, abfss://, sftp:// or an API URL).
      Returns:
      string URI

    • setLocation

      public void setLocation(String location)
      Set up the location URI (for example s3://, abfss://, sftp:// or an API URL).
      Parameters:
      location - string URI

    • getEndpointUrl

      public String getEndpointUrl()
      Return the endpoint URL (for example an S3 compatible endpoint).
      Returns:
      string URL

    • setEndpointUrl

      public void setEndpointUrl(String endpointUrl)
      Set up the endpoint URL (for example an S3 compatible endpoint).
      Parameters:
      endpointUrl - string URL

    • getPath

      public String getPath()
      Return the file path (for local servers).
      Returns:
      string path

    • setPath

      public void setPath(String path)
      Set up the file path (for local servers).
      Parameters:
      path - string path

    • getFormat

      public String getFormat()
      Return the data format (for example parquet, json, avro, csv).
      Returns:
      string format name

    • setFormat

      public void setFormat(String format)
      Set up the data format (for example parquet, json, avro, csv).
      Parameters:
      format - string format name

    • getDelimiter

      public String getDelimiter()
      Return the delimiter for delimited formats.
      Returns:
      string delimiter

    • setDelimiter

      public void setDelimiter(String delimiter)
      Set up the delimiter for delimited formats.
      Parameters:
      delimiter - string delimiter

    • getProject

      public String getProject()
      Return the project (for example BigQuery or Pub/Sub).
      Returns:
      string project name

    • setProject

      public void setProject(String project)
      Set up the project (for example BigQuery or Pub/Sub).
      Parameters:
      project - string project name

    • getRegion

      public String getRegion()
      Return the cloud region (for example Kinesis or Redshift).
      Returns:
      string region name

    • setRegion

      public void setRegion(String region)
      Set up the cloud region (for example Kinesis or Redshift).
      Parameters:
      region - string region name

    • getRegionName

      public String getRegionName()
      Return the cloud region name (for example Athena).
      Returns:
      string region name

    • setRegionName

      public void setRegionName(String regionName)
      Set up the cloud region name (for example Athena).
      Parameters:
      regionName - string region name

    • getServiceName

      public String getServiceName()
      Return the service name (for example Oracle).
      Returns:
      string service name

    • setServiceName

      public void setServiceName(String serviceName)
      Set up the service name (for example Oracle).
      Parameters:
      serviceName - string service name

    • getStagingDir

      public String getStagingDir()
      Return the staging directory URI (for example Athena).
      Returns:
      string URI

    • setStagingDir

      public void setStagingDir(String stagingDir)
      Set up the staging directory URI (for example Athena).
      Parameters:
      stagingDir - string URI

    • getWarehouse

      public String getWarehouse()
      Return the warehouse (for example Snowflake).
      Returns:
      string warehouse name

    • setWarehouse

      public void setWarehouse(String warehouse)
      Set up the warehouse (for example Snowflake).
      Parameters:
      warehouse - string warehouse name

    • getStream

      public String getStream()
      Return the stream name (for example Kinesis).
      Returns:
      string stream name

    • setStream

      public void setStream(String stream)
      Set up the stream name (for example Kinesis).
      Parameters:
      stream - string stream name

    • getCustomProperties

      public List<BitolCustomProperty> getCustomProperties()
      Return the list of custom (key/value) properties attached to this element.
      Returns:
      list of custom properties

    • setCustomProperties

      public void setCustomProperties(List<BitolCustomProperty> customProperties)
      Set up the list of custom (key/value) properties attached to this element.
      Parameters:
      customProperties - list of custom properties

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      Return any server properties that are not explicitly modelled by this bean.
      Returns:
      map from property name to value

    • setAdditionalProperties

      public void setAdditionalProperties(Map<String,Object> additionalProperties)
      Set up any server properties that are not explicitly modelled by this bean.
      Parameters:
      additionalProperties - map from property name to value

    • setAdditionalProperty

      public void setAdditionalProperty(String propertyName, Object propertyValue)
      Add a single property that is not explicitly modelled by this bean. Called by Jackson for each unrecognized property so that no part of the document is lost on a round trip.
      Parameters:
      propertyName - name of the property
      propertyValue - value of the property

    • getEncoding

      public String getEncoding()
      Return the character encoding of the data payloads exposed through this server, for example UTF-8.
      Returns:
      String

    • setEncoding

      public void setEncoding(String encoding)
      Set up the character encoding of the data payloads exposed through this server, for example UTF-8.
      Parameters:
      encoding - String

    • getWorkgroup

      public String getWorkgroup()
      Return the Amazon Athena workgroup.
      Returns:
      String

    • setWorkgroup

      public void setWorkgroup(String workgroup)
      Set up the Amazon Athena workgroup.
      Parameters:
      workgroup - String

    • getCatalogUrl

      public String getCatalogUrl()
      Return the URL of an Apache Iceberg REST catalog.
      Returns:
      String

    • setCatalogUrl

      public void setCatalogUrl(String catalogUrl)
      Set up the URL of an Apache Iceberg REST catalog.
      Parameters:
      catalogUrl - String

    • getNamespace

      public String getNamespace()
      Return the namespace within an Apache Iceberg catalog.
      Returns:
      String

    • setNamespace

      public void setNamespace(String namespace)
      Set up the namespace within an Apache Iceberg catalog.
      Parameters:
      namespace - String

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Object
      Returns:
      print out of variables in a JSON-style

    • equals

      public boolean equals(Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Return hash code based on properties.
      Overrides:
      hashCode in class Object
      Returns:
      int