text: # 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 .resource_py3 import Resource
  
  
  class ApiContract(Resource):
      """Api details.
  
      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 id: Resource ID.
      :vartype id: str
      :ivar name: Resource name.
      :vartype name: str
      :ivar type: Resource type for API Management resource.
      :vartype type: str
      :param description: Description of the API. May include HTML formatting
       tags.
      :type description: str
      :param authentication_settings: Collection of authentication settings
       included into this API.
      :type authentication_settings:
       ~azure.mgmt.apimanagement.models.AuthenticationSettingsContract
      :param subscription_key_parameter_names: Protocols over which API is made
       available.
      :type subscription_key_parameter_names:
       ~azure.mgmt.apimanagement.models.SubscriptionKeyParameterNamesContract
      :param api_type: Type of API. Possible values include: 'http', 'soap'
      :type api_type: str or ~azure.mgmt.apimanagement.models.ApiType
      :param api_revision: Describes the Revision of the Api. If no value is
       provided, default revision 1 is created
      :type api_revision: str
      :param api_version: Indicates the Version identifier of the API if the API
       is versioned
      :type api_version: str
      :param is_current: Indicates if API revision is current api revision.
      :type is_current: bool
      :ivar is_online: Indicates if API revision is accessible via the gateway.
      :vartype is_online: bool
      :param api_revision_description: Description of the Api Revision.
      :type api_revision_description: str
      :param api_version_description: Description of the Api Version.
      :type api_version_description: str
      :param api_version_set_id: A resource identifier for the related
       ApiVersionSet.
      :type api_version_set_id: str
      :param subscription_required: Specifies whether an API or Product
       subscription is required for accessing the API.
      :type subscription_required: bool
      :param source_api_id: API identifier of the source API.
      :type source_api_id: str
      :param display_name: API name. Must be 1 to 300 characters long.
      :type display_name: str
      :param service_url: Absolute URL of the backend service implementing this
       API. Cannot be more than 2000 characters long.
      :type service_url: str
      :param path: Required. Relative URL uniquely identifying this API and all
       of its resource paths within the API Management service instance. It is
       appended to the API endpoint base URL specified during the service
       instance creation to form a public URL for this API.
      :type path: str
      :param protocols: Describes on which protocols the operations in this API
       can be invoked.
      :type protocols: list[str or ~azure.mgmt.apimanagement.models.Protocol]
      :param api_version_set: Version set details
      :type api_version_set:
       ~azure.mgmt.apimanagement.models.ApiVersionSetContractDetails
      """
  
      _validation = {
          'id': {'readonly': True},
          'name': {'readonly': True},
          'type': {'readonly': True},
          'api_revision': {'max_length': 100, 'min_length': 1},
          'api_version': {'max_length': 100},
          'is_online': {'readonly': True},
          'api_revision_description': {'max_length': 256},
          'api_version_description': {'max_length': 256},
          'display_name': {'max_length': 300, 'min_length': 1},
          'service_url': {'max_length': 2000, 'min_length': 0},
          'path': {'required': True, 'max_length': 400, 'min_length': 0},
      }
  
      _attribute_map = {
          'id': {'key': 'id', 'type': 'str'},
          'name': {'key': 'name', 'type': 'str'},
          'type': {'key': 'type', 'type': 'str'},
          'description': {'key': 'properties.description', 'type': 'str'},
          'authentication_settings': {'key': 'properties.authenticationSettings', 'type': 'AuthenticationSettingsContract'},
          'subscription_key_parameter_names': {'key': 'properties.subscriptionKeyParameterNames', 'type': 'SubscriptionKeyParameterNamesContract'},
          'api_type': {'key': 'properties.type', 'type': 'str'},
          'api_revision': {'key': 'properties.apiRevision', 'type': 'str'},
          'api_version': {'key': 'properties.apiVersion', 'type': 'str'},
          'is_current': {'key': 'properties.isCurrent', 'type': 'bool'},
          'is_online': {'key': 'properties.isOnline', 'type': 'bool'},
          'api_revision_description': {'key': 'properties.apiRevisionDescription', 'type': 'str'},
          'api_version_description': {'key': 'properties.apiVersionDescription', 'type': 'str'},
          'api_version_set_id': {'key': 'properties.apiVersionSetId', 'type': 'str'},
          'subscription_required': {'key': 'properties.subscriptionRequired', 'type': 'bool'},
          'source_api_id': {'key': 'properties.sourceApiId', 'type': 'str'},
          'display_name': {'key': 'properties.displayName', 'type': 'str'},
          'service_url': {'key': 'properties.serviceUrl', 'type': 'str'},
          'path': {'key': 'properties.path', 'type': 'str'},
          'protocols': {'key': 'properties.protocols', 'type': '[Protocol]'},
          'api_version_set': {'key': 'properties.apiVersionSet', 'type': 'ApiVersionSetContractDetails'},
      }
  
      def __init__(self, *, path: str, description: str=None, authentication_settings=None, subscription_key_parameter_names=None, api_type=None, api_revision: str=None, api_version: str=None, is_current: bool=None, api_revision_description: str=None, api_version_description: str=None, api_version_set_id: str=None, subscription_required: bool=None, source_api_id: str=None, display_name: str=None, service_url: str=None, protocols=None, api_version_set=None, **kwargs) -> None:
          super(ApiContract, self).__init__(**kwargs)
          self.description = description
          self.authentication_settings = authentication_settings
          self.subscription_key_parameter_names = subscription_key_parameter_names
          self.api_type = api_type
          self.api_revision = api_revision
          self.api_version = api_version
          self.is_current = is_current
          self.is_online = None
          self.api_revision_description = api_revision_description
          self.api_version_description = api_version_description
          self.api_version_set_id = api_version_set_id
          self.subscription_required = subscription_required
          self.source_api_id = source_api_id
          self.display_name = display_name
          self.service_url = service_url
          self.path = path
          self.protocols = protocols
          self.api_version_set = api_version_set
  