azure.synapse.artifacts.models.PhoenixObjectDataset.yml

### YamlMime:PythonClass
uid: azure.synapse.artifacts.models.PhoenixObjectDataset
name: PhoenixObjectDataset
fullName: azure.synapse.artifacts.models.PhoenixObjectDataset
module: azure.synapse.artifacts.models
inheritances:
- azure.synapse.artifacts.models._models_py3.Dataset
summary: 'Phoenix server dataset.


  All required parameters must be populated in order to send to Azure.'
constructor:
  syntax: 'PhoenixObjectDataset(*, linked_service_name: LinkedServiceReference, additional_properties:
    Dict[str, object] | None = None, description: str | None = None, structure: object
    | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification]
    | None = None, annotations: List[object] | None = None, folder: DatasetFolder
    | None = None, table_name: object | None = None, table: object | None = None,
    schema_type_properties_schema: object | None = None, **kwargs)'
  parameters:
  - name: additional_properties
    description: 'Unmatched properties from the message are deserialized to this

      collection.'
    isRequired: true
    types:
    - <xref:dict>[<xref:str>, <xref:object>]
  - name: type
    description: Required. Type of dataset.Constant filled by server.
    isRequired: true
    types:
    - <xref:str>
  - name: description
    description: Dataset description.
    isRequired: true
    types:
    - <xref:str>
  - name: structure
    description: 'Columns that define the structure of the dataset. Type: array (or
      Expression

      with resultType array), itemType: DatasetDataElement.'
    isRequired: true
    types:
    - <xref:object>
  - name: schema
    description: 'Columns that define the physical type schema of the dataset. Type:
      array (or

      Expression with resultType array), itemType: DatasetSchemaDataElement.'
    isRequired: true
    types:
    - <xref:object>
  - name: linked_service_name
    description: Required. Linked service reference.
    isRequired: true
    types:
    - <xref:azure.synapse.artifacts.models.LinkedServiceReference>
  - name: parameters
    description: Parameters for dataset.
    isRequired: true
    types:
    - <xref:dict>[<xref:str>, <xref:azure.synapse.artifacts.models.ParameterSpecification>]
  - name: annotations
    description: List of tags that can be used for describing the Dataset.
    isRequired: true
    types:
    - <xref:list>[<xref:object>]
  - name: folder
    description: 'The folder that this Dataset is in. If not specified, Dataset will
      appear at the

      root level.'
    isRequired: true
    types:
    - <xref:azure.synapse.artifacts.models.DatasetFolder>
  - name: table_name
    description: 'This property will be retired. Please consider using schema + table

      properties instead.'
    isRequired: true
    types:
    - <xref:object>
  - name: table
    description: 'The table name of the Phoenix. Type: string (or Expression with
      resultType

      string).'
    isRequired: true
    types:
    - <xref:object>
  - name: schema_type_properties_schema
    description: 'The schema name of the Phoenix. Type: string (or

      Expression with resultType string).'
    isRequired: true
    types:
    - <xref:object>
  keywordOnlyParameters:
  - name: linked_service_name
    isRequired: true
  - name: additional_properties
    isRequired: true
  - name: description
    isRequired: true
  - name: structure
    isRequired: true
  - name: schema
    isRequired: true
  - name: parameters
    isRequired: true
  - name: annotations
    isRequired: true
  - name: folder
    isRequired: true
  - name: table_name
    isRequired: true
  - name: table
    isRequired: true
  - name: schema_type_properties_schema
    isRequired: true
methods:
- uid: azure.synapse.artifacts.models.PhoenixObjectDataset.as_dict
  name: as_dict
  summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\
    \ optionally use a callback as parameter:\n\nKey is the attribute name used in\
    \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\
    msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\
    \ in this object.\n\nThe string returned will be used to serialize the key.\n\
    If the return type is a list, this is considered hierarchical\nresult dict.\n\n\
    See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\
    \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\
    \ pass the kwargs is_xml=True."
  signature: as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>,
    **kwargs)
  parameters:
  - name: key_transformer
    description: A key transformer function.
    types:
    - <xref:function>
  - name: keep_readonly
    defaultValue: 'True'
  return:
    description: A dict JSON compatible object
    types:
    - <xref:dict>
- uid: azure.synapse.artifacts.models.PhoenixObjectDataset.deserialize
  name: deserialize
  summary: Parse a str using the RestAPI syntax and return a model.
  signature: deserialize(data, content_type=None)
  parameters:
  - name: data
    description: A str using RestAPI structure. JSON by default.
    isRequired: true
    types:
    - <xref:str>
  - name: content_type
    description: JSON by default, set application/xml if XML.
    defaultValue: None
    types:
    - <xref:str>
  return:
    description: An instance of this model
  exceptions:
  - type: DeserializationError if something went wrong
- uid: azure.synapse.artifacts.models.PhoenixObjectDataset.enable_additional_properties_sending
  name: enable_additional_properties_sending
  signature: enable_additional_properties_sending()
- uid: azure.synapse.artifacts.models.PhoenixObjectDataset.from_dict
  name: from_dict
  summary: 'Parse a dict using given key extractor return a model.


    By default consider key

    extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor

    and last_rest_key_case_insensitive_extractor)'
  signature: from_dict(data, key_extractors=None, content_type=None)
  parameters:
  - name: data
    description: A dict using RestAPI structure
    isRequired: true
    types:
    - <xref:dict>
  - name: content_type
    description: JSON by default, set application/xml if XML.
    defaultValue: None
    types:
    - <xref:str>
  - name: key_extractors
    defaultValue: None
  return:
    description: An instance of this model
  exceptions:
  - type: DeserializationError if something went wrong
- uid: azure.synapse.artifacts.models.PhoenixObjectDataset.is_xml_model
  name: is_xml_model
  signature: is_xml_model()
- uid: azure.synapse.artifacts.models.PhoenixObjectDataset.serialize
  name: serialize
  summary: 'Return the JSON that would be sent to azure from this model.


    This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*.


    If you want XML serialization, you can pass the kwargs is_xml=True.'
  signature: serialize(keep_readonly=False, **kwargs)
  parameters:
  - name: keep_readonly
    description: If you want to serialize the readonly attributes
    defaultValue: 'False'
    types:
    - <xref:bool>
  return:
    description: A dict JSON compatible object
    types:
    - <xref:dict>
- uid: azure.synapse.artifacts.models.PhoenixObjectDataset.validate
  name: validate
  summary: Validate this model recursively and return a list of ValidationError.
  signature: validate()
  return:
    description: A list of validation error
    types:
    - <xref:list>