Package com.azure.resourcemanager.streamanalytics.fluent.models

Class StreamingJobInner

  • public final class StreamingJobInner
extends com.azure.core.management.Resource
    A streaming job object, containing all information associated with the named streaming job.

    • Constructor Detail

      • StreamingJobInner

        public StreamingJobInner()

    • Method Detail

      • identity

        public Identity identity()
        Get the identity property: Describes the system-assigned managed identity assigned to this job that can be used to authenticate with inputs and outputs.
        Returns:
        the identity value.

      • withIdentity

        public StreamingJobInner withIdentity​(Identity identity)
        Set the identity property: Describes the system-assigned managed identity assigned to this job that can be used to authenticate with inputs and outputs.
        Parameters:
        identity - the identity value to set.
        Returns:
        the StreamingJobInner object itself.

      • withLocation

        public StreamingJobInner withLocation​(String location)
        Overrides:
        withLocation in class com.azure.core.management.Resource

      • sku

        public Sku sku()
        Get the sku property: Describes the SKU of the streaming job. Required on PUT (CreateOrReplace) requests.
        Returns:
        the sku value.

      • withSku

        public StreamingJobInner withSku​(Sku sku)
        Set the sku property: Describes the SKU of the streaming job. Required on PUT (CreateOrReplace) requests.
        Parameters:
        sku - the sku value to set.
        Returns:
        the StreamingJobInner object itself.

      • jobId

        public String jobId()
        Get the jobId property: A GUID uniquely identifying the streaming job. This GUID is generated upon creation of the streaming job.
        Returns:
        the jobId value.

      • provisioningState

        public String provisioningState()
        Get the provisioningState property: Describes the provisioning status of the streaming job.
        Returns:
        the provisioningState value.

      • jobState

        public String jobState()
        Get the jobState property: Describes the state of the streaming job.
        Returns:
        the jobState value.

      • jobType

        public JobType jobType()
        Get the jobType property: Describes the type of the job. Valid modes are `Cloud` and 'Edge'.
        Returns:
        the jobType value.

      • withJobType

        public StreamingJobInner withJobType​(JobType jobType)
        Set the jobType property: Describes the type of the job. Valid modes are `Cloud` and 'Edge'.
        Parameters:
        jobType - the jobType value to set.
        Returns:
        the StreamingJobInner object itself.

      • outputStartMode

        public OutputStartMode outputStartMode()
        Get the outputStartMode property: This property should only be utilized when it is desired that the job be started immediately upon creation. Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time.
        Returns:
        the outputStartMode value.

      • withOutputStartMode

        public StreamingJobInner withOutputStartMode​(OutputStartMode outputStartMode)
        Set the outputStartMode property: This property should only be utilized when it is desired that the job be started immediately upon creation. Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time.
        Parameters:
        outputStartMode - the outputStartMode value to set.
        Returns:
        the StreamingJobInner object itself.

      • outputStartTime

        public OffsetDateTime outputStartTime()
        Get the outputStartTime property: Value is either an ISO-8601 formatted time stamp that indicates the starting point of the output event stream, or null to indicate that the output event stream will start whenever the streaming job is started. This property must have a value if outputStartMode is set to CustomTime.
        Returns:
        the outputStartTime value.

      • withOutputStartTime

        public StreamingJobInner withOutputStartTime​(OffsetDateTime outputStartTime)
        Set the outputStartTime property: Value is either an ISO-8601 formatted time stamp that indicates the starting point of the output event stream, or null to indicate that the output event stream will start whenever the streaming job is started. This property must have a value if outputStartMode is set to CustomTime.
        Parameters:
        outputStartTime - the outputStartTime value to set.
        Returns:
        the StreamingJobInner object itself.

      • lastOutputEventTime

        public OffsetDateTime lastOutputEventTime()
        Get the lastOutputEventTime property: Value is either an ISO-8601 formatted timestamp indicating the last output event time of the streaming job or null indicating that output has not yet been produced. In case of multiple outputs or multiple streams, this shows the latest value in that set.
        Returns:
        the lastOutputEventTime value.

      • eventsOutOfOrderPolicy

        public EventsOutOfOrderPolicy eventsOutOfOrderPolicy()
        Get the eventsOutOfOrderPolicy property: Indicates the policy to apply to events that arrive out of order in the input event stream.
        Returns:
        the eventsOutOfOrderPolicy value.

      • withEventsOutOfOrderPolicy

        public StreamingJobInner withEventsOutOfOrderPolicy​(EventsOutOfOrderPolicy eventsOutOfOrderPolicy)
        Set the eventsOutOfOrderPolicy property: Indicates the policy to apply to events that arrive out of order in the input event stream.
        Parameters:
        eventsOutOfOrderPolicy - the eventsOutOfOrderPolicy value to set.
        Returns:
        the StreamingJobInner object itself.

      • outputErrorPolicy

        public OutputErrorPolicy outputErrorPolicy()
        Get the outputErrorPolicy property: Indicates the policy to apply to events that arrive at the output and cannot be written to the external storage due to being malformed (missing column values, column values of wrong type or size).
        Returns:
        the outputErrorPolicy value.

      • withOutputErrorPolicy

        public StreamingJobInner withOutputErrorPolicy​(OutputErrorPolicy outputErrorPolicy)
        Set the outputErrorPolicy property: Indicates the policy to apply to events that arrive at the output and cannot be written to the external storage due to being malformed (missing column values, column values of wrong type or size).
        Parameters:
        outputErrorPolicy - the outputErrorPolicy value to set.
        Returns:
        the StreamingJobInner object itself.

      • eventsOutOfOrderMaxDelayInSeconds

        public Integer eventsOutOfOrderMaxDelayInSeconds()
        Get the eventsOutOfOrderMaxDelayInSeconds property: The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order.
        Returns:
        the eventsOutOfOrderMaxDelayInSeconds value.

      • withEventsOutOfOrderMaxDelayInSeconds

        public StreamingJobInner withEventsOutOfOrderMaxDelayInSeconds​(Integer eventsOutOfOrderMaxDelayInSeconds)
        Set the eventsOutOfOrderMaxDelayInSeconds property: The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order.
        Parameters:
        eventsOutOfOrderMaxDelayInSeconds - the eventsOutOfOrderMaxDelayInSeconds value to set.
        Returns:
        the StreamingJobInner object itself.

      • eventsLateArrivalMaxDelayInSeconds

        public Integer eventsLateArrivalMaxDelayInSeconds()
        Get the eventsLateArrivalMaxDelayInSeconds property: The maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 to 1814399 (20.23:59:59 days) and -1 is used to specify wait indefinitely. If the property is absent, it is interpreted to have a value of -1.
        Returns:
        the eventsLateArrivalMaxDelayInSeconds value.

      • withEventsLateArrivalMaxDelayInSeconds

        public StreamingJobInner withEventsLateArrivalMaxDelayInSeconds​(Integer eventsLateArrivalMaxDelayInSeconds)
        Set the eventsLateArrivalMaxDelayInSeconds property: The maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 to 1814399 (20.23:59:59 days) and -1 is used to specify wait indefinitely. If the property is absent, it is interpreted to have a value of -1.
        Parameters:
        eventsLateArrivalMaxDelayInSeconds - the eventsLateArrivalMaxDelayInSeconds value to set.
        Returns:
        the StreamingJobInner object itself.

      • dataLocale

        public String dataLocale()
        Get the dataLocale property: The data locale of the stream analytics job. Value should be the name of a supported .NET Culture from the set https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx. Defaults to 'en-US' if none specified.
        Returns:
        the dataLocale value.

      • withDataLocale

        public StreamingJobInner withDataLocale​(String dataLocale)
        Set the dataLocale property: The data locale of the stream analytics job. Value should be the name of a supported .NET Culture from the set https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx. Defaults to 'en-US' if none specified.
        Parameters:
        dataLocale - the dataLocale value to set.
        Returns:
        the StreamingJobInner object itself.

      • compatibilityLevel

        public CompatibilityLevel compatibilityLevel()
        Get the compatibilityLevel property: Controls certain runtime behaviors of the streaming job.
        Returns:
        the compatibilityLevel value.

      • withCompatibilityLevel

        public StreamingJobInner withCompatibilityLevel​(CompatibilityLevel compatibilityLevel)
        Set the compatibilityLevel property: Controls certain runtime behaviors of the streaming job.
        Parameters:
        compatibilityLevel - the compatibilityLevel value to set.
        Returns:
        the StreamingJobInner object itself.

      • createdDate

        public OffsetDateTime createdDate()
        Get the createdDate property: Value is an ISO-8601 formatted UTC timestamp indicating when the streaming job was created.
        Returns:
        the createdDate value.

      • inputs

        public List<InputInner> inputs()
        Get the inputs property: A list of one or more inputs to the streaming job. The name property for each input is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual input.
        Returns:
        the inputs value.

      • withInputs

        public StreamingJobInner withInputs​(List<InputInner> inputs)
        Set the inputs property: A list of one or more inputs to the streaming job. The name property for each input is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual input.
        Parameters:
        inputs - the inputs value to set.
        Returns:
        the StreamingJobInner object itself.

      • transformation

        public TransformationInner transformation()
        Get the transformation property: Indicates the query and the number of streaming units to use for the streaming job. The name property of the transformation is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual transformation.
        Returns:
        the transformation value.

      • withTransformation

        public StreamingJobInner withTransformation​(TransformationInner transformation)
        Set the transformation property: Indicates the query and the number of streaming units to use for the streaming job. The name property of the transformation is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual transformation.
        Parameters:
        transformation - the transformation value to set.
        Returns:
        the StreamingJobInner object itself.

      • outputs

        public List<OutputInner> outputs()
        Get the outputs property: A list of one or more outputs for the streaming job. The name property for each output is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual output.
        Returns:
        the outputs value.

      • withOutputs

        public StreamingJobInner withOutputs​(List<OutputInner> outputs)
        Set the outputs property: A list of one or more outputs for the streaming job. The name property for each output is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual output.
        Parameters:
        outputs - the outputs value to set.
        Returns:
        the StreamingJobInner object itself.

      • functions

        public List<FunctionInner> functions()
        Get the functions property: A list of one or more functions for the streaming job. The name property for each function is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual transformation.
        Returns:
        the functions value.

      • withFunctions

        public StreamingJobInner withFunctions​(List<FunctionInner> functions)
        Set the functions property: A list of one or more functions for the streaming job. The name property for each function is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual transformation.
        Parameters:
        functions - the functions value to set.
        Returns:
        the StreamingJobInner object itself.

      • etag

        public String etag()
        Get the etag property: The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.
        Returns:
        the etag value.

      • jobStorageAccount

        public JobStorageAccount jobStorageAccount()
        Get the jobStorageAccount property: The properties that are associated with an Azure Storage account with MSI.
        Returns:
        the jobStorageAccount value.

      • withJobStorageAccount

        public StreamingJobInner withJobStorageAccount​(JobStorageAccount jobStorageAccount)
        Set the jobStorageAccount property: The properties that are associated with an Azure Storage account with MSI.
        Parameters:
        jobStorageAccount - the jobStorageAccount value to set.
        Returns:
        the StreamingJobInner object itself.

      • contentStoragePolicy

        public ContentStoragePolicy contentStoragePolicy()
        Get the contentStoragePolicy property: Valid values are JobStorageAccount and SystemAccount. If set to JobStorageAccount, this requires the user to also specify jobStorageAccount property. .
        Returns:
        the contentStoragePolicy value.

      • withContentStoragePolicy

        public StreamingJobInner withContentStoragePolicy​(ContentStoragePolicy contentStoragePolicy)
        Set the contentStoragePolicy property: Valid values are JobStorageAccount and SystemAccount. If set to JobStorageAccount, this requires the user to also specify jobStorageAccount property. .
        Parameters:
        contentStoragePolicy - the contentStoragePolicy value to set.
        Returns:
        the StreamingJobInner object itself.

      • cluster

        public ClusterInfo cluster()
        Get the cluster property: The cluster which streaming jobs will run on.
        Returns:
        the cluster value.

      • withCluster

        public StreamingJobInner withCluster​(ClusterInfo cluster)
        Set the cluster property: The cluster which streaming jobs will run on.
        Parameters:
        cluster - the cluster value to set.
        Returns:
        the StreamingJobInner object itself.

      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.