Package com.azure.resourcemanager.loganalytics.models

Interface SavedSearch

public interface SavedSearch
An immutable client-side representation of SavedSearch.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    SavedSearch.Definition
    The entirety of the SavedSearch definition.
    static interface 
    SavedSearch.DefinitionStages
    The SavedSearch definition stages.
    static interface 
    SavedSearch.Update
    The template for SavedSearch update.
    static interface 
    SavedSearch.UpdateStages
    The SavedSearch update stages.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    category()
    Gets the category property: The category of the saved search.
    String
    displayName()
    Gets the displayName property: Saved search display name.
    String
    etag()
    Gets the etag property: The ETag of the saved search.
    String
    functionAlias()
    Gets the functionAlias property: The function alias if query serves as a function.
    String
    functionParameters()
    Gets the functionParameters property: The optional function parameters if query serves as a function.
    String
    id()
    Gets the id property: Fully qualified resource Id for the resource.
    SavedSearchInner
    innerModel()
    Gets the inner com.azure.resourcemanager.loganalytics.fluent.models.SavedSearchInner object.
    String
    name()
    Gets the name property: The name of the resource.
    String
    query()
    Gets the query property: The query expression for the saved search.
    SavedSearch
    refresh()
    Refreshes the resource to sync with Azure.
    SavedSearch
    refresh(com.azure.core.util.Context context)
    Refreshes the resource to sync with Azure.
    String
    resourceGroupName()
    Gets the name of the resource group.
    List<Tag>
    tags()
    Gets the tags property: The tags attached to the saved search.
    String
    type()
    Gets the type property: The type of the resource.
    SavedSearch.Update
    update()
    Begins update for the SavedSearch resource.
    Long
    version()
    Gets the version property: The version number of the query language.

  • 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: The ETag of the saved search. To override an existing saved search, use "*" or specify the current Etag.
      Returns:
      the etag value.

    • category

      String category()
      Gets the category property: The category of the saved search. This helps the user to find a saved search faster.
      Returns:
      the category value.

    • displayName

      String displayName()
      Gets the displayName property: Saved search display name.
      Returns:
      the displayName value.

    • query

      String query()
      Gets the query property: The query expression for the saved search.
      Returns:
      the query value.

    • functionAlias

      String functionAlias()
      Gets the functionAlias property: The function alias if query serves as a function.
      Returns:
      the functionAlias value.

    • functionParameters

      String functionParameters()
      Gets the functionParameters property: The optional function parameters if query serves as a function. Value should be in the following format: 'param-name1:type1 = default_value1, param-name2:type2 = default_value2'. For more examples and proper syntax please refer to https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.
      Returns:
      the functionParameters value.

    • version

      Long version()
      Gets the version property: The version number of the query language. The current version is 2 and is the default.
      Returns:
      the version value.

    • tags

      List<Tag> tags()
      Gets the tags property: The tags attached to the saved search.
      Returns:
      the tags value.

    • resourceGroupName

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

    • innerModel

      SavedSearchInner innerModel()
      Gets the inner com.azure.resourcemanager.loganalytics.fluent.models.SavedSearchInner object.
      Returns:
      the inner object.

    • update

      SavedSearch.Update update()
      Begins update for the SavedSearch resource.
      Returns:
      the stage of resource update.

    • refresh

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

    • refresh

      SavedSearch 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.