enums.go

Documentation: github.com/Azure/azure-sdk-for-go/services/preview/iothub/mgmt/2019-07-01-preview/devices

     1  package devices
     2  
     3  // Copyright (c) Microsoft Corporation. All rights reserved.
     4  // Licensed under the MIT License. See License.txt in the project root for license information.
     5  //
     6  // Code generated by Microsoft (R) AutoRest Code Generator.
     7  // Changes may cause incorrect behavior and will be lost if the code is regenerated.
     8  
     9  // AccessRights enumerates the values for access rights.
    10  type AccessRights string
    11  
    12  const (
    13  	// DeviceConnect ...
    14  	DeviceConnect AccessRights = "DeviceConnect"
    15  	// RegistryRead ...
    16  	RegistryRead AccessRights = "RegistryRead"
    17  	// RegistryReadDeviceConnect ...
    18  	RegistryReadDeviceConnect AccessRights = "RegistryRead, DeviceConnect"
    19  	// RegistryReadRegistryWrite ...
    20  	RegistryReadRegistryWrite AccessRights = "RegistryRead, RegistryWrite"
    21  	// RegistryReadRegistryWriteDeviceConnect ...
    22  	RegistryReadRegistryWriteDeviceConnect AccessRights = "RegistryRead, RegistryWrite, DeviceConnect"
    23  	// RegistryReadRegistryWriteServiceConnect ...
    24  	RegistryReadRegistryWriteServiceConnect AccessRights = "RegistryRead, RegistryWrite, ServiceConnect"
    25  	// RegistryReadRegistryWriteServiceConnectDeviceConnect ...
    26  	RegistryReadRegistryWriteServiceConnectDeviceConnect AccessRights = "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect"
    27  	// RegistryReadServiceConnect ...
    28  	RegistryReadServiceConnect AccessRights = "RegistryRead, ServiceConnect"
    29  	// RegistryReadServiceConnectDeviceConnect ...
    30  	RegistryReadServiceConnectDeviceConnect AccessRights = "RegistryRead, ServiceConnect, DeviceConnect"
    31  	// RegistryWrite ...
    32  	RegistryWrite AccessRights = "RegistryWrite"
    33  	// RegistryWriteDeviceConnect ...
    34  	RegistryWriteDeviceConnect AccessRights = "RegistryWrite, DeviceConnect"
    35  	// RegistryWriteServiceConnect ...
    36  	RegistryWriteServiceConnect AccessRights = "RegistryWrite, ServiceConnect"
    37  	// RegistryWriteServiceConnectDeviceConnect ...
    38  	RegistryWriteServiceConnectDeviceConnect AccessRights = "RegistryWrite, ServiceConnect, DeviceConnect"
    39  	// ServiceConnect ...
    40  	ServiceConnect AccessRights = "ServiceConnect"
    41  	// ServiceConnectDeviceConnect ...
    42  	ServiceConnectDeviceConnect AccessRights = "ServiceConnect, DeviceConnect"
    43  )
    44  
    45  // PossibleAccessRightsValues returns an array of possible values for the AccessRights const type.
    46  func PossibleAccessRightsValues() []AccessRights {
    47  	return []AccessRights{DeviceConnect, RegistryRead, RegistryReadDeviceConnect, RegistryReadRegistryWrite, RegistryReadRegistryWriteDeviceConnect, RegistryReadRegistryWriteServiceConnect, RegistryReadRegistryWriteServiceConnectDeviceConnect, RegistryReadServiceConnect, RegistryReadServiceConnectDeviceConnect, RegistryWrite, RegistryWriteDeviceConnect, RegistryWriteServiceConnect, RegistryWriteServiceConnectDeviceConnect, ServiceConnect, ServiceConnectDeviceConnect}
    48  }
    49  
    50  // Capabilities enumerates the values for capabilities.
    51  type Capabilities string
    52  
    53  const (
    54  	// DeviceManagement ...
    55  	DeviceManagement Capabilities = "DeviceManagement"
    56  	// None ...
    57  	None Capabilities = "None"
    58  )
    59  
    60  // PossibleCapabilitiesValues returns an array of possible values for the Capabilities const type.
    61  func PossibleCapabilitiesValues() []Capabilities {
    62  	return []Capabilities{DeviceManagement, None}
    63  }
    64  
    65  // Encoding enumerates the values for encoding.
    66  type Encoding string
    67  
    68  const (
    69  	// Avro ...
    70  	Avro Encoding = "Avro"
    71  	// AvroDeflate ...
    72  	AvroDeflate Encoding = "AvroDeflate"
    73  	// JSON ...
    74  	JSON Encoding = "JSON"
    75  )
    76  
    77  // PossibleEncodingValues returns an array of possible values for the Encoding const type.
    78  func PossibleEncodingValues() []Encoding {
    79  	return []Encoding{Avro, AvroDeflate, JSON}
    80  }
    81  
    82  // EndpointHealthStatus enumerates the values for endpoint health status.
    83  type EndpointHealthStatus string
    84  
    85  const (
    86  	// Dead ...
    87  	Dead EndpointHealthStatus = "dead"
    88  	// Healthy ...
    89  	Healthy EndpointHealthStatus = "healthy"
    90  	// Unhealthy ...
    91  	Unhealthy EndpointHealthStatus = "unhealthy"
    92  	// Unknown ...
    93  	Unknown EndpointHealthStatus = "unknown"
    94  )
    95  
    96  // PossibleEndpointHealthStatusValues returns an array of possible values for the EndpointHealthStatus const type.
    97  func PossibleEndpointHealthStatusValues() []EndpointHealthStatus {
    98  	return []EndpointHealthStatus{Dead, Healthy, Unhealthy, Unknown}
    99  }
   100  
   101  // IotHubNameUnavailabilityReason enumerates the values for iot hub name unavailability reason.
   102  type IotHubNameUnavailabilityReason string
   103  
   104  const (
   105  	// AlreadyExists ...
   106  	AlreadyExists IotHubNameUnavailabilityReason = "AlreadyExists"
   107  	// Invalid ...
   108  	Invalid IotHubNameUnavailabilityReason = "Invalid"
   109  )
   110  
   111  // PossibleIotHubNameUnavailabilityReasonValues returns an array of possible values for the IotHubNameUnavailabilityReason const type.
   112  func PossibleIotHubNameUnavailabilityReasonValues() []IotHubNameUnavailabilityReason {
   113  	return []IotHubNameUnavailabilityReason{AlreadyExists, Invalid}
   114  }
   115  
   116  // IotHubReplicaRoleType enumerates the values for iot hub replica role type.
   117  type IotHubReplicaRoleType string
   118  
   119  const (
   120  	// Primary ...
   121  	Primary IotHubReplicaRoleType = "primary"
   122  	// Secondary ...
   123  	Secondary IotHubReplicaRoleType = "secondary"
   124  )
   125  
   126  // PossibleIotHubReplicaRoleTypeValues returns an array of possible values for the IotHubReplicaRoleType const type.
   127  func PossibleIotHubReplicaRoleTypeValues() []IotHubReplicaRoleType {
   128  	return []IotHubReplicaRoleType{Primary, Secondary}
   129  }
   130  
   131  // IotHubScaleType enumerates the values for iot hub scale type.
   132  type IotHubScaleType string
   133  
   134  const (
   135  	// IotHubScaleTypeAutomatic ...
   136  	IotHubScaleTypeAutomatic IotHubScaleType = "Automatic"
   137  	// IotHubScaleTypeManual ...
   138  	IotHubScaleTypeManual IotHubScaleType = "Manual"
   139  	// IotHubScaleTypeNone ...
   140  	IotHubScaleTypeNone IotHubScaleType = "None"
   141  )
   142  
   143  // PossibleIotHubScaleTypeValues returns an array of possible values for the IotHubScaleType const type.
   144  func PossibleIotHubScaleTypeValues() []IotHubScaleType {
   145  	return []IotHubScaleType{IotHubScaleTypeAutomatic, IotHubScaleTypeManual, IotHubScaleTypeNone}
   146  }
   147  
   148  // IotHubSku enumerates the values for iot hub sku.
   149  type IotHubSku string
   150  
   151  const (
   152  	// B1 ...
   153  	B1 IotHubSku = "B1"
   154  	// B2 ...
   155  	B2 IotHubSku = "B2"
   156  	// B3 ...
   157  	B3 IotHubSku = "B3"
   158  	// F1 ...
   159  	F1 IotHubSku = "F1"
   160  	// S1 ...
   161  	S1 IotHubSku = "S1"
   162  	// S2 ...
   163  	S2 IotHubSku = "S2"
   164  	// S3 ...
   165  	S3 IotHubSku = "S3"
   166  )
   167  
   168  // PossibleIotHubSkuValues returns an array of possible values for the IotHubSku const type.
   169  func PossibleIotHubSkuValues() []IotHubSku {
   170  	return []IotHubSku{B1, B2, B3, F1, S1, S2, S3}
   171  }
   172  
   173  // IotHubSkuTier enumerates the values for iot hub sku tier.
   174  type IotHubSkuTier string
   175  
   176  const (
   177  	// Basic ...
   178  	Basic IotHubSkuTier = "Basic"
   179  	// Free ...
   180  	Free IotHubSkuTier = "Free"
   181  	// Standard ...
   182  	Standard IotHubSkuTier = "Standard"
   183  )
   184  
   185  // PossibleIotHubSkuTierValues returns an array of possible values for the IotHubSkuTier const type.
   186  func PossibleIotHubSkuTierValues() []IotHubSkuTier {
   187  	return []IotHubSkuTier{Basic, Free, Standard}
   188  }
   189  
   190  // IPFilterActionType enumerates the values for ip filter action type.
   191  type IPFilterActionType string
   192  
   193  const (
   194  	// Accept ...
   195  	Accept IPFilterActionType = "Accept"
   196  	// Reject ...
   197  	Reject IPFilterActionType = "Reject"
   198  )
   199  
   200  // PossibleIPFilterActionTypeValues returns an array of possible values for the IPFilterActionType const type.
   201  func PossibleIPFilterActionTypeValues() []IPFilterActionType {
   202  	return []IPFilterActionType{Accept, Reject}
   203  }
   204  
   205  // JobStatus enumerates the values for job status.
   206  type JobStatus string
   207  
   208  const (
   209  	// JobStatusCancelled ...
   210  	JobStatusCancelled JobStatus = "cancelled"
   211  	// JobStatusCompleted ...
   212  	JobStatusCompleted JobStatus = "completed"
   213  	// JobStatusEnqueued ...
   214  	JobStatusEnqueued JobStatus = "enqueued"
   215  	// JobStatusFailed ...
   216  	JobStatusFailed JobStatus = "failed"
   217  	// JobStatusRunning ...
   218  	JobStatusRunning JobStatus = "running"
   219  	// JobStatusUnknown ...
   220  	JobStatusUnknown JobStatus = "unknown"
   221  )
   222  
   223  // PossibleJobStatusValues returns an array of possible values for the JobStatus const type.
   224  func PossibleJobStatusValues() []JobStatus {
   225  	return []JobStatus{JobStatusCancelled, JobStatusCompleted, JobStatusEnqueued, JobStatusFailed, JobStatusRunning, JobStatusUnknown}
   226  }
   227  
   228  // JobType enumerates the values for job type.
   229  type JobType string
   230  
   231  const (
   232  	// JobTypeBackup ...
   233  	JobTypeBackup JobType = "backup"
   234  	// JobTypeExport ...
   235  	JobTypeExport JobType = "export"
   236  	// JobTypeFactoryResetDevice ...
   237  	JobTypeFactoryResetDevice JobType = "factoryResetDevice"
   238  	// JobTypeFirmwareUpdate ...
   239  	JobTypeFirmwareUpdate JobType = "firmwareUpdate"
   240  	// JobTypeImport ...
   241  	JobTypeImport JobType = "import"
   242  	// JobTypeReadDeviceProperties ...
   243  	JobTypeReadDeviceProperties JobType = "readDeviceProperties"
   244  	// JobTypeRebootDevice ...
   245  	JobTypeRebootDevice JobType = "rebootDevice"
   246  	// JobTypeUnknown ...
   247  	JobTypeUnknown JobType = "unknown"
   248  	// JobTypeUpdateDeviceConfiguration ...
   249  	JobTypeUpdateDeviceConfiguration JobType = "updateDeviceConfiguration"
   250  	// JobTypeWriteDeviceProperties ...
   251  	JobTypeWriteDeviceProperties JobType = "writeDeviceProperties"
   252  )
   253  
   254  // PossibleJobTypeValues returns an array of possible values for the JobType const type.
   255  func PossibleJobTypeValues() []JobType {
   256  	return []JobType{JobTypeBackup, JobTypeExport, JobTypeFactoryResetDevice, JobTypeFirmwareUpdate, JobTypeImport, JobTypeReadDeviceProperties, JobTypeRebootDevice, JobTypeUnknown, JobTypeUpdateDeviceConfiguration, JobTypeWriteDeviceProperties}
   257  }
   258  
   259  // RouteErrorSeverity enumerates the values for route error severity.
   260  type RouteErrorSeverity string
   261  
   262  const (
   263  	// Error ...
   264  	Error RouteErrorSeverity = "error"
   265  	// Warning ...
   266  	Warning RouteErrorSeverity = "warning"
   267  )
   268  
   269  // PossibleRouteErrorSeverityValues returns an array of possible values for the RouteErrorSeverity const type.
   270  func PossibleRouteErrorSeverityValues() []RouteErrorSeverity {
   271  	return []RouteErrorSeverity{Error, Warning}
   272  }
   273  
   274  // RoutingSource enumerates the values for routing source.
   275  type RoutingSource string
   276  
   277  const (
   278  	// RoutingSourceDeviceJobLifecycleEvents ...
   279  	RoutingSourceDeviceJobLifecycleEvents RoutingSource = "DeviceJobLifecycleEvents"
   280  	// RoutingSourceDeviceLifecycleEvents ...
   281  	RoutingSourceDeviceLifecycleEvents RoutingSource = "DeviceLifecycleEvents"
   282  	// RoutingSourceDeviceMessages ...
   283  	RoutingSourceDeviceMessages RoutingSource = "DeviceMessages"
   284  	// RoutingSourceDigitalTwinChangeEvents ...
   285  	RoutingSourceDigitalTwinChangeEvents RoutingSource = "DigitalTwinChangeEvents"
   286  	// RoutingSourceInvalid ...
   287  	RoutingSourceInvalid RoutingSource = "Invalid"
   288  	// RoutingSourceTwinChangeEvents ...
   289  	RoutingSourceTwinChangeEvents RoutingSource = "TwinChangeEvents"
   290  )
   291  
   292  // PossibleRoutingSourceValues returns an array of possible values for the RoutingSource const type.
   293  func PossibleRoutingSourceValues() []RoutingSource {
   294  	return []RoutingSource{RoutingSourceDeviceJobLifecycleEvents, RoutingSourceDeviceLifecycleEvents, RoutingSourceDeviceMessages, RoutingSourceDigitalTwinChangeEvents, RoutingSourceInvalid, RoutingSourceTwinChangeEvents}
   295  }
   296  
   297  // TestResultStatus enumerates the values for test result status.
   298  type TestResultStatus string
   299  
   300  const (
   301  	// False ...
   302  	False TestResultStatus = "false"
   303  	// True ...
   304  	True TestResultStatus = "true"
   305  	// Undefined ...
   306  	Undefined TestResultStatus = "undefined"
   307  )
   308  
   309  // PossibleTestResultStatusValues returns an array of possible values for the TestResultStatus const type.
   310  func PossibleTestResultStatusValues() []TestResultStatus {
   311  	return []TestResultStatus{False, True, Undefined}
   312  }
   313
View as plain text