ShopifyObjectDataset Class

Shopify Service dataset.

All required parameters must be populated in order to send to Azure.

Inheritance
azure.synapse.artifacts.models._models_py3.Dataset
ShopifyObjectDataset

Constructor

ShopifyObjectDataset(*, 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, **kwargs)

Parameters

additional_properties
dict[str, object]
Required

Unmatched properties from the message are deserialized to this collection.

type
str
Required

Required. Type of dataset.Constant filled by server.

description
str
Required

Dataset description.

structure
object
Required

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

schema
object
Required

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

linked_service_name
LinkedServiceReference
Required

Required. Linked service reference.

parameters
dict[str, ParameterSpecification]
Required

Parameters for dataset.

annotations
list[object]
Required

List of tags that can be used for describing the Dataset.

folder
DatasetFolder
Required

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

table_name
object
Required

The table name. Type: string (or Expression with resultType string).

Keyword-Only Parameters

linked_service_name
Required
additional_properties
Required
description
Required
structure
Required
schema
Required
parameters
Required
annotations
Required
folder
Required
table_name
Required

Methods

as_dict

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

deserialize

Parse a str using the RestAPI syntax and return a model.

enable_additional_properties_sending
from_dict

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)

is_xml_model
serialize

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.

validate

Validate this model recursively and return a list of ValidationError.

as_dict

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parameters

key_transformer
<xref:function>

A key transformer function.

keep_readonly
default value: True

Returns

A dict JSON compatible object

Return type

deserialize

Parse a str using the RestAPI syntax and return a model.

deserialize(data, content_type=None)

Parameters

data
str
Required

A str using RestAPI structure. JSON by default.

content_type
str
default value: None

JSON by default, set application/xml if XML.

Returns

An instance of this model

Exceptions

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

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)

from_dict(data, key_extractors=None, content_type=None)

Parameters

data
dict
Required

A dict using RestAPI structure

content_type
str
default value: None

JSON by default, set application/xml if XML.

key_extractors
default value: None

Returns

An instance of this model

Exceptions

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

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.

serialize(keep_readonly=False, **kwargs)

Parameters

keep_readonly
bool
default value: False

If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

validate

Validate this model recursively and return a list of ValidationError.

validate()

Returns

A list of validation error

Return type