Source code for azure.cognitiveservices.search.entitysearch.models.contractual_rules_media_attribution_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 .contractual_rules_attribution import ContractualRulesAttribution
[docs]class ContractualRulesMediaAttribution(ContractualRulesAttribution):
"""Defines a contractual rule for media attribution.
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.
:ivar target_property_name: The name of the field that the rule applies
to.
:vartype target_property_name: str
:param _type: Required. Constant filled by server.
:type _type: str
:ivar must_be_close_to_content: A Boolean value that determines whether
the contents of the rule must be placed in close proximity to the field
that the rule applies to. If true, the contents must be placed in close
proximity. If false, or this field does not exist, the contents may be
placed at the caller's discretion.
:vartype must_be_close_to_content: bool
:ivar url: The URL that you use to create of hyperlink of the media
content. For example, if the target is an image, you would use the URL to
make the image clickable.
:vartype url: str
"""
_validation = {
'target_property_name': {'readonly': True},
'_type': {'required': True},
'must_be_close_to_content': {'readonly': True},
'url': {'readonly': True},
}
_attribute_map = {
'target_property_name': {'key': 'targetPropertyName', 'type': 'str'},
'_type': {'key': '_type', 'type': 'str'},
'must_be_close_to_content': {'key': 'mustBeCloseToContent', 'type': 'bool'},
'url': {'key': 'url', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(ContractualRulesMediaAttribution, self).__init__(**kwargs)
self.url = None
self._type = 'ContractualRules/MediaAttribution'