Class: Azure::ApiManagement::Mgmt::V2016_10_10::Models::ApiEntityBaseContract

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2016-10-10/generated/azure_mgmt_api_management/models/api_entity_base_contract.rb

Overview

API base contract details.

Direct Known Subclasses

ApiContract, ApiUpdateContract

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#authentication_settings ⇒ AuthenticationSettingsContract

settings included into this API.

Returns:



21
22
23
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/api_entity_base_contract.rb', line 21

def authentication_settings
  @authentication_settings
end

#description ⇒ String

tags.

Returns:

  • (String) —

    Description of the API. May include HTML formatting



17
18
19
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/api_entity_base_contract.rb', line 17

def description
  @description
end

#subscription_key_parameter_names ⇒ SubscriptionKeyParameterNamesContract

API is made available.

Returns:



25
26
27
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/api_entity_base_contract.rb', line 25

def subscription_key_parameter_names
  @subscription_key_parameter_names
end

#type ⇒ ApiTypeContract

‘Soap’

Returns:



29
30
31
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/api_entity_base_contract.rb', line 29

def type
  @type
end

Class Method Details

.mapper ⇒ Object

Mapper for ApiEntityBaseContract class as Ruby Hash. This will be used for serialization/deserialization.



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/api_entity_base_contract.rb', line 36

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ApiEntityBaseContract',
    type: {
      name: 'Composite',
      class_name: 'ApiEntityBaseContract',
      model_properties: {
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'description',
          type: {
            name: 'String'
          }
        },
        authentication_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'authenticationSettings',
          type: {
            name: 'Composite',
            class_name: 'AuthenticationSettingsContract'
          }
        },
        subscription_key_parameter_names: {
          client_side_validation: true,
          required: false,
          serialized_name: 'subscriptionKeyParameterNames',
          type: {
            name: 'Composite',
            class_name: 'SubscriptionKeyParameterNamesContract'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'type',
          type: {
            name: 'Enum',
            module: 'ApiTypeContract'
          }
        }
      }
    }
  }
end