Class IoTHubStreamInputDataSource
- java.lang.Object
-
- com.azure.resourcemanager.streamanalytics.models.StreamInputDataSource
-
- com.azure.resourcemanager.streamanalytics.models.IoTHubStreamInputDataSource
-
public final class IoTHubStreamInputDataSource extends StreamInputDataSource
Describes an IoT Hub input data source that contains stream data.
-
-
Constructor Summary
Constructors Constructor Description IoTHubStreamInputDataSource()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
consumerGroupName()
Get the consumerGroupName property: The name of an IoT Hub Consumer Group that should be used to read events from the IoT Hub.String
endpoint()
Get the endpoint property: The IoT Hub endpoint to connect to (ie.String
iotHubNamespace()
Get the iotHubNamespace property: The name or the URI of the IoT Hub.String
sharedAccessPolicyKey()
Get the sharedAccessPolicyKey property: The shared access policy key for the specified shared access policy.String
sharedAccessPolicyName()
Get the sharedAccessPolicyName property: The shared access policy name for the IoT Hub.void
validate()
Validates the instance.IoTHubStreamInputDataSource
withConsumerGroupName(String consumerGroupName)
Set the consumerGroupName property: The name of an IoT Hub Consumer Group that should be used to read events from the IoT Hub.IoTHubStreamInputDataSource
withEndpoint(String endpoint)
Set the endpoint property: The IoT Hub endpoint to connect to (ie.IoTHubStreamInputDataSource
withIotHubNamespace(String iotHubNamespace)
Set the iotHubNamespace property: The name or the URI of the IoT Hub.IoTHubStreamInputDataSource
withSharedAccessPolicyKey(String sharedAccessPolicyKey)
Set the sharedAccessPolicyKey property: The shared access policy key for the specified shared access policy.IoTHubStreamInputDataSource
withSharedAccessPolicyName(String sharedAccessPolicyName)
Set the sharedAccessPolicyName property: The shared access policy name for the IoT Hub.
-
-
-
Method Detail
-
iotHubNamespace
public String iotHubNamespace()
Get the iotHubNamespace property: The name or the URI of the IoT Hub. Required on PUT (CreateOrReplace) requests.- Returns:
- the iotHubNamespace value.
-
withIotHubNamespace
public IoTHubStreamInputDataSource withIotHubNamespace(String iotHubNamespace)
Set the iotHubNamespace property: The name or the URI of the IoT Hub. Required on PUT (CreateOrReplace) requests.- Parameters:
iotHubNamespace
- the iotHubNamespace value to set.- Returns:
- the IoTHubStreamInputDataSource object itself.
-
sharedAccessPolicyName
public String sharedAccessPolicyName()
Get the sharedAccessPolicyName property: The shared access policy name for the IoT Hub. This policy must contain at least the Service connect permission. Required on PUT (CreateOrReplace) requests.- Returns:
- the sharedAccessPolicyName value.
-
withSharedAccessPolicyName
public IoTHubStreamInputDataSource withSharedAccessPolicyName(String sharedAccessPolicyName)
Set the sharedAccessPolicyName property: The shared access policy name for the IoT Hub. This policy must contain at least the Service connect permission. Required on PUT (CreateOrReplace) requests.- Parameters:
sharedAccessPolicyName
- the sharedAccessPolicyName value to set.- Returns:
- the IoTHubStreamInputDataSource object itself.
-
sharedAccessPolicyKey
public String sharedAccessPolicyKey()
Get the sharedAccessPolicyKey property: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.- Returns:
- the sharedAccessPolicyKey value.
-
withSharedAccessPolicyKey
public IoTHubStreamInputDataSource withSharedAccessPolicyKey(String sharedAccessPolicyKey)
Set the sharedAccessPolicyKey property: The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.- Parameters:
sharedAccessPolicyKey
- the sharedAccessPolicyKey value to set.- Returns:
- the IoTHubStreamInputDataSource object itself.
-
consumerGroupName
public String consumerGroupName()
Get the consumerGroupName property: The name of an IoT Hub Consumer Group that should be used to read events from the IoT Hub. If not specified, the input uses the Iot Hub’s default consumer group.- Returns:
- the consumerGroupName value.
-
withConsumerGroupName
public IoTHubStreamInputDataSource withConsumerGroupName(String consumerGroupName)
Set the consumerGroupName property: The name of an IoT Hub Consumer Group that should be used to read events from the IoT Hub. If not specified, the input uses the Iot Hub’s default consumer group.- Parameters:
consumerGroupName
- the consumerGroupName value to set.- Returns:
- the IoTHubStreamInputDataSource object itself.
-
endpoint
public String endpoint()
Get the endpoint property: The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.).- Returns:
- the endpoint value.
-
withEndpoint
public IoTHubStreamInputDataSource withEndpoint(String endpoint)
Set the endpoint property: The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.).- Parameters:
endpoint
- the endpoint value to set.- Returns:
- the IoTHubStreamInputDataSource object itself.
-
validate
public void validate()
Validates the instance.- Overrides:
validate
in classStreamInputDataSource
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-