Class WebTestProperties


  • public final class WebTestProperties
    extends Object
    Metadata describing a web test for an Azure resource.
    • Constructor Detail

      • WebTestProperties

        public WebTestProperties()
    • Method Detail

      • syntheticMonitorId

        public String syntheticMonitorId()
        Get the syntheticMonitorId property: Unique ID of this WebTest. This is typically the same value as the Name field.
        Returns:
        the syntheticMonitorId value.
      • withSyntheticMonitorId

        public WebTestProperties withSyntheticMonitorId​(String syntheticMonitorId)
        Set the syntheticMonitorId property: Unique ID of this WebTest. This is typically the same value as the Name field.
        Parameters:
        syntheticMonitorId - the syntheticMonitorId value to set.
        Returns:
        the WebTestProperties object itself.
      • webTestName

        public String webTestName()
        Get the webTestName property: User defined name if this WebTest.
        Returns:
        the webTestName value.
      • withWebTestName

        public WebTestProperties withWebTestName​(String webTestName)
        Set the webTestName property: User defined name if this WebTest.
        Parameters:
        webTestName - the webTestName value to set.
        Returns:
        the WebTestProperties object itself.
      • description

        public String description()
        Get the description property: Purpose/user defined descriptive test for this WebTest.
        Returns:
        the description value.
      • withDescription

        public WebTestProperties withDescription​(String description)
        Set the description property: Purpose/user defined descriptive test for this WebTest.
        Parameters:
        description - the description value to set.
        Returns:
        the WebTestProperties object itself.
      • enabled

        public Boolean enabled()
        Get the enabled property: Is the test actively being monitored.
        Returns:
        the enabled value.
      • withEnabled

        public WebTestProperties withEnabled​(Boolean enabled)
        Set the enabled property: Is the test actively being monitored.
        Parameters:
        enabled - the enabled value to set.
        Returns:
        the WebTestProperties object itself.
      • frequency

        public Integer frequency()
        Get the frequency property: Interval in seconds between test runs for this WebTest. Default value is 300.
        Returns:
        the frequency value.
      • withFrequency

        public WebTestProperties withFrequency​(Integer frequency)
        Set the frequency property: Interval in seconds between test runs for this WebTest. Default value is 300.
        Parameters:
        frequency - the frequency value to set.
        Returns:
        the WebTestProperties object itself.
      • timeout

        public Integer timeout()
        Get the timeout property: Seconds until this WebTest will timeout and fail. Default value is 30.
        Returns:
        the timeout value.
      • withTimeout

        public WebTestProperties withTimeout​(Integer timeout)
        Set the timeout property: Seconds until this WebTest will timeout and fail. Default value is 30.
        Parameters:
        timeout - the timeout value to set.
        Returns:
        the WebTestProperties object itself.
      • webTestKind

        public WebTestKind webTestKind()
        Get the webTestKind property: The kind of web test this is, valid choices are ping and multistep.
        Returns:
        the webTestKind value.
      • withWebTestKind

        public WebTestProperties withWebTestKind​(WebTestKind webTestKind)
        Set the webTestKind property: The kind of web test this is, valid choices are ping and multistep.
        Parameters:
        webTestKind - the webTestKind value to set.
        Returns:
        the WebTestProperties object itself.
      • retryEnabled

        public Boolean retryEnabled()
        Get the retryEnabled property: Allow for retries should this WebTest fail.
        Returns:
        the retryEnabled value.
      • withRetryEnabled

        public WebTestProperties withRetryEnabled​(Boolean retryEnabled)
        Set the retryEnabled property: Allow for retries should this WebTest fail.
        Parameters:
        retryEnabled - the retryEnabled value to set.
        Returns:
        the WebTestProperties object itself.
      • locations

        public List<WebTestGeolocation> locations()
        Get the locations property: A list of where to physically run the tests from to give global coverage for accessibility of your application.
        Returns:
        the locations value.
      • withLocations

        public WebTestProperties withLocations​(List<WebTestGeolocation> locations)
        Set the locations property: A list of where to physically run the tests from to give global coverage for accessibility of your application.
        Parameters:
        locations - the locations value to set.
        Returns:
        the WebTestProperties object itself.
      • configuration

        public WebTestPropertiesConfiguration configuration()
        Get the configuration property: An XML configuration specification for a WebTest.
        Returns:
        the configuration value.
      • withConfiguration

        public WebTestProperties withConfiguration​(WebTestPropertiesConfiguration configuration)
        Set the configuration property: An XML configuration specification for a WebTest.
        Parameters:
        configuration - the configuration value to set.
        Returns:
        the WebTestProperties object itself.
      • provisioningState

        public String provisioningState()
        Get the provisioningState property: Current state of this component, whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed.
        Returns:
        the provisioningState value.
      • validate

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