Interface Table

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

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    Integer
    archiveRetentionInDays()
    Gets the archiveRetentionInDays property: The tables long-term retention in days.
    void
    cancelSearch()
    Cancel a log analytics workspace search results table query run.
    com.azure.core.http.rest.Response<Void>
    cancelSearchWithResponse(com.azure.core.util.Context context)
    Cancel a log analytics workspace search results table query run.
    String
    id()
    Gets the id property: Fully qualified resource Id for the resource.
    TableInner
    innerModel()
    Gets the inner com.azure.resourcemanager.loganalytics.fluent.models.TableInner object.
    String
    lastPlanModifiedDate()
    Gets the lastPlanModifiedDate property: The timestamp that table plan was last modified (UTC).
    void
    migrate()
    Migrate a Log Analytics table from support of the Data Collector API and Custom Fields features to support of Data Collection Rule-based Custom Logs.
    com.azure.core.http.rest.Response<Void>
    migrateWithResponse(com.azure.core.util.Context context)
    Migrate a Log Analytics table from support of the Data Collector API and Custom Fields features to support of Data Collection Rule-based Custom Logs.
    String
    name()
    Gets the name property: The name of the resource.
    TablePlanEnum
    plan()
    Gets the plan property: Instruct the system how to handle and charge the logs ingested to this table.
    ProvisioningStateEnum
    provisioningState()
    Gets the provisioningState property: Table's current provisioning state.
    Table
    refresh()
    Refreshes the resource to sync with Azure.
    Table
    refresh(com.azure.core.util.Context context)
    Refreshes the resource to sync with Azure.
    String
    resourceGroupName()
    Gets the name of the resource group.
    RestoredLogs
    restoredLogs()
    Gets the restoredLogs property: Parameters of the restore operation that initiated this table.
    ResultStatistics
    resultStatistics()
    Gets the resultStatistics property: Search job execution statistics.
    Integer
    retentionInDays()
    Gets the retentionInDays property: In Analytics table: the tables analytics retention in days, between 4 and 730.
    Boolean
    retentionInDaysAsDefault()
    Gets the retentionInDaysAsDefault property: True - Value originates from workspace retention in days, False - Customer specific.
    Schema
    schema()
    Gets the schema property: Table schema.
    SearchResults
    searchResults()
    Gets the searchResults property: Parameters of the search job that initiated this table.
    com.azure.core.management.SystemData
    systemData()
    Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Integer
    totalRetentionInDays()
    Gets the totalRetentionInDays property: The table total retention in days, between 4 and 4383.
    Boolean
    totalRetentionInDaysAsDefault()
    Gets the totalRetentionInDaysAsDefault property: True - Value originates from retention in days, False - Customer specific.
    String
    type()
    Gets the type property: The type of the resource.
    Table.Update
    update()
    Begins update for the Table 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.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
      Returns:
      the systemData value.

    • retentionInDays

      Integer retentionInDays()
      Gets the retentionInDays property: In Analytics table: the tables analytics retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention. In Basic and Auxiliary table: read only property.
      Returns:
      the retentionInDays value.

    • totalRetentionInDays

      Integer totalRetentionInDays()
      Gets the totalRetentionInDays property: The table total retention in days, between 4 and 4383. Setting this property to -1 will default to retentionInDays.
      Returns:
      the totalRetentionInDays value.

    • archiveRetentionInDays

      Integer archiveRetentionInDays()
      Gets the archiveRetentionInDays property: The tables long-term retention in days. Calculated as (totalRetentionInDays-retentionInDays).
      Returns:
      the archiveRetentionInDays value.

    • searchResults

      SearchResults searchResults()
      Gets the searchResults property: Parameters of the search job that initiated this table.
      Returns:
      the searchResults value.

    • restoredLogs

      RestoredLogs restoredLogs()
      Gets the restoredLogs property: Parameters of the restore operation that initiated this table.
      Returns:
      the restoredLogs value.

    • resultStatistics

      ResultStatistics resultStatistics()
      Gets the resultStatistics property: Search job execution statistics.
      Returns:
      the resultStatistics value.

    • plan

      TablePlanEnum plan()
      Gets the plan property: Instruct the system how to handle and charge the logs ingested to this table.
      Returns:
      the plan value.

    • lastPlanModifiedDate

      String lastPlanModifiedDate()
      Gets the lastPlanModifiedDate property: The timestamp that table plan was last modified (UTC).
      Returns:
      the lastPlanModifiedDate value.

    • schema

      Schema schema()
      Gets the schema property: Table schema.
      Returns:
      the schema value.

    • provisioningState

      ProvisioningStateEnum provisioningState()
      Gets the provisioningState property: Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded.
      Returns:
      the provisioningState value.

    • retentionInDaysAsDefault

      Boolean retentionInDaysAsDefault()
      Gets the retentionInDaysAsDefault property: True - Value originates from workspace retention in days, False - Customer specific.
      Returns:
      the retentionInDaysAsDefault value.

    • totalRetentionInDaysAsDefault

      Boolean totalRetentionInDaysAsDefault()
      Gets the totalRetentionInDaysAsDefault property: True - Value originates from retention in days, False - Customer specific.
      Returns:
      the totalRetentionInDaysAsDefault value.

    • resourceGroupName

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

    • innerModel

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

    • update

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

    • refresh

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

    • refresh

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

    • migrateWithResponse

      com.azure.core.http.rest.Response<Void> migrateWithResponse(com.azure.core.util.Context context)
      Migrate a Log Analytics table from support of the Data Collector API and Custom Fields features to support of Data Collection Rule-based Custom Logs.
      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.

    • migrate

      void migrate()
      Migrate a Log Analytics table from support of the Data Collector API and Custom Fields features to support of Data Collection Rule-based Custom Logs.
      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.

    • cancelSearchWithResponse

      com.azure.core.http.rest.Response<Void> cancelSearchWithResponse(com.azure.core.util.Context context)
      Cancel a log analytics workspace search results table query run.
      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.

    • cancelSearch

      void cancelSearch()
      Cancel a log analytics workspace search results table query run.
      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.