Source code for azure.cognitiveservices.search.autosuggest.models.response_py3

# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
#
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is
# regenerated.
# --------------------------------------------------------------------------

from .identifiable_py3 import Identifiable


[docs]class Response(Identifiable): """Defines a response. All schemas that could be returned at the root of a response should inherit from this. You probably want to use the sub-classes and not this class directly. Known sub-classes are: Answer, Thing, ErrorResponse Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. :param _type: Required. Constant filled by server. :type _type: str :ivar id: A String identifier. :vartype id: str :ivar read_link: The URL that returns this resource. :vartype read_link: str :ivar web_search_url: The URL To Bing's search result for this item. :vartype web_search_url: str :ivar potential_action: :vartype potential_action: list[~azure.cognitiveservices.search.autosuggest.models.Action] :ivar immediate_action: :vartype immediate_action: list[~azure.cognitiveservices.search.autosuggest.models.Action] :ivar preferred_clickthrough_url: :vartype preferred_clickthrough_url: str :ivar adaptive_card: :vartype adaptive_card: str """ _validation = { '_type': {'required': True}, 'id': {'readonly': True}, 'read_link': {'readonly': True}, 'web_search_url': {'readonly': True}, 'potential_action': {'readonly': True}, 'immediate_action': {'readonly': True}, 'preferred_clickthrough_url': {'readonly': True}, 'adaptive_card': {'readonly': True}, } _attribute_map = { '_type': {'key': '_type', 'type': 'str'}, 'id': {'key': 'id', 'type': 'str'}, 'read_link': {'key': 'readLink', 'type': 'str'}, 'web_search_url': {'key': 'webSearchUrl', 'type': 'str'}, 'potential_action': {'key': 'potentialAction', 'type': '[Action]'}, 'immediate_action': {'key': 'immediateAction', 'type': '[Action]'}, 'preferred_clickthrough_url': {'key': 'preferredClickthroughUrl', 'type': 'str'}, 'adaptive_card': {'key': 'adaptiveCard', 'type': 'str'}, } _subtype_map = { '_type': {'Answer': 'Answer', 'Thing': 'Thing', 'ErrorResponse': 'ErrorResponse'} } def __init__(self, **kwargs) -> None: super(Response, self).__init__(**kwargs) self.read_link = None self.web_search_url = None self.potential_action = None self.immediate_action = None self.preferred_clickthrough_url = None self.adaptive_card = None self._type = 'Response'