Class: Azure::ApiManagement::Mgmt::V2017_03_01::Models::ApiUpdateContract

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-03-01/generated/azure_mgmt_api_management/models/api_update_contract.rb

Overview

API update contract details.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#api_revision ⇒ String

provided, default revision 1 is created

Returns:

  • (String) —

    Describes the Revision of the Api. If no value is



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

def api_revision
  @api_revision
end

#api_type ⇒ ApiType

Returns Type of API. Possible values include: ‘http’, ‘soap’.

Returns:

  • (ApiType) —

    Type of API. Possible values include: ‘http’, ‘soap’



28
29
30
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_update_contract.rb', line 28

def api_type
  @api_type
end

#api_version ⇒ String

is versioned

Returns:

  • (String) —

    Indicates the Version identifier of the API if the API



36
37
38
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_update_contract.rb', line 36

def api_version
  @api_version
end

#api_version_set_id ⇒ String

Returns A resource identifier for the related ApiVersionSet.

Returns:

  • (String) —

    A resource identifier for the related ApiVersionSet.



46
47
48
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_update_contract.rb', line 46

def api_version_set_id
  @api_version_set_id
end

#authentication_settings ⇒ AuthenticationSettingsContract

settings included into this API.

Returns:



21
22
23
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_update_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/2017-03-01/generated/azure_mgmt_api_management/models/api_update_contract.rb', line 17

def description
  @description
end

#display_name ⇒ String

Returns API name.

Returns:

  • (String) —

    API name.



49
50
51
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_update_contract.rb', line 49

def display_name
  @display_name
end

#is_current ⇒ Boolean

Returns Indicates if API revision is current api revision.

Returns:

  • (Boolean) —

    Indicates if API revision is current api revision.



39
40
41
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_update_contract.rb', line 39

def is_current
  @is_current
end

#is_online ⇒ Boolean

gateway.

Returns:

  • (Boolean) —

    Indicates if API revision is accessible via the



43
44
45
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_update_contract.rb', line 43

def is_online
  @is_online
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



59
60
61
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_update_contract.rb', line 59

def path
  @path
end

#protocols ⇒ Array<Protocol>

in this API can be invoked.

Returns:

  • (Array<Protocol>) —

    Describes on which protocols the operations



63
64
65
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_update_contract.rb', line 63

def protocols
  @protocols
end

#service_url ⇒ String

API.

Returns:

  • (String) —

    Absolute URL of the backend service implementing this



53
54
55
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_update_contract.rb', line 53

def service_url
  @service_url
end

#subscription_key_parameter_names ⇒ SubscriptionKeyParameterNamesContract

API is made available.

Returns:



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

def subscription_key_parameter_names
  @subscription_key_parameter_names
end

Class Method Details

.mapper ⇒ Object

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



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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/api_update_contract.rb', line 70

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ApiUpdateContract',
    type: {
      name: 'Composite',
      class_name: 'ApiUpdateContract',
      model_properties: {
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.description',
          type: {
            name: 'String'
          }
        },
        authentication_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.authenticationSettings',
          type: {
            name: 'Composite',
            class_name: 'AuthenticationSettingsContract'
          }
        },
        subscription_key_parameter_names: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.subscriptionKeyParameterNames',
          type: {
            name: 'Composite',
            class_name: 'SubscriptionKeyParameterNamesContract'
          }
        },
        api_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.type',
          type: {
            name: 'String'
          }
        },
        api_revision: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.apiRevision',
          constraints: {
            MaxLength: 100,
            MinLength: 1
          },
          type: {
            name: 'String'
          }
        },
        api_version: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.apiVersion',
          constraints: {
            MaxLength: 100
          },
          type: {
            name: 'String'
          }
        },
        is_current: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.isCurrent',
          type: {
            name: 'Boolean'
          }
        },
        is_online: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.isOnline',
          type: {
            name: 'Boolean'
          }
        },
        api_version_set_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.apiVersionSetId',
          type: {
            name: 'String'
          }
        },
        display_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.displayName',
          constraints: {
            MaxLength: 300,
            MinLength: 1
          },
          type: {
            name: 'String'
          }
        },
        service_url: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.serviceUrl',
          constraints: {
            MaxLength: 2000,
            MinLength: 1
          },
          type: {
            name: 'String'
          }
        },
        path: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.path',
          constraints: {
            MaxLength: 400,
            MinLength: 0
          },
          type: {
            name: 'String'
          }
        },
        protocols: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.protocols',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ProtocolElementType',
                type: {
                  name: 'Enum',
                  module: 'Protocol'
                }
            }
          }
        }
      }
    }
  }
end