Package com.azure.resourcemanager.monitor.models

Class DataCollectionRule

java.lang.Object
com.azure.resourcemanager.monitor.models.DataCollectionRule
All Implemented Interfaces:
com.azure.json.JsonSerializable<DataCollectionRule>
Direct Known Subclasses:
DataCollectionRuleResourceProperties
public class DataCollectionRule extends Object implements com.azure.json.JsonSerializable<DataCollectionRule>
Definition of what monitoring data to collect and where that data should be sent.

  • Constructor Details

    • DataCollectionRule

      public DataCollectionRule()
      Creates an instance of DataCollectionRule class.

  • Method Details

    • description

      public String description()
      Get the description property: Description of the data collection rule.
      Returns:
      the description value.

    • withDescription

      public DataCollectionRule withDescription(String description)
      Set the description property: Description of the data collection rule.
      Parameters:
      description - the description value to set.
      Returns:
      the DataCollectionRule object itself.

    • immutableId

      public String immutableId()
      Get the immutableId property: The immutable ID of this data collection rule. This property is READ-ONLY.
      Returns:
      the immutableId value.

    • dataCollectionEndpointId

      public String dataCollectionEndpointId()
      Get the dataCollectionEndpointId property: The resource ID of the data collection endpoint that this rule can be used with.
      Returns:
      the dataCollectionEndpointId value.

    • withDataCollectionEndpointId

      public DataCollectionRule withDataCollectionEndpointId(String dataCollectionEndpointId)
      Set the dataCollectionEndpointId property: The resource ID of the data collection endpoint that this rule can be used with.
      Parameters:
      dataCollectionEndpointId - the dataCollectionEndpointId value to set.
      Returns:
      the DataCollectionRule object itself.

    • metadata

      public DataCollectionRuleMetadata metadata()
      Get the metadata property: Metadata about the resource.
      Returns:
      the metadata value.

    • streamDeclarations

      public Map<String,StreamDeclaration> streamDeclarations()
      Get the streamDeclarations property: Declaration of custom streams used in this rule.
      Returns:
      the streamDeclarations value.

    • withStreamDeclarations

      public DataCollectionRule withStreamDeclarations(Map<String,StreamDeclaration> streamDeclarations)
      Set the streamDeclarations property: Declaration of custom streams used in this rule.
      Parameters:
      streamDeclarations - the streamDeclarations value to set.
      Returns:
      the DataCollectionRule object itself.

    • dataSources

      public DataCollectionRuleDataSources dataSources()
      Get the dataSources property: The specification of data sources. This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint.
      Returns:
      the dataSources value.

    • withDataSources

      public DataCollectionRule withDataSources(DataCollectionRuleDataSources dataSources)
      Set the dataSources property: The specification of data sources. This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint.
      Parameters:
      dataSources - the dataSources value to set.
      Returns:
      the DataCollectionRule object itself.

    • destinations

      public DataCollectionRuleDestinations destinations()
      Get the destinations property: The specification of destinations.
      Returns:
      the destinations value.

    • withDestinations

      public DataCollectionRule withDestinations(DataCollectionRuleDestinations destinations)
      Set the destinations property: The specification of destinations.
      Parameters:
      destinations - the destinations value to set.
      Returns:
      the DataCollectionRule object itself.

    • dataFlows

      public List<DataFlow> dataFlows()
      Get the dataFlows property: The specification of data flows.
      Returns:
      the dataFlows value.

    • withDataFlows

      public DataCollectionRule withDataFlows(List<DataFlow> dataFlows)
      Set the dataFlows property: The specification of data flows.
      Parameters:
      dataFlows - the dataFlows value to set.
      Returns:
      the DataCollectionRule object itself.

    • provisioningState

      public KnownDataCollectionRuleProvisioningState provisioningState()
      Get the provisioningState property: The resource provisioning state.
      Returns:
      the provisioningState value.

    • validate

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

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<DataCollectionRule>
      Throws:
      IOException

    • fromJson

      public static DataCollectionRule fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of DataCollectionRule from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of DataCollectionRule if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the DataCollectionRule.