Interface Watcher


public interface Watcher
An immutable client-side representation of Watcher.
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    The entirety of the Watcher definition.
    static interface 
    The Watcher definition stages.
    static interface 
    The template for Watcher update.
    static interface 
    The Watcher update stages.
  • Method Summary

    Modifier and Type
    Method
    Description
    Gets the creationTime property: Gets or sets the creation time.
    Gets the description property: Gets or sets the description.
    Gets the etag property: Gets or sets the etag of the resource.
    Gets the executionFrequencyInSeconds property: Gets or sets the frequency at which the watcher is invoked.
    id()
    Gets the id property: Fully qualified resource Id for the resource.
    Gets the inner com.azure.resourcemanager.automation.fluent.models.WatcherInner object.
    Gets the lastModifiedBy property: Details of the user who last modified the watcher.
    Gets the lastModifiedTime property: Gets or sets the last modified time.
    Gets the location property: The geo-location where the resource lives.
    Gets the name property: The name of the resource.
    Refreshes the resource to sync with Azure.
    refresh(com.azure.core.util.Context context)
    Refreshes the resource to sync with Azure.
    com.azure.core.management.Region
    Gets the region of the resource.
    Gets the name of the resource region.
    Gets the name of the resource group.
    Gets the scriptName property: Gets or sets the name of the script the watcher is attached to, i.e.
    Gets the scriptParameters property: Gets or sets the parameters of the script.
    Gets the scriptRunOn property: Gets or sets the name of the hybrid worker group the watcher will run on.
    void
    Resume the watcher identified by watcher name.
    com.azure.core.http.rest.Response<Void>
    startWithResponse(com.azure.core.util.Context context)
    Resume the watcher identified by watcher name.
    Gets the status property: Gets the current status of the watcher.
    void
    Resume the watcher identified by watcher name.
    com.azure.core.http.rest.Response<Void>
    stopWithResponse(com.azure.core.util.Context context)
    Resume the watcher identified by watcher name.
    Gets the tags property: Resource tags.
    Gets the type property: The type of the resource.
    Begins update for the Watcher resource.
  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.
    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.
    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.
    • etag

      String etag()
      Gets the etag property: Gets or sets the etag of the resource.
      Returns:
      the etag value.
    • tags

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.
    • location

      String location()
      Gets the location property: The geo-location where the resource lives.
      Returns:
      the location value.
    • executionFrequencyInSeconds

      Long executionFrequencyInSeconds()
      Gets the executionFrequencyInSeconds property: Gets or sets the frequency at which the watcher is invoked.
      Returns:
      the executionFrequencyInSeconds value.
    • scriptName

      String scriptName()
      Gets the scriptName property: Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook.
      Returns:
      the scriptName value.
    • scriptParameters

      Map<String,String> scriptParameters()
      Gets the scriptParameters property: Gets or sets the parameters of the script.
      Returns:
      the scriptParameters value.
    • scriptRunOn

      String scriptRunOn()
      Gets the scriptRunOn property: Gets or sets the name of the hybrid worker group the watcher will run on.
      Returns:
      the scriptRunOn value.
    • status

      String status()
      Gets the status property: Gets the current status of the watcher.
      Returns:
      the status value.
    • creationTime

      OffsetDateTime creationTime()
      Gets the creationTime property: Gets or sets the creation time.
      Returns:
      the creationTime value.
    • lastModifiedTime

      OffsetDateTime lastModifiedTime()
      Gets the lastModifiedTime property: Gets or sets the last modified time.
      Returns:
      the lastModifiedTime value.
    • lastModifiedBy

      String lastModifiedBy()
      Gets the lastModifiedBy property: Details of the user who last modified the watcher.
      Returns:
      the lastModifiedBy value.
    • description

      String description()
      Gets the description property: Gets or sets the description.
      Returns:
      the description value.
    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.
    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.
    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.
    • innerModel

      WatcherInner innerModel()
      Gets the inner com.azure.resourcemanager.automation.fluent.models.WatcherInner object.
      Returns:
      the inner object.
    • update

      Watcher.Update update()
      Begins update for the Watcher resource.
      Returns:
      the stage of resource update.
    • refresh

      Watcher refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.
    • refresh

      Watcher refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.
    • start

      void start()
      Resume the watcher identified by watcher name.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • startWithResponse

      com.azure.core.http.rest.Response<Void> startWithResponse(com.azure.core.util.Context context)
      Resume the watcher identified by watcher name.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • stop

      void stop()
      Resume the watcher identified by watcher name.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • stopWithResponse

      com.azure.core.http.rest.Response<Void> stopWithResponse(com.azure.core.util.Context context)
      Resume the watcher identified by watcher name.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.