Class: Azure::ApiManagement::Mgmt::V2017_03_01::Models::OperationContract

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

Overview

Api Operation details.

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #name, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#description ⇒ String

formatting tags.

Returns:

  • (String) —

    Description of the operation. May include HTML



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

def description
  @description
end

#display_name ⇒ String

Returns Operation Name.

Returns:

  • (String) —

    Operation Name.



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

def display_name
  @display_name
end

#method ⇒ String

like GET, PUT, POST but not limited by only them.

Returns:

  • (String) —

    A Valid HTTP Operation Method. Typical Http Methods



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

def method
  @method
end

#policies ⇒ String

Returns Operation Policies.

Returns:

  • (String) —

    Operation Policies



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

def policies
  @policies
end

#request ⇒ RequestContract

Returns An entity containing request details.

Returns:



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

def request
  @request
end

#responses ⇒ Array<ResponseContract>

Returns Array of Operation responses.

Returns:



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

def responses
  @responses
end

#template_parameters ⇒ Array<ParameterContract>

parameters.

Returns:



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

def template_parameters
  @template_parameters
end

#url_template ⇒ String

for this operation. May include parameters. Example: /customers/cid/orders/oid/?date=date

Returns:

  • (String) —

    Relative URL template identifying the target resource



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

def url_template
  @url_template
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/operation_contract.rb', line 49

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'OperationContract',
    type: {
      name: 'Composite',
      class_name: 'OperationContract',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        template_parameters: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.templateParameters',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ParameterContractElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ParameterContract'
                }
            }
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.description',
          constraints: {
            MaxLength: 1000
          },
          type: {
            name: 'String'
          }
        },
        request: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.request',
          type: {
            name: 'Composite',
            class_name: 'RequestContract'
          }
        },
        responses: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.responses',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ResponseContractElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ResponseContract'
                }
            }
          }
        },
        policies: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.policies',
          type: {
            name: 'String'
          }
        },
        display_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.displayName',
          constraints: {
            MaxLength: 300,
            MinLength: 1
          },
          type: {
            name: 'String'
          }
        },
        method: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.method',
          type: {
            name: 'String'
          }
        },
        url_template: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.urlTemplate',
          constraints: {
            MaxLength: 1000,
            MinLength: 1
          },
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end