Class: Azure::ApiManagement::Mgmt::V2017_03_01::Models::ApiContractProperties

Inherits:
ApiEntityBaseContract show all
Includes:
MsRestAzure
Defined in:
lib/2017-03-01/generated/azure_mgmt_api_management/models/api_contract_properties.rb

Overview

Api Entity Properties

Instance Attribute Summary collapse

Attributes inherited from ApiEntityBaseContract

#api_revision, #api_type, #api_version, #api_version_set_id, #authentication_settings, #description, #is_current, #is_online, #subscription_key_parameter_names

Class Method Summary collapse

Instance Attribute Details

#api_version_set ⇒ ApiVersionSetContract

Returns:



33
34
35
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_contract_properties.rb', line 33

def api_version_set
  @api_version_set
end

#display_name ⇒ String

Returns API name.

Returns:

  • (String) —

    API name.



16
17
18
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_contract_properties.rb', line 16

def display_name
  @display_name
end

#path ⇒ String

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.

Returns:

  • (String) —

    Relative URL uniquely identifying this API and all of



26
27
28
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_contract_properties.rb', line 26

def path
  @path
end

#protocols ⇒ Array<Protocol>

in this API can be invoked.

Returns:

  • (Array<Protocol>) —

    Describes on which protocols the operations



30
31
32
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_contract_properties.rb', line 30

def protocols
  @protocols
end

#service_url ⇒ String

API.

Returns:

  • (String) —

    Absolute URL of the backend service implementing this



20
21
22
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_contract_properties.rb', line 20

def service_url
  @service_url
end

Class Method Details

.mapper ⇒ Object

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



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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_contract_properties.rb', line 40

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ApiContractProperties',
    type: {
      name: 'Composite',
      class_name: 'ApiContractProperties',
      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'
          }
        },
        api_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        api_revision: {
          client_side_validation: true,
          required: false,
          serialized_name: 'apiRevision',
          constraints: {
            MaxLength: 100,
            MinLength: 1
          },
          type: {
            name: 'String'
          }
        },
        api_version: {
          client_side_validation: true,
          required: false,
          serialized_name: 'apiVersion',
          constraints: {
            MaxLength: 100
          },
          type: {
            name: 'String'
          }
        },
        is_current: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'isCurrent',
          type: {
            name: 'Boolean'
          }
        },
        is_online: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'isOnline',
          type: {
            name: 'Boolean'
          }
        },
        api_version_set_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'apiVersionSetId',
          type: {
            name: 'String'
          }
        },
        display_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'displayName',
          constraints: {
            MaxLength: 300,
            MinLength: 1
          },
          type: {
            name: 'String'
          }
        },
        service_url: {
          client_side_validation: true,
          required: false,
          serialized_name: 'serviceUrl',
          constraints: {
            MaxLength: 2000,
            MinLength: 1
          },
          type: {
            name: 'String'
          }
        },
        path: {
          client_side_validation: true,
          required: true,
          serialized_name: 'path',
          constraints: {
            MaxLength: 400,
            MinLength: 0
          },
          type: {
            name: 'String'
          }
        },
        protocols: {
          client_side_validation: true,
          required: false,
          serialized_name: 'protocols',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ProtocolElementType',
                type: {
                  name: 'Enum',
                  module: 'Protocol'
                }
            }
          }
        },
        api_version_set: {
          client_side_validation: true,
          required: false,
          serialized_name: 'apiVersionSet',
          type: {
            name: 'Composite',
            class_name: 'ApiVersionSetContract'
          }
        }
      }
    }
  }
end