Class: Azure::ApiManagement::Mgmt::V2018_06_01_preview::Models::ProductEntityBaseParameters

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-06-01-preview/generated/azure_mgmt_api_management/models/product_entity_base_parameters.rb

Overview

Product Entity Base Parameters

Direct Known Subclasses

ProductTagResourceContractProperties

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#approval_required ⇒ Boolean

new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.

Returns:

  • (Boolean) —

    whether subscription approval is required. If false,



38
39
40
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/models/product_entity_base_parameters.rb', line 38

def approval_required
  @approval_required
end

#description ⇒ String

Returns Product description. May include HTML formatting tags.

Returns:

  • (String) —

    Product description. May include HTML formatting tags.



16
17
18
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/models/product_entity_base_parameters.rb', line 16

def description
  @description
end

#state ⇒ ProductState

products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Possible values include: ‘notPublished’, ‘published’

Returns:

  • (ProductState) —

    whether product is published or not. Published



50
51
52
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/models/product_entity_base_parameters.rb', line 50

def state
  @state
end

#subscription_required ⇒ Boolean

accessing APIs included in this product. If true, the product is referred to as “protected” and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as “open” and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it’s value is assumed to be true.

Returns:

  • (Boolean) —

    Whether a product subscription is required for



30
31
32
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/models/product_entity_base_parameters.rb', line 30

def subscription_required
  @subscription_required
end

#subscriptions_limit ⇒ Integer

to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.

Returns:

  • (Integer) —

    Whether the number of subscriptions a user can have



44
45
46
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/models/product_entity_base_parameters.rb', line 44

def subscriptions_limit
  @subscriptions_limit
end

#terms ⇒ String

to the product will be presented and required to accept these terms before they can complete the subscription process.

Returns:

  • (String) —

    Product terms of use. Developers trying to subscribe



21
22
23
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/models/product_entity_base_parameters.rb', line 21

def terms
  @terms
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/models/product_entity_base_parameters.rb', line 57

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ProductEntityBaseParameters',
    type: {
      name: 'Composite',
      class_name: 'ProductEntityBaseParameters',
      model_properties: {
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'description',
          constraints: {
            MaxLength: 1000,
            MinLength: 1
          },
          type: {
            name: 'String'
          }
        },
        terms: {
          client_side_validation: true,
          required: false,
          serialized_name: 'terms',
          type: {
            name: 'String'
          }
        },
        subscription_required: {
          client_side_validation: true,
          required: false,
          serialized_name: 'subscriptionRequired',
          type: {
            name: 'Boolean'
          }
        },
        approval_required: {
          client_side_validation: true,
          required: false,
          serialized_name: 'approvalRequired',
          type: {
            name: 'Boolean'
          }
        },
        subscriptions_limit: {
          client_side_validation: true,
          required: false,
          serialized_name: 'subscriptionsLimit',
          type: {
            name: 'Number'
          }
        },
        state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'state',
          type: {
            name: 'Enum',
            module: 'ProductState'
          }
        }
      }
    }
  }
end