Class EventHubEventSourceCreateOrUpdateParameters
java.lang.Object
com.azure.resourcemanager.timeseriesinsights.models.CreateOrUpdateTrackedResourceProperties
com.azure.resourcemanager.timeseriesinsights.models.EventSourceCreateOrUpdateParameters
com.azure.resourcemanager.timeseriesinsights.models.EventHubEventSourceCreateOrUpdateParameters
public final class EventHubEventSourceCreateOrUpdateParameters
extends EventSourceCreateOrUpdateParameters
Parameters supplied to the Create or Update Event Source operation for an EventHub event source.
-
Constructor Summary
ConstructorDescriptionCreates an instance of EventHubEventSourceCreateOrUpdateParameters class. -
Method Summary
Modifier and TypeMethodDescriptionGet the consumerGroupName property: The name of the event hub's consumer group that holds the partitions from which events will be read.Get the creationTime property: The time the resource was created.Get the eventHubName property: The name of the event hub.Get the eventSourceResourceId property: The resource id of the event source in Azure Resource Manager.keyName()
Get the keyName property: The name of the SAS key that grants the Time Series Insights service access to the event hub.Get the localTimestamp property: An object that represents the local timestamp property.Get the provisioningState property: Provisioning state of the resource.Get the serviceBusNamespace property: The name of the service bus that contains the event hub.Get the sharedAccessKey property: The value of the shared access key that grants the Time Series Insights service read access to the event hub.time()
Get the time property: ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed.Get the timestampPropertyName property: The event property that will be used as the event source's timestamp.type()
Get the type property: The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".void
validate()
Validates the instance.withConsumerGroupName
(String consumerGroupName) Set the consumerGroupName property: The name of the event hub's consumer group that holds the partitions from which events will be read.withEventHubName
(String eventHubName) Set the eventHubName property: The name of the event hub.withEventSourceResourceId
(String eventSourceResourceId) Set the eventSourceResourceId property: The resource id of the event source in Azure Resource Manager.withKeyName
(String keyName) Set the keyName property: The name of the SAS key that grants the Time Series Insights service access to the event hub.withLocalTimestamp
(LocalTimestamp localTimestamp) Set the localTimestamp property: An object that represents the local timestamp property.withLocalTimestampPropertiesLocalTimestamp
(LocalTimestamp localTimestamp) Set the localTimestamp property: An object that represents the local timestamp property.withLocation
(String location) Set the location property: The location of the resource.withServiceBusNamespace
(String serviceBusNamespace) Set the serviceBusNamespace property: The name of the service bus that contains the event hub.withSharedAccessKey
(String sharedAccessKey) Set the sharedAccessKey property: The value of the shared access key that grants the Time Series Insights service read access to the event hub.Set the tags property: Key-value pairs of additional properties for the resource.Set the time property: ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed.withTimestampPropertyName
(String timestampPropertyName) Set the timestampPropertyName property: The event property that will be used as the event source's timestamp.withType
(IngressStartAtType type) Set the type property: The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".Methods inherited from class com.azure.resourcemanager.timeseriesinsights.models.EventSourceCreateOrUpdateParameters
localTimestamp
Methods inherited from class com.azure.resourcemanager.timeseriesinsights.models.CreateOrUpdateTrackedResourceProperties
location, tags
-
Constructor Details
-
EventHubEventSourceCreateOrUpdateParameters
public EventHubEventSourceCreateOrUpdateParameters()Creates an instance of EventHubEventSourceCreateOrUpdateParameters class.
-
-
Method Details
-
withLocalTimestamp
public EventHubEventSourceCreateOrUpdateParameters withLocalTimestamp(LocalTimestamp localTimestamp) Set the localTimestamp property: An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.- Overrides:
withLocalTimestamp
in classEventSourceCreateOrUpdateParameters
- Parameters:
localTimestamp
- the localTimestamp value to set.- Returns:
- the EventSourceCreateOrUpdateParameters object itself.
-
withLocation
Set the location property: The location of the resource.- Overrides:
withLocation
in classEventSourceCreateOrUpdateParameters
- Parameters:
location
- the location value to set.- Returns:
- the CreateOrUpdateTrackedResourceProperties object itself.
-
withTags
Set the tags property: Key-value pairs of additional properties for the resource.- Overrides:
withTags
in classEventSourceCreateOrUpdateParameters
- Parameters:
tags
- the tags value to set.- Returns:
- the CreateOrUpdateTrackedResourceProperties object itself.
-
serviceBusNamespace
Get the serviceBusNamespace property: The name of the service bus that contains the event hub.- Returns:
- the serviceBusNamespace value.
-
withServiceBusNamespace
public EventHubEventSourceCreateOrUpdateParameters withServiceBusNamespace(String serviceBusNamespace) Set the serviceBusNamespace property: The name of the service bus that contains the event hub.- Parameters:
serviceBusNamespace
- the serviceBusNamespace value to set.- Returns:
- the EventHubEventSourceCreateOrUpdateParameters object itself.
-
eventHubName
Get the eventHubName property: The name of the event hub.- Returns:
- the eventHubName value.
-
withEventHubName
Set the eventHubName property: The name of the event hub.- Parameters:
eventHubName
- the eventHubName value to set.- Returns:
- the EventHubEventSourceCreateOrUpdateParameters object itself.
-
consumerGroupName
Get the consumerGroupName property: The name of the event hub's consumer group that holds the partitions from which events will be read.- Returns:
- the consumerGroupName value.
-
withConsumerGroupName
Set the consumerGroupName property: The name of the event hub's consumer group that holds the partitions from which events will be read.- Parameters:
consumerGroupName
- the consumerGroupName value to set.- Returns:
- the EventHubEventSourceCreateOrUpdateParameters object itself.
-
keyName
Get the keyName property: The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub.- Returns:
- the keyName value.
-
withKeyName
Set the keyName property: The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub.- Parameters:
keyName
- the keyName value to set.- Returns:
- the EventHubEventSourceCreateOrUpdateParameters object itself.
-
eventSourceResourceId
Get the eventSourceResourceId property: The resource id of the event source in Azure Resource Manager.- Returns:
- the eventSourceResourceId value.
-
withEventSourceResourceId
public EventHubEventSourceCreateOrUpdateParameters withEventSourceResourceId(String eventSourceResourceId) Set the eventSourceResourceId property: The resource id of the event source in Azure Resource Manager.- Parameters:
eventSourceResourceId
- the eventSourceResourceId value to set.- Returns:
- the EventHubEventSourceCreateOrUpdateParameters object itself.
-
timestampPropertyName
Get the timestampPropertyName property: The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used.- Returns:
- the timestampPropertyName value.
-
withTimestampPropertyName
public EventHubEventSourceCreateOrUpdateParameters withTimestampPropertyName(String timestampPropertyName) Set the timestampPropertyName property: The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used.- Parameters:
timestampPropertyName
- the timestampPropertyName value to set.- Returns:
- the EventHubEventSourceCreateOrUpdateParameters object itself.
-
localTimestampPropertiesLocalTimestamp
Get the localTimestamp property: An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.- Returns:
- the localTimestamp value.
-
withLocalTimestampPropertiesLocalTimestamp
public EventHubEventSourceCreateOrUpdateParameters withLocalTimestampPropertiesLocalTimestamp(LocalTimestamp localTimestamp) Set the localTimestamp property: An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.- Parameters:
localTimestamp
- the localTimestamp value to set.- Returns:
- the EventHubEventSourceCreateOrUpdateParameters object itself.
-
type
Get the type property: The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".- Returns:
- the type value.
-
withType
Set the type property: The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime".- Parameters:
type
- the type value to set.- Returns:
- the EventHubEventSourceCreateOrUpdateParameters object itself.
-
time
Get the time property: ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed.- Returns:
- the time value.
-
withTime
Set the time property: ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed.- Parameters:
time
- the time value to set.- Returns:
- the EventHubEventSourceCreateOrUpdateParameters object itself.
-
provisioningState
Get the provisioningState property: Provisioning state of the resource.- Returns:
- the provisioningState value.
-
creationTime
Get the creationTime property: The time the resource was created.- Returns:
- the creationTime value.
-
validate
public void validate()Validates the instance.- Overrides:
validate
in classEventSourceCreateOrUpdateParameters
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-