Del via

RecommendedActionProperties Class

Package:
com.azure.resourcemanager.sql.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-sql:2.53.7
  • java.lang.Object
    • com.azure.resourcemanager.sql.fluent.models.RecommendedActionProperties

Implements

JsonSerializable<RecommendedActionProperties>

public final class RecommendedActionProperties
implements JsonSerializable<RecommendedActionProperties>

Properties for a Database, Server or Elastic Pool Recommended Action.

Constructor Summary

Constructor Description
RecommendedActionProperties()

Creates an instance of RecommendedActionProperties class.

Method Summary

Modifier and Type Method and Description
Map<String,Object> details()

Get the details property: Gets additional details specific to this recommended action.
RecommendedActionErrorInfo errorDetails()

Get the errorDetails property: Gets the error details if and why this recommended action is put to error state.
List<RecommendedActionImpactRecord> estimatedImpact()

Get the estimatedImpact property: Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change.
Duration executeActionDuration()

Get the executeActionDuration property: Gets the time taken for applying this recommended action on user resource.
RecommendedActionInitiatedBy executeActionInitiatedBy()

Get the executeActionInitiatedBy property: Gets if approval for applying this recommended action was given by user/system.
OffsetDateTime executeActionInitiatedTime()

Get the executeActionInitiatedTime property: Gets the time when this recommended action was approved for execution.
OffsetDateTime executeActionStartTime()

Get the executeActionStartTime property: Gets the time when system started applying this recommended action on the user resource.
static RecommendedActionProperties fromJson(JsonReader jsonReader)

Reads an instance of RecommendedActionProperties from the JsonReader.
RecommendedActionImplementationInfo implementationDetails()

Get the implementationDetails property: Gets the implementation details of this recommended action for user to apply it manually.
Boolean isArchivedAction()

Get the isArchivedAction property: Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again.
Boolean isExecutableAction()

Get the isExecutableAction property: Gets if this recommended action is actionable by user.
Boolean isRevertableAction()

Get the isRevertableAction property: Gets if changes applied by this recommended action can be reverted by user.
OffsetDateTime lastRefresh()

Get the lastRefresh property: Gets time when this recommended action was last refreshed.
List<String> linkedObjects()

Get the linkedObjects property: Gets the linked objects, if any.
List<RecommendedActionImpactRecord> observedImpact()

Get the observedImpact property: Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change.
String recommendationReason()

Get the recommendationReason property: Gets the reason for recommending this action.
Duration revertActionDuration()

Get the revertActionDuration property: Gets the time taken for reverting changes of this recommended action on user resource.
RecommendedActionInitiatedBy revertActionInitiatedBy()

Get the revertActionInitiatedBy property: Gets if approval for reverting this recommended action was given by user/system.
OffsetDateTime revertActionInitiatedTime()

Get the revertActionInitiatedTime property: Gets the time when this recommended action was approved for revert.
OffsetDateTime revertActionStartTime()

Get the revertActionStartTime property: Gets the time when system started reverting changes of this recommended action on user resource.
Integer score()

Get the score property: Gets the impact of this recommended action.
RecommendedActionStateInfo state()

Get the state property: Gets the info of the current state the recommended action is in.
List<RecommendedActionMetricInfo> timeSeries()

Get the timeSeries property: Gets the time series info of metrics for this recommended action e.g., CPU consumption time series.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
OffsetDateTime validSince()

Get the validSince property: Gets the time since when this recommended action is valid.
RecommendedActionProperties withState(RecommendedActionStateInfo state)

Set the state property: Gets the info of the current state the recommended action is in.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

RecommendedActionProperties

public RecommendedActionProperties()

Creates an instance of RecommendedActionProperties class.

Method Details

details

public Map<String,Object> details()

Get the details property: Gets additional details specific to this recommended action.

Returns:

the details value.

errorDetails

public RecommendedActionErrorInfo errorDetails()

Get the errorDetails property: Gets the error details if and why this recommended action is put to error state.

Returns:

the errorDetails value.

estimatedImpact

public List<RecommendedActionImpactRecord> estimatedImpact()

Get the estimatedImpact property: Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change.

Returns:

the estimatedImpact value.

executeActionDuration

public Duration executeActionDuration()

Get the executeActionDuration property: Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation.

Returns:

the executeActionDuration value.

executeActionInitiatedBy

public RecommendedActionInitiatedBy executeActionInitiatedBy()

Get the executeActionInitiatedBy property: Gets if approval for applying this recommended action was given by user/system.

Returns:

the executeActionInitiatedBy value.

executeActionInitiatedTime

public OffsetDateTime executeActionInitiatedTime()

Get the executeActionInitiatedTime property: Gets the time when this recommended action was approved for execution.

Returns:

the executeActionInitiatedTime value.

executeActionStartTime

public OffsetDateTime executeActionStartTime()

Get the executeActionStartTime property: Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time.

Returns:

the executeActionStartTime value.

fromJson

public static RecommendedActionProperties fromJson(JsonReader jsonReader)

Reads an instance of RecommendedActionProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of RecommendedActionProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

implementationDetails

public RecommendedActionImplementationInfo implementationDetails()

Get the implementationDetails property: Gets the implementation details of this recommended action for user to apply it manually.

Returns:

the implementationDetails value.

isArchivedAction

public Boolean isArchivedAction()

Get the isArchivedAction property: Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again.

Returns:

the isArchivedAction value.

isExecutableAction

public Boolean isExecutableAction()

Get the isExecutableAction property: Gets if this recommended action is actionable by user.

Returns:

the isExecutableAction value.

isRevertableAction

public Boolean isRevertableAction()

Get the isRevertableAction property: Gets if changes applied by this recommended action can be reverted by user.

Returns:

the isRevertableAction value.

lastRefresh

public OffsetDateTime lastRefresh()

Get the lastRefresh property: Gets time when this recommended action was last refreshed.

Returns:

the lastRefresh value.

linkedObjects

public List<String> linkedObjects()

Get the linkedObjects property: Gets the linked objects, if any.

Returns:

the linkedObjects value.

observedImpact

public List<RecommendedActionImpactRecord> observedImpact()

Get the observedImpact property: Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change.

Returns:

the observedImpact value.

recommendationReason

public String recommendationReason()

Get the recommendationReason property: Gets the reason for recommending this action. e.g., DuplicateIndex.

Returns:

the recommendationReason value.

revertActionDuration

public Duration revertActionDuration()

Get the revertActionDuration property: Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index.

Returns:

the revertActionDuration value.

revertActionInitiatedBy

public RecommendedActionInitiatedBy revertActionInitiatedBy()

Get the revertActionInitiatedBy property: Gets if approval for reverting this recommended action was given by user/system.

Returns:

the revertActionInitiatedBy value.

revertActionInitiatedTime

public OffsetDateTime revertActionInitiatedTime()

Get the revertActionInitiatedTime property: Gets the time when this recommended action was approved for revert.

Returns:

the revertActionInitiatedTime value.

revertActionStartTime

public OffsetDateTime revertActionStartTime()

Get the revertActionStartTime property: Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed.

Returns:

the revertActionStartTime value.

score

public Integer score()

Get the score property: Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact.

Returns:

the score value.

state

public RecommendedActionStateInfo state()

Get the state property: Gets the info of the current state the recommended action is in.

Returns:

the state value.

timeSeries

public List<RecommendedActionMetricInfo> timeSeries()

Get the timeSeries property: Gets the time series info of metrics for this recommended action e.g., CPU consumption time series.

Returns:

the timeSeries value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

validSince

public OffsetDateTime validSince()

Get the validSince property: Gets the time since when this recommended action is valid.

Returns:

the validSince value.

withState

public RecommendedActionProperties withState(RecommendedActionStateInfo state)

Set the state property: Gets the info of the current state the recommended action is in.

Parameters:

state - the state value to set.

Returns:

the RecommendedActionProperties object itself.

Applies to