enums.go

Documentation: github.com/Azure/azure-sdk-for-go/services/iothub/mgmt/2020-03-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  // AuthenticationType enumerates the values for authentication type.
    51  type AuthenticationType string
    52  
    53  const (
    54  	// IdentityBased ...
    55  	IdentityBased AuthenticationType = "identityBased"
    56  	// KeyBased ...
    57  	KeyBased AuthenticationType = "keyBased"
    58  )
    59  
    60  // PossibleAuthenticationTypeValues returns an array of possible values for the AuthenticationType const type.
    61  func PossibleAuthenticationTypeValues() []AuthenticationType {
    62  	return []AuthenticationType{IdentityBased, KeyBased}
    63  }
    64  
    65  // Capabilities enumerates the values for capabilities.
    66  type Capabilities string
    67  
    68  const (
    69  	// DeviceManagement ...
    70  	DeviceManagement Capabilities = "DeviceManagement"
    71  	// None ...
    72  	None Capabilities = "None"
    73  )
    74  
    75  // PossibleCapabilitiesValues returns an array of possible values for the Capabilities const type.
    76  func PossibleCapabilitiesValues() []Capabilities {
    77  	return []Capabilities{DeviceManagement, None}
    78  }
    79  
    80  // Encoding enumerates the values for encoding.
    81  type Encoding string
    82  
    83  const (
    84  	// Avro ...
    85  	Avro Encoding = "Avro"
    86  	// AvroDeflate ...
    87  	AvroDeflate Encoding = "AvroDeflate"
    88  	// JSON ...
    89  	JSON Encoding = "JSON"
    90  )
    91  
    92  // PossibleEncodingValues returns an array of possible values for the Encoding const type.
    93  func PossibleEncodingValues() []Encoding {
    94  	return []Encoding{Avro, AvroDeflate, JSON}
    95  }
    96  
    97  // EndpointHealthStatus enumerates the values for endpoint health status.
    98  type EndpointHealthStatus string
    99  
   100  const (
   101  	// Dead ...
   102  	Dead EndpointHealthStatus = "dead"
   103  	// Healthy ...
   104  	Healthy EndpointHealthStatus = "healthy"
   105  	// Unhealthy ...
   106  	Unhealthy EndpointHealthStatus = "unhealthy"
   107  	// Unknown ...
   108  	Unknown EndpointHealthStatus = "unknown"
   109  )
   110  
   111  // PossibleEndpointHealthStatusValues returns an array of possible values for the EndpointHealthStatus const type.
   112  func PossibleEndpointHealthStatusValues() []EndpointHealthStatus {
   113  	return []EndpointHealthStatus{Dead, Healthy, Unhealthy, Unknown}
   114  }
   115  
   116  // IotHubNameUnavailabilityReason enumerates the values for iot hub name unavailability reason.
   117  type IotHubNameUnavailabilityReason string
   118  
   119  const (
   120  	// AlreadyExists ...
   121  	AlreadyExists IotHubNameUnavailabilityReason = "AlreadyExists"
   122  	// Invalid ...
   123  	Invalid IotHubNameUnavailabilityReason = "Invalid"
   124  )
   125  
   126  // PossibleIotHubNameUnavailabilityReasonValues returns an array of possible values for the IotHubNameUnavailabilityReason const type.
   127  func PossibleIotHubNameUnavailabilityReasonValues() []IotHubNameUnavailabilityReason {
   128  	return []IotHubNameUnavailabilityReason{AlreadyExists, Invalid}
   129  }
   130  
   131  // IotHubReplicaRoleType enumerates the values for iot hub replica role type.
   132  type IotHubReplicaRoleType string
   133  
   134  const (
   135  	// Primary ...
   136  	Primary IotHubReplicaRoleType = "primary"
   137  	// Secondary ...
   138  	Secondary IotHubReplicaRoleType = "secondary"
   139  )
   140  
   141  // PossibleIotHubReplicaRoleTypeValues returns an array of possible values for the IotHubReplicaRoleType const type.
   142  func PossibleIotHubReplicaRoleTypeValues() []IotHubReplicaRoleType {
   143  	return []IotHubReplicaRoleType{Primary, Secondary}
   144  }
   145  
   146  // IotHubScaleType enumerates the values for iot hub scale type.
   147  type IotHubScaleType string
   148  
   149  const (
   150  	// IotHubScaleTypeAutomatic ...
   151  	IotHubScaleTypeAutomatic IotHubScaleType = "Automatic"
   152  	// IotHubScaleTypeManual ...
   153  	IotHubScaleTypeManual IotHubScaleType = "Manual"
   154  	// IotHubScaleTypeNone ...
   155  	IotHubScaleTypeNone IotHubScaleType = "None"
   156  )
   157  
   158  // PossibleIotHubScaleTypeValues returns an array of possible values for the IotHubScaleType const type.
   159  func PossibleIotHubScaleTypeValues() []IotHubScaleType {
   160  	return []IotHubScaleType{IotHubScaleTypeAutomatic, IotHubScaleTypeManual, IotHubScaleTypeNone}
   161  }
   162  
   163  // IotHubSku enumerates the values for iot hub sku.
   164  type IotHubSku string
   165  
   166  const (
   167  	// B1 ...
   168  	B1 IotHubSku = "B1"
   169  	// B2 ...
   170  	B2 IotHubSku = "B2"
   171  	// B3 ...
   172  	B3 IotHubSku = "B3"
   173  	// F1 ...
   174  	F1 IotHubSku = "F1"
   175  	// S1 ...
   176  	S1 IotHubSku = "S1"
   177  	// S2 ...
   178  	S2 IotHubSku = "S2"
   179  	// S3 ...
   180  	S3 IotHubSku = "S3"
   181  )
   182  
   183  // PossibleIotHubSkuValues returns an array of possible values for the IotHubSku const type.
   184  func PossibleIotHubSkuValues() []IotHubSku {
   185  	return []IotHubSku{B1, B2, B3, F1, S1, S2, S3}
   186  }
   187  
   188  // IotHubSkuTier enumerates the values for iot hub sku tier.
   189  type IotHubSkuTier string
   190  
   191  const (
   192  	// Basic ...
   193  	Basic IotHubSkuTier = "Basic"
   194  	// Free ...
   195  	Free IotHubSkuTier = "Free"
   196  	// Standard ...
   197  	Standard IotHubSkuTier = "Standard"
   198  )
   199  
   200  // PossibleIotHubSkuTierValues returns an array of possible values for the IotHubSkuTier const type.
   201  func PossibleIotHubSkuTierValues() []IotHubSkuTier {
   202  	return []IotHubSkuTier{Basic, Free, Standard}
   203  }
   204  
   205  // IPFilterActionType enumerates the values for ip filter action type.
   206  type IPFilterActionType string
   207  
   208  const (
   209  	// Accept ...
   210  	Accept IPFilterActionType = "Accept"
   211  	// Reject ...
   212  	Reject IPFilterActionType = "Reject"
   213  )
   214  
   215  // PossibleIPFilterActionTypeValues returns an array of possible values for the IPFilterActionType const type.
   216  func PossibleIPFilterActionTypeValues() []IPFilterActionType {
   217  	return []IPFilterActionType{Accept, Reject}
   218  }
   219  
   220  // JobStatus enumerates the values for job status.
   221  type JobStatus string
   222  
   223  const (
   224  	// JobStatusCancelled ...
   225  	JobStatusCancelled JobStatus = "cancelled"
   226  	// JobStatusCompleted ...
   227  	JobStatusCompleted JobStatus = "completed"
   228  	// JobStatusEnqueued ...
   229  	JobStatusEnqueued JobStatus = "enqueued"
   230  	// JobStatusFailed ...
   231  	JobStatusFailed JobStatus = "failed"
   232  	// JobStatusRunning ...
   233  	JobStatusRunning JobStatus = "running"
   234  	// JobStatusUnknown ...
   235  	JobStatusUnknown JobStatus = "unknown"
   236  )
   237  
   238  // PossibleJobStatusValues returns an array of possible values for the JobStatus const type.
   239  func PossibleJobStatusValues() []JobStatus {
   240  	return []JobStatus{JobStatusCancelled, JobStatusCompleted, JobStatusEnqueued, JobStatusFailed, JobStatusRunning, JobStatusUnknown}
   241  }
   242  
   243  // JobType enumerates the values for job type.
   244  type JobType string
   245  
   246  const (
   247  	// JobTypeBackup ...
   248  	JobTypeBackup JobType = "backup"
   249  	// JobTypeExport ...
   250  	JobTypeExport JobType = "export"
   251  	// JobTypeFactoryResetDevice ...
   252  	JobTypeFactoryResetDevice JobType = "factoryResetDevice"
   253  	// JobTypeFirmwareUpdate ...
   254  	JobTypeFirmwareUpdate JobType = "firmwareUpdate"
   255  	// JobTypeImport ...
   256  	JobTypeImport JobType = "import"
   257  	// JobTypeReadDeviceProperties ...
   258  	JobTypeReadDeviceProperties JobType = "readDeviceProperties"
   259  	// JobTypeRebootDevice ...
   260  	JobTypeRebootDevice JobType = "rebootDevice"
   261  	// JobTypeUnknown ...
   262  	JobTypeUnknown JobType = "unknown"
   263  	// JobTypeUpdateDeviceConfiguration ...
   264  	JobTypeUpdateDeviceConfiguration JobType = "updateDeviceConfiguration"
   265  	// JobTypeWriteDeviceProperties ...
   266  	JobTypeWriteDeviceProperties JobType = "writeDeviceProperties"
   267  )
   268  
   269  // PossibleJobTypeValues returns an array of possible values for the JobType const type.
   270  func PossibleJobTypeValues() []JobType {
   271  	return []JobType{JobTypeBackup, JobTypeExport, JobTypeFactoryResetDevice, JobTypeFirmwareUpdate, JobTypeImport, JobTypeReadDeviceProperties, JobTypeRebootDevice, JobTypeUnknown, JobTypeUpdateDeviceConfiguration, JobTypeWriteDeviceProperties}
   272  }
   273  
   274  // PrivateLinkServiceConnectionStatus enumerates the values for private link service connection status.
   275  type PrivateLinkServiceConnectionStatus string
   276  
   277  const (
   278  	// Approved ...
   279  	Approved PrivateLinkServiceConnectionStatus = "Approved"
   280  	// Disconnected ...
   281  	Disconnected PrivateLinkServiceConnectionStatus = "Disconnected"
   282  	// Pending ...
   283  	Pending PrivateLinkServiceConnectionStatus = "Pending"
   284  	// Rejected ...
   285  	Rejected PrivateLinkServiceConnectionStatus = "Rejected"
   286  )
   287  
   288  // PossiblePrivateLinkServiceConnectionStatusValues returns an array of possible values for the PrivateLinkServiceConnectionStatus const type.
   289  func PossiblePrivateLinkServiceConnectionStatusValues() []PrivateLinkServiceConnectionStatus {
   290  	return []PrivateLinkServiceConnectionStatus{Approved, Disconnected, Pending, Rejected}
   291  }
   292  
   293  // PublicNetworkAccess enumerates the values for public network access.
   294  type PublicNetworkAccess string
   295  
   296  const (
   297  	// Disabled ...
   298  	Disabled PublicNetworkAccess = "Disabled"
   299  	// Enabled ...
   300  	Enabled PublicNetworkAccess = "Enabled"
   301  )
   302  
   303  // PossiblePublicNetworkAccessValues returns an array of possible values for the PublicNetworkAccess const type.
   304  func PossiblePublicNetworkAccessValues() []PublicNetworkAccess {
   305  	return []PublicNetworkAccess{Disabled, Enabled}
   306  }
   307  
   308  // RouteErrorSeverity enumerates the values for route error severity.
   309  type RouteErrorSeverity string
   310  
   311  const (
   312  	// Error ...
   313  	Error RouteErrorSeverity = "error"
   314  	// Warning ...
   315  	Warning RouteErrorSeverity = "warning"
   316  )
   317  
   318  // PossibleRouteErrorSeverityValues returns an array of possible values for the RouteErrorSeverity const type.
   319  func PossibleRouteErrorSeverityValues() []RouteErrorSeverity {
   320  	return []RouteErrorSeverity{Error, Warning}
   321  }
   322  
   323  // RoutingSource enumerates the values for routing source.
   324  type RoutingSource string
   325  
   326  const (
   327  	// RoutingSourceDeviceJobLifecycleEvents ...
   328  	RoutingSourceDeviceJobLifecycleEvents RoutingSource = "DeviceJobLifecycleEvents"
   329  	// RoutingSourceDeviceLifecycleEvents ...
   330  	RoutingSourceDeviceLifecycleEvents RoutingSource = "DeviceLifecycleEvents"
   331  	// RoutingSourceDeviceMessages ...
   332  	RoutingSourceDeviceMessages RoutingSource = "DeviceMessages"
   333  	// RoutingSourceInvalid ...
   334  	RoutingSourceInvalid RoutingSource = "Invalid"
   335  	// RoutingSourceTwinChangeEvents ...
   336  	RoutingSourceTwinChangeEvents RoutingSource = "TwinChangeEvents"
   337  )
   338  
   339  // PossibleRoutingSourceValues returns an array of possible values for the RoutingSource const type.
   340  func PossibleRoutingSourceValues() []RoutingSource {
   341  	return []RoutingSource{RoutingSourceDeviceJobLifecycleEvents, RoutingSourceDeviceLifecycleEvents, RoutingSourceDeviceMessages, RoutingSourceInvalid, RoutingSourceTwinChangeEvents}
   342  }
   343  
   344  // TestResultStatus enumerates the values for test result status.
   345  type TestResultStatus string
   346  
   347  const (
   348  	// False ...
   349  	False TestResultStatus = "false"
   350  	// True ...
   351  	True TestResultStatus = "true"
   352  	// Undefined ...
   353  	Undefined TestResultStatus = "undefined"
   354  )
   355  
   356  // PossibleTestResultStatusValues returns an array of possible values for the TestResultStatus const type.
   357  func PossibleTestResultStatusValues() []TestResultStatus {
   358  	return []TestResultStatus{False, True, Undefined}
   359  }
   360
View as plain text