Class: Azure::ARM::Search::Models::SearchService

Inherits:
MsRestAzure::Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/generated/azure_mgmt_search/models/search_service.rb

Overview

Describes an Azure Search service and its current state.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#hosting_mode ⇒ HostingMode

set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either ‘default’ or ‘highDensity’. For all other SKUs, this value must be ‘default’. Possible values include: ‘default’, ‘highDensity’. Default value: ‘default’ .

Returns:

  • (HostingMode) —

    Applicable only for the standard3 SKU. You can



34
35
36
 
# File 'lib/generated/azure_mgmt_search/models/search_service.rb', line 34

def hosting_mode
  @hosting_mode
end

#partition_count ⇒ Integer

specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For ‘standard3’ services with hostingMode set to ‘highDensity’, the allowed values are between 1 and 3. Default value: 1 .

Returns:

  • (Integer) —

    The number of partitions in the Search service; if



25
26
27
 
# File 'lib/generated/azure_mgmt_search/models/search_service.rb', line 25

def partition_count
  @partition_count
end

#provisioning_state ⇒ ProvisioningState

operation performed on the Search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either ‘succeeded’ or ‘failed’. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as ‘succeeded’ directly in the call to Create Search service. This is because the free service uses capacity that is already set up. Possible values include: ‘succeeded’, ‘provisioning’, ‘failed’

Returns:



68
69
70
 
# File 'lib/generated/azure_mgmt_search/models/search_service.rb', line 68

def provisioning_state
  @provisioning_state
end

#replica_count ⇒ Integer

specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU. Default value: 1 .

Returns:

  • (Integer) —

    The number of replicas in the Search service. If



18
19
20
 
# File 'lib/generated/azure_mgmt_search/models/search_service.rb', line 18

def replica_count
  @replica_count
end

#sku ⇒ Sku

tier and capacity limits.

Returns:

  • (Sku) —

    The SKU of the Search Service, which determines price



72
73
74
 
# File 'lib/generated/azure_mgmt_search/models/search_service.rb', line 72

def sku
  @sku
end

#status ⇒ SearchServiceStatus

Possible values include: ‘running’: The Search service is running and no provisioning operations are underway. ‘provisioning’: The Search service is being provisioned or scaled up or down. ‘deleting’: The Search service is being deleted. ‘degraded’: The Search service is degraded. This can occur when the underlying search units are not healthy. The Search service is most likely operational, but performance might be slow and some requests might be dropped. ‘disabled’: The Search service is disabled. In this state, the service will reject all API requests. ‘error’: The Search service is in an error state. If your service is in the degraded, disabled, or error states, it means the Azure Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned. Possible values include: ‘running’, ‘provisioning’, ‘deleting’, ‘degraded’, ‘disabled’, ‘error’

Returns:



51
52
53
 
# File 'lib/generated/azure_mgmt_search/models/search_service.rb', line 51

def status
  @status
end

#status_details ⇒ String

Returns The details of the Search service status.

Returns:

  • (String) —

    The details of the Search service status.



54
55
56
 
# File 'lib/generated/azure_mgmt_search/models/search_service.rb', line 54

def status_details
  @status_details
end

Class Method Details

.mapper ⇒ Object

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



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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/generated/azure_mgmt_search/models/search_service.rb', line 79

def self.mapper()
  {
    required: false,
    serialized_name: 'SearchService',
    type: {
      name: 'Composite',
      class_name: 'SearchService',
      model_properties: {
        id: {
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        location: {
          required: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        replica_count: {
          required: false,
          serialized_name: 'properties.replicaCount',
          default_value: 1,
          constraints: {
            InclusiveMaximum: 12,
            InclusiveMinimum: 1
          },
          type: {
            name: 'Number'
          }
        },
        partition_count: {
          required: false,
          serialized_name: 'properties.partitionCount',
          default_value: 1,
          constraints: {
            InclusiveMaximum: 12,
            InclusiveMinimum: 1
          },
          type: {
            name: 'Number'
          }
        },
        hosting_mode: {
          required: false,
          serialized_name: 'properties.hostingMode',
          default_value: 'default',
          type: {
            name: 'Enum',
            module: 'HostingMode'
          }
        },
        status: {
          required: false,
          read_only: true,
          serialized_name: 'properties.status',
          type: {
            name: 'Enum',
            module: 'SearchServiceStatus'
          }
        },
        status_details: {
          required: false,
          read_only: true,
          serialized_name: 'properties.statusDetails',
          type: {
            name: 'String'
          }
        },
        provisioning_state: {
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'Enum',
            module: 'ProvisioningState'
          }
        },
        sku: {
          required: true,
          serialized_name: 'sku',
          type: {
            name: 'Composite',
            class_name: 'Sku'
          }
        }
      }
    }
  }
end