Class TableProperties

java.lang.Object
com.azure.resourcemanager.loganalytics.fluent.models.TableProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<TableProperties>
public final class TableProperties extends Object implements com.azure.json.JsonSerializable<TableProperties>
Table properties.

  • Constructor Details

    • TableProperties

      public TableProperties()
      Creates an instance of TableProperties class.

  • Method Details

    • retentionInDays

      public Integer retentionInDays()
      Get 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.

    • withRetentionInDays

      public TableProperties withRetentionInDays(Integer retentionInDays)
      Set 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.
      Parameters:
      retentionInDays - the retentionInDays value to set.
      Returns:
      the TableProperties object itself.

    • totalRetentionInDays

      public Integer totalRetentionInDays()
      Get 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.

    • withTotalRetentionInDays

      public TableProperties withTotalRetentionInDays(Integer totalRetentionInDays)
      Set the totalRetentionInDays property: The table total retention in days, between 4 and 4383. Setting this property to -1 will default to retentionInDays.
      Parameters:
      totalRetentionInDays - the totalRetentionInDays value to set.
      Returns:
      the TableProperties object itself.

    • archiveRetentionInDays

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

    • searchResults

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

    • withSearchResults

      public TableProperties withSearchResults(SearchResults searchResults)
      Set the searchResults property: Parameters of the search job that initiated this table.
      Parameters:
      searchResults - the searchResults value to set.
      Returns:
      the TableProperties object itself.

    • restoredLogs

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

    • withRestoredLogs

      public TableProperties withRestoredLogs(RestoredLogs restoredLogs)
      Set the restoredLogs property: Parameters of the restore operation that initiated this table.
      Parameters:
      restoredLogs - the restoredLogs value to set.
      Returns:
      the TableProperties object itself.

    • resultStatistics

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

    • plan

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

    • withPlan

      public TableProperties withPlan(TablePlanEnum plan)
      Set the plan property: Instruct the system how to handle and charge the logs ingested to this table.
      Parameters:
      plan - the plan value to set.
      Returns:
      the TableProperties object itself.

    • lastPlanModifiedDate

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

    • schema

      public Schema schema()
      Get the schema property: Table schema.
      Returns:
      the schema value.

    • withSchema

      public TableProperties withSchema(Schema schema)
      Set the schema property: Table schema.
      Parameters:
      schema - the schema value to set.
      Returns:
      the TableProperties object itself.

    • provisioningState

      public ProvisioningStateEnum provisioningState()
      Get 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

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

    • totalRetentionInDaysAsDefault

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

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<TableProperties>
      Throws:
      IOException

    • fromJson

      public static TableProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of TableProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of TableProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the TableProperties.