Class: Azure::ApiManagement::Mgmt::V2016_07_07::Models::OperationContract

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

Overview

Api Operation details.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#description ⇒ String

formatting tags.

Returns:

  • (String) —

    Description of the operation. May include HTML



39
40
41
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/operation_contract.rb', line 39

def description
  @description
end

#id ⇒ String

API Management service instance. The value is a valid relative URL in the format of /apis/aid/operations/#id where aid is an API identifier and #id is an operation identifier.

Returns:

  • (String) —

    Uniquely identifies the operation within the current



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

def id
  @id
end

#method ⇒ String

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

Returns:

  • (String) —

    A Valid HTTP Operation Method. Typical Http Methods



26
27
28
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/operation_contract.rb', line 26

def method
  @method
end

#name ⇒ String

Returns Operation Name.

Returns:

  • (String) —

    Operation Name.



22
23
24
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/operation_contract.rb', line 22

def name
  @name
end

#request ⇒ RequestContract

Returns An entity containing request details.

Returns:



42
43
44
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/operation_contract.rb', line 42

def request
  @request
end

#responses ⇒ Array<ResultContract>

Returns Array of Operation responses.

Returns:



45
46
47
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/operation_contract.rb', line 45

def responses
  @responses
end

#template_parameters ⇒ Array<ParameterContract>

parameters.

Returns:



35
36
37
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/operation_contract.rb', line 35

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



31
32
33
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/operation_contract.rb', line 31

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.



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
 
# File 'lib/2016-07-07/generated/azure_mgmt_api_management/models/operation_contract.rb', line 52

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: true,
          serialized_name: 'name',
          constraints: {
            MaxLength: 300,
            MinLength: 1
          },
          type: {
            name: 'String'
          }
        },
        method: {
          client_side_validation: true,
          required: true,
          serialized_name: 'method',
          type: {
            name: 'String'
          }
        },
        url_template: {
          client_side_validation: true,
          required: true,
          serialized_name: 'urlTemplate',
          constraints: {
            MaxLength: 1000,
            MinLength: 1
          },
          type: {
            name: 'String'
          }
        },
        template_parameters: {
          client_side_validation: true,
          required: false,
          serialized_name: '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: 'description',
          constraints: {
            MaxLength: 1000
          },
          type: {
            name: 'String'
          }
        },
        request: {
          client_side_validation: true,
          required: false,
          serialized_name: 'request',
          type: {
            name: 'Composite',
            class_name: 'RequestContract'
          }
        },
        responses: {
          client_side_validation: true,
          required: false,
          serialized_name: 'responses',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ResultContractElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ResultContract'
                }
            }
          }
        }
      }
    }
  }
end