Class: Azure::ApiManagement::Mgmt::V2017_03_01::Models::ApiEntityBaseContract

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

Overview

API base contract details.

Direct Known Subclasses

ApiContractProperties

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_entity_base_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_entity_base_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_entity_base_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_entity_base_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_entity_base_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_entity_base_contract.rb', line 17

def description
  @description
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_entity_base_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_entity_base_contract.rb', line 43

def is_online
  @is_online
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_entity_base_contract.rb', line 25

def subscription_key_parameter_names
  @subscription_key_parameter_names
end

Class Method Details

.mapper ⇒ Object

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



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

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ApiEntityBaseContract',
    type: {
      name: 'Composite',
      class_name: 'ApiEntityBaseContract',
      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'
          }
        }
      }
    }
  }
end