Class: Azure::ApiManagement::Mgmt::V2016_10_10::Models::ApiUpdateContract

Inherits:
ApiEntityBaseContract show all
Includes:
MsRestAzure
Defined in:
lib/2016-10-10/generated/azure_mgmt_api_management/models/api_update_contract.rb

Overview

API Update Contract details.

Instance Attribute Summary collapse

Attributes inherited from ApiEntityBaseContract

#authentication_settings, #description, #subscription_key_parameter_names, #type

Class Method Summary collapse

Instance Attribute Details

#id ⇒ String

Returns API identifier path: /apis/apiId.

Returns:

  • (String) —

    API identifier path: /apis/apiId



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

def id
  @id
end

#name ⇒ String

Returns API name.

Returns:

  • (String) —

    API name.



19
20
21
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/api_update_contract.rb', line 19

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



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

def path
  @path
end

#protocols ⇒ Array<ApiProtocolContract>

operations in this API can be invoked.

Returns:



33
34
35
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/api_update_contract.rb', line 33

def protocols
  @protocols
end

#service_url ⇒ String

API.

Returns:

  • (String) —

    Absolute URL of the backend service implementing this



23
24
25
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/api_update_contract.rb', line 23

def service_url
  @service_url
end

Class Method Details

.mapper ⇒ Object

Mapper for ApiUpdateContract 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
 
# File 'lib/2016-10-10/generated/azure_mgmt_api_management/models/api_update_contract.rb', line 40

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: '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'
          }
        },
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'name',
          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: false,
          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: 'ApiProtocolContractElementType',
                type: {
                  name: 'Enum',
                  module: 'ApiProtocolContract'
                }
            }
          }
        }
      }
    }
  }
end