enums.go

Documentation: github.com/Azure/azure-sdk-for-go/services/iothub/mgmt/2018-04-01/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  // EndpointHealthStatus enumerates the values for endpoint health status.
    66  type EndpointHealthStatus string
    67  
    68  const (
    69  	// Dead ...
    70  	Dead EndpointHealthStatus = "dead"
    71  	// Healthy ...
    72  	Healthy EndpointHealthStatus = "healthy"
    73  	// Unhealthy ...
    74  	Unhealthy EndpointHealthStatus = "unhealthy"
    75  	// Unknown ...
    76  	Unknown EndpointHealthStatus = "unknown"
    77  )
    78  
    79  // PossibleEndpointHealthStatusValues returns an array of possible values for the EndpointHealthStatus const type.
    80  func PossibleEndpointHealthStatusValues() []EndpointHealthStatus {
    81  	return []EndpointHealthStatus{Dead, Healthy, Unhealthy, Unknown}
    82  }
    83  
    84  // IotHubNameUnavailabilityReason enumerates the values for iot hub name unavailability reason.
    85  type IotHubNameUnavailabilityReason string
    86  
    87  const (
    88  	// AlreadyExists ...
    89  	AlreadyExists IotHubNameUnavailabilityReason = "AlreadyExists"
    90  	// Invalid ...
    91  	Invalid IotHubNameUnavailabilityReason = "Invalid"
    92  )
    93  
    94  // PossibleIotHubNameUnavailabilityReasonValues returns an array of possible values for the IotHubNameUnavailabilityReason const type.
    95  func PossibleIotHubNameUnavailabilityReasonValues() []IotHubNameUnavailabilityReason {
    96  	return []IotHubNameUnavailabilityReason{AlreadyExists, Invalid}
    97  }
    98  
    99  // IotHubScaleType enumerates the values for iot hub scale type.
   100  type IotHubScaleType string
   101  
   102  const (
   103  	// IotHubScaleTypeAutomatic ...
   104  	IotHubScaleTypeAutomatic IotHubScaleType = "Automatic"
   105  	// IotHubScaleTypeManual ...
   106  	IotHubScaleTypeManual IotHubScaleType = "Manual"
   107  	// IotHubScaleTypeNone ...
   108  	IotHubScaleTypeNone IotHubScaleType = "None"
   109  )
   110  
   111  // PossibleIotHubScaleTypeValues returns an array of possible values for the IotHubScaleType const type.
   112  func PossibleIotHubScaleTypeValues() []IotHubScaleType {
   113  	return []IotHubScaleType{IotHubScaleTypeAutomatic, IotHubScaleTypeManual, IotHubScaleTypeNone}
   114  }
   115  
   116  // IotHubSku enumerates the values for iot hub sku.
   117  type IotHubSku string
   118  
   119  const (
   120  	// B1 ...
   121  	B1 IotHubSku = "B1"
   122  	// B2 ...
   123  	B2 IotHubSku = "B2"
   124  	// B3 ...
   125  	B3 IotHubSku = "B3"
   126  	// F1 ...
   127  	F1 IotHubSku = "F1"
   128  	// S1 ...
   129  	S1 IotHubSku = "S1"
   130  	// S2 ...
   131  	S2 IotHubSku = "S2"
   132  	// S3 ...
   133  	S3 IotHubSku = "S3"
   134  )
   135  
   136  // PossibleIotHubSkuValues returns an array of possible values for the IotHubSku const type.
   137  func PossibleIotHubSkuValues() []IotHubSku {
   138  	return []IotHubSku{B1, B2, B3, F1, S1, S2, S3}
   139  }
   140  
   141  // IotHubSkuTier enumerates the values for iot hub sku tier.
   142  type IotHubSkuTier string
   143  
   144  const (
   145  	// Basic ...
   146  	Basic IotHubSkuTier = "Basic"
   147  	// Free ...
   148  	Free IotHubSkuTier = "Free"
   149  	// Standard ...
   150  	Standard IotHubSkuTier = "Standard"
   151  )
   152  
   153  // PossibleIotHubSkuTierValues returns an array of possible values for the IotHubSkuTier const type.
   154  func PossibleIotHubSkuTierValues() []IotHubSkuTier {
   155  	return []IotHubSkuTier{Basic, Free, Standard}
   156  }
   157  
   158  // IPFilterActionType enumerates the values for ip filter action type.
   159  type IPFilterActionType string
   160  
   161  const (
   162  	// Accept ...
   163  	Accept IPFilterActionType = "Accept"
   164  	// Reject ...
   165  	Reject IPFilterActionType = "Reject"
   166  )
   167  
   168  // PossibleIPFilterActionTypeValues returns an array of possible values for the IPFilterActionType const type.
   169  func PossibleIPFilterActionTypeValues() []IPFilterActionType {
   170  	return []IPFilterActionType{Accept, Reject}
   171  }
   172  
   173  // JobStatus enumerates the values for job status.
   174  type JobStatus string
   175  
   176  const (
   177  	// JobStatusCancelled ...
   178  	JobStatusCancelled JobStatus = "cancelled"
   179  	// JobStatusCompleted ...
   180  	JobStatusCompleted JobStatus = "completed"
   181  	// JobStatusEnqueued ...
   182  	JobStatusEnqueued JobStatus = "enqueued"
   183  	// JobStatusFailed ...
   184  	JobStatusFailed JobStatus = "failed"
   185  	// JobStatusRunning ...
   186  	JobStatusRunning JobStatus = "running"
   187  	// JobStatusUnknown ...
   188  	JobStatusUnknown JobStatus = "unknown"
   189  )
   190  
   191  // PossibleJobStatusValues returns an array of possible values for the JobStatus const type.
   192  func PossibleJobStatusValues() []JobStatus {
   193  	return []JobStatus{JobStatusCancelled, JobStatusCompleted, JobStatusEnqueued, JobStatusFailed, JobStatusRunning, JobStatusUnknown}
   194  }
   195  
   196  // JobType enumerates the values for job type.
   197  type JobType string
   198  
   199  const (
   200  	// JobTypeBackup ...
   201  	JobTypeBackup JobType = "backup"
   202  	// JobTypeExport ...
   203  	JobTypeExport JobType = "export"
   204  	// JobTypeFactoryResetDevice ...
   205  	JobTypeFactoryResetDevice JobType = "factoryResetDevice"
   206  	// JobTypeFirmwareUpdate ...
   207  	JobTypeFirmwareUpdate JobType = "firmwareUpdate"
   208  	// JobTypeImport ...
   209  	JobTypeImport JobType = "import"
   210  	// JobTypeReadDeviceProperties ...
   211  	JobTypeReadDeviceProperties JobType = "readDeviceProperties"
   212  	// JobTypeRebootDevice ...
   213  	JobTypeRebootDevice JobType = "rebootDevice"
   214  	// JobTypeUnknown ...
   215  	JobTypeUnknown JobType = "unknown"
   216  	// JobTypeUpdateDeviceConfiguration ...
   217  	JobTypeUpdateDeviceConfiguration JobType = "updateDeviceConfiguration"
   218  	// JobTypeWriteDeviceProperties ...
   219  	JobTypeWriteDeviceProperties JobType = "writeDeviceProperties"
   220  )
   221  
   222  // PossibleJobTypeValues returns an array of possible values for the JobType const type.
   223  func PossibleJobTypeValues() []JobType {
   224  	return []JobType{JobTypeBackup, JobTypeExport, JobTypeFactoryResetDevice, JobTypeFirmwareUpdate, JobTypeImport, JobTypeReadDeviceProperties, JobTypeRebootDevice, JobTypeUnknown, JobTypeUpdateDeviceConfiguration, JobTypeWriteDeviceProperties}
   225  }
   226  
   227  // OperationMonitoringLevel enumerates the values for operation monitoring level.
   228  type OperationMonitoringLevel string
   229  
   230  const (
   231  	// OperationMonitoringLevelError ...
   232  	OperationMonitoringLevelError OperationMonitoringLevel = "Error"
   233  	// OperationMonitoringLevelErrorInformation ...
   234  	OperationMonitoringLevelErrorInformation OperationMonitoringLevel = "Error, Information"
   235  	// OperationMonitoringLevelInformation ...
   236  	OperationMonitoringLevelInformation OperationMonitoringLevel = "Information"
   237  	// OperationMonitoringLevelNone ...
   238  	OperationMonitoringLevelNone OperationMonitoringLevel = "None"
   239  )
   240  
   241  // PossibleOperationMonitoringLevelValues returns an array of possible values for the OperationMonitoringLevel const type.
   242  func PossibleOperationMonitoringLevelValues() []OperationMonitoringLevel {
   243  	return []OperationMonitoringLevel{OperationMonitoringLevelError, OperationMonitoringLevelErrorInformation, OperationMonitoringLevelInformation, OperationMonitoringLevelNone}
   244  }
   245  
   246  // RouteErrorSeverity enumerates the values for route error severity.
   247  type RouteErrorSeverity string
   248  
   249  const (
   250  	// Error ...
   251  	Error RouteErrorSeverity = "error"
   252  	// Warning ...
   253  	Warning RouteErrorSeverity = "warning"
   254  )
   255  
   256  // PossibleRouteErrorSeverityValues returns an array of possible values for the RouteErrorSeverity const type.
   257  func PossibleRouteErrorSeverityValues() []RouteErrorSeverity {
   258  	return []RouteErrorSeverity{Error, Warning}
   259  }
   260  
   261  // RoutingSource enumerates the values for routing source.
   262  type RoutingSource string
   263  
   264  const (
   265  	// RoutingSourceDeviceJobLifecycleEvents ...
   266  	RoutingSourceDeviceJobLifecycleEvents RoutingSource = "DeviceJobLifecycleEvents"
   267  	// RoutingSourceDeviceLifecycleEvents ...
   268  	RoutingSourceDeviceLifecycleEvents RoutingSource = "DeviceLifecycleEvents"
   269  	// RoutingSourceDeviceMessages ...
   270  	RoutingSourceDeviceMessages RoutingSource = "DeviceMessages"
   271  	// RoutingSourceInvalid ...
   272  	RoutingSourceInvalid RoutingSource = "Invalid"
   273  	// RoutingSourceTwinChangeEvents ...
   274  	RoutingSourceTwinChangeEvents RoutingSource = "TwinChangeEvents"
   275  )
   276  
   277  // PossibleRoutingSourceValues returns an array of possible values for the RoutingSource const type.
   278  func PossibleRoutingSourceValues() []RoutingSource {
   279  	return []RoutingSource{RoutingSourceDeviceJobLifecycleEvents, RoutingSourceDeviceLifecycleEvents, RoutingSourceDeviceMessages, RoutingSourceInvalid, RoutingSourceTwinChangeEvents}
   280  }
   281  
   282  // TestResultStatus enumerates the values for test result status.
   283  type TestResultStatus string
   284  
   285  const (
   286  	// False ...
   287  	False TestResultStatus = "false"
   288  	// True ...
   289  	True TestResultStatus = "true"
   290  	// Undefined ...
   291  	Undefined TestResultStatus = "undefined"
   292  )
   293  
   294  // PossibleTestResultStatusValues returns an array of possible values for the TestResultStatus const type.
   295  func PossibleTestResultStatusValues() []TestResultStatus {
   296  	return []TestResultStatus{False, True, Undefined}
   297  }
   298
View as plain text