Class LoggerContractProperties


  • public final class LoggerContractProperties
    extends Object
    The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.
    • Constructor Detail

      • LoggerContractProperties

        public LoggerContractProperties()
    • Method Detail

      • loggerType

        public LoggerType loggerType()
        Get the loggerType property: Logger type.
        Returns:
        the loggerType value.
      • withLoggerType

        public LoggerContractProperties withLoggerType​(LoggerType loggerType)
        Set the loggerType property: Logger type.
        Parameters:
        loggerType - the loggerType value to set.
        Returns:
        the LoggerContractProperties object itself.
      • description

        public String description()
        Get the description property: Logger description.
        Returns:
        the description value.
      • withDescription

        public LoggerContractProperties withDescription​(String description)
        Set the description property: Logger description.
        Parameters:
        description - the description value to set.
        Returns:
        the LoggerContractProperties object itself.
      • credentials

        public Map<String,​String> credentials()
        Get the credentials property: The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger.
        Returns:
        the credentials value.
      • withCredentials

        public LoggerContractProperties withCredentials​(Map<String,​String> credentials)
        Set the credentials property: The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger.
        Parameters:
        credentials - the credentials value to set.
        Returns:
        the LoggerContractProperties object itself.
      • isBuffered

        public Boolean isBuffered()
        Get the isBuffered property: Whether records are buffered in the logger before publishing. Default is assumed to be true.
        Returns:
        the isBuffered value.
      • withIsBuffered

        public LoggerContractProperties withIsBuffered​(Boolean isBuffered)
        Set the isBuffered property: Whether records are buffered in the logger before publishing. Default is assumed to be true.
        Parameters:
        isBuffered - the isBuffered value to set.
        Returns:
        the LoggerContractProperties object itself.
      • resourceId

        public String resourceId()
        Get the resourceId property: Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource).
        Returns:
        the resourceId value.
      • withResourceId

        public LoggerContractProperties withResourceId​(String resourceId)
        Set the resourceId property: Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource).
        Parameters:
        resourceId - the resourceId value to set.
        Returns:
        the LoggerContractProperties object itself.
      • validate

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