azure.synapse.artifacts.models.DatasetReference.yml

### YamlMime:PythonClass
uid: azure.synapse.artifacts.models.DatasetReference
name: DatasetReference
fullName: azure.synapse.artifacts.models.DatasetReference
module: azure.synapse.artifacts.models
inheritances:
- azure.synapse.artifacts._serialization.Model
summary: 'Dataset reference type.


  All required parameters must be populated in order to send to server.'
constructor:
  syntax: 'DatasetReference(*, type: str | _models.DatasetReferenceType, reference_name:
    str, parameters: Dict[str, MutableMapping[str, Any]] | None = None, **kwargs:
    Any)'
  keywordOnlyParameters:
  - name: type
    description: Dataset reference type. Required. "DatasetReference"
    types:
    - <xref:str>
    - <xref:azure.synapse.artifacts.models.DatasetReferenceType>
  - name: reference_name
    description: Reference dataset name. Required.
    types:
    - <xref:str>
  - name: parameters
    description: Arguments for dataset.
    types:
    - <xref:dict>[<xref:str>, <xref:JSON>]
variables:
- description: Dataset reference type. Required. "DatasetReference"
  name: type
  types:
  - <xref:str>
  - <xref:azure.synapse.artifacts.models.DatasetReferenceType>
- description: Reference dataset name. Required.
  name: reference_name
  types:
  - <xref:str>
- description: Arguments for dataset.
  name: parameters
  types:
  - <xref:dict>[<xref:str>, <xref:JSON>]
methods:
- uid: azure.synapse.artifacts.models.DatasetReference.as_dict
  name: as_dict
  summary: "Return a dict that can be serialized 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\nmsrest 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: bool = True, key_transformer: ~typing.Callable[[str,
    ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>,
    **kwargs: ~typing.Any) -> MutableMapping[str, Any]'
  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.DatasetReference.deserialize
  name: deserialize
  summary: Parse a str using the RestAPI syntax and return a model.
  signature: 'deserialize(data: Any, content_type: str | None = None) -> ModelType'
  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.DatasetReference.enable_additional_properties_sending
  name: enable_additional_properties_sending
  signature: enable_additional_properties_sending() -> None
- uid: azure.synapse.artifacts.models.DatasetReference.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: Any, key_extractors: Callable[[str, Dict[str, Any],
    Any], Any] | None = None, content_type: str | None = None) -> ModelType'
  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.DatasetReference.is_xml_model
  name: is_xml_model
  signature: is_xml_model() -> bool
- uid: azure.synapse.artifacts.models.DatasetReference.serialize
  name: serialize
  summary: 'Return the JSON that would be sent to server 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: bool = False, **kwargs: Any) -> MutableMapping[str,
    Any]'
  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>