Share via


ComponentPolicyState Class

  • java.lang.Object
    • com.azure.resourcemanager.policyinsights.models.ComponentPolicyState

Implements

public final class ComponentPolicyState
implements JsonSerializable<ComponentPolicyState>

Component Policy State record.

Constructor Summary

Constructor Description
ComponentPolicyState()

Creates an instance of ComponentPolicyState class.

Method Summary

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

Get the additionalProperties property: Component Policy State record.

String complianceState()

Get the complianceState property: Compliance state of the resource.

String componentId()

Get the componentId property: Component Id.

String componentName()

Get the componentName property: Component name.

String componentType()

Get the componentType property: Component type.

static ComponentPolicyState fromJson(JsonReader jsonReader)

Reads an instance of ComponentPolicyState from the JsonReader.

String odataContext()

Get the odataContext property: OData context string; used by OData clients to resolve type information based on metadata.

String odataId()

Get the odataId property: OData entity ID; always set to null since component policy state records do not have an entity ID.

String policyAssignmentId()

Get the policyAssignmentId property: Policy assignment ID.

String policyAssignmentName()

Get the policyAssignmentName property: Policy assignment name.

String policyAssignmentOwner()

Get the policyAssignmentOwner property: Policy assignment owner.

String policyAssignmentParameters()

Get the policyAssignmentParameters property: Policy assignment parameters.

String policyAssignmentScope()

Get the policyAssignmentScope property: Policy assignment scope.

String policyAssignmentVersion()

Get the policyAssignmentVersion property: Evaluated policy assignment version.

String policyDefinitionAction()

Get the policyDefinitionAction property: Policy definition action, i.e.

String policyDefinitionCategory()

Get the policyDefinitionCategory property: Policy definition category.

List<String> policyDefinitionGroupNames()

Get the policyDefinitionGroupNames property: Policy definition group names.

String policyDefinitionId()

Get the policyDefinitionId property: Policy definition ID.

String policyDefinitionName()

Get the policyDefinitionName property: Policy definition name.

String policyDefinitionReferenceId()

Get the policyDefinitionReferenceId property: Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set.

String policyDefinitionVersion()

Get the policyDefinitionVersion property: Evaluated policy definition version.

ComponentPolicyEvaluationDetails policyEvaluationDetails()

Get the policyEvaluationDetails property: Policy evaluation details.

String policySetDefinitionCategory()

Get the policySetDefinitionCategory property: Policy set definition category, if the policy assignment is for a policy set.

String policySetDefinitionId()

Get the policySetDefinitionId property: Policy set definition ID, if the policy assignment is for a policy set.

String policySetDefinitionName()

Get the policySetDefinitionName property: Policy set definition name, if the policy assignment is for a policy set.

String policySetDefinitionOwner()

Get the policySetDefinitionOwner property: Policy set definition owner, if the policy assignment is for a policy set.

String policySetDefinitionParameters()

Get the policySetDefinitionParameters property: Policy set definition parameters, if the policy assignment is for a policy set.

String policySetDefinitionVersion()

Get the policySetDefinitionVersion property: Evaluated policy set definition version.

String resourceGroup()

Get the resourceGroup property: Resource group name.

String resourceId()

Get the resourceId property: Resource ID.

String resourceLocation()

Get the resourceLocation property: Resource location.

String resourceType()

Get the resourceType property: Resource type.

String subscriptionId()

Get the subscriptionId property: Subscription ID.

OffsetDateTime timestamp()

Get the timestamp property: Timestamp for the component policy state record.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

ComponentPolicyState withAdditionalProperties(Map<String,Object> additionalProperties)

Set the additionalProperties property: Component Policy State record.

ComponentPolicyState withPolicyEvaluationDetails(ComponentPolicyEvaluationDetails policyEvaluationDetails)

Set the policyEvaluationDetails property: Policy evaluation details.

Methods inherited from java.lang.Object

Constructor Details

ComponentPolicyState

public ComponentPolicyState()

Creates an instance of ComponentPolicyState class.

Method Details

additionalProperties

public Map<String,Object> additionalProperties()

Get the additionalProperties property: Component Policy State record.

Returns:

the additionalProperties value.

complianceState

public String complianceState()

Get the complianceState property: Compliance state of the resource.

Returns:

the complianceState value.

componentId

public String componentId()

Get the componentId property: Component Id.

Returns:

the componentId value.

componentName

public String componentName()

Get the componentName property: Component name.

Returns:

the componentName value.

componentType

public String componentType()

Get the componentType property: Component type.

Returns:

the componentType value.

fromJson

public static ComponentPolicyState fromJson(JsonReader jsonReader)

Reads an instance of ComponentPolicyState from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ComponentPolicyState 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 ComponentPolicyState.

odataContext

public String odataContext()

Get the odataContext property: OData context string; used by OData clients to resolve type information based on metadata.

Returns:

the odataContext value.

odataId

public String odataId()

Get the odataId property: OData entity ID; always set to null since component policy state records do not have an entity ID.

Returns:

the odataId value.

policyAssignmentId

public String policyAssignmentId()

Get the policyAssignmentId property: Policy assignment ID.

Returns:

the policyAssignmentId value.

policyAssignmentName

public String policyAssignmentName()

Get the policyAssignmentName property: Policy assignment name.

Returns:

the policyAssignmentName value.

policyAssignmentOwner

public String policyAssignmentOwner()

Get the policyAssignmentOwner property: Policy assignment owner.

Returns:

the policyAssignmentOwner value.

policyAssignmentParameters

public String policyAssignmentParameters()

Get the policyAssignmentParameters property: Policy assignment parameters.

Returns:

the policyAssignmentParameters value.

policyAssignmentScope

public String policyAssignmentScope()

Get the policyAssignmentScope property: Policy assignment scope.

Returns:

the policyAssignmentScope value.

policyAssignmentVersion

public String policyAssignmentVersion()

Get the policyAssignmentVersion property: Evaluated policy assignment version.

Returns:

the policyAssignmentVersion value.

policyDefinitionAction

public String policyDefinitionAction()

Get the policyDefinitionAction property: Policy definition action, i.e. effect.

Returns:

the policyDefinitionAction value.

policyDefinitionCategory

public String policyDefinitionCategory()

Get the policyDefinitionCategory property: Policy definition category.

Returns:

the policyDefinitionCategory value.

policyDefinitionGroupNames

public List<String> policyDefinitionGroupNames()

Get the policyDefinitionGroupNames property: Policy definition group names.

Returns:

the policyDefinitionGroupNames value.

policyDefinitionId

public String policyDefinitionId()

Get the policyDefinitionId property: Policy definition ID.

Returns:

the policyDefinitionId value.

policyDefinitionName

public String policyDefinitionName()

Get the policyDefinitionName property: Policy definition name.

Returns:

the policyDefinitionName value.

policyDefinitionReferenceId

public String policyDefinitionReferenceId()

Get the policyDefinitionReferenceId property: Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set.

Returns:

the policyDefinitionReferenceId value.

policyDefinitionVersion

public String policyDefinitionVersion()

Get the policyDefinitionVersion property: Evaluated policy definition version.

Returns:

the policyDefinitionVersion value.

policyEvaluationDetails

public ComponentPolicyEvaluationDetails policyEvaluationDetails()

Get the policyEvaluationDetails property: Policy evaluation details. This is only included in the response if the request contains $expand=PolicyEvaluationDetails.

Returns:

the policyEvaluationDetails value.

policySetDefinitionCategory

public String policySetDefinitionCategory()

Get the policySetDefinitionCategory property: Policy set definition category, if the policy assignment is for a policy set.

Returns:

the policySetDefinitionCategory value.

policySetDefinitionId

public String policySetDefinitionId()

Get the policySetDefinitionId property: Policy set definition ID, if the policy assignment is for a policy set.

Returns:

the policySetDefinitionId value.

policySetDefinitionName

public String policySetDefinitionName()

Get the policySetDefinitionName property: Policy set definition name, if the policy assignment is for a policy set.

Returns:

the policySetDefinitionName value.

policySetDefinitionOwner

public String policySetDefinitionOwner()

Get the policySetDefinitionOwner property: Policy set definition owner, if the policy assignment is for a policy set.

Returns:

the policySetDefinitionOwner value.

policySetDefinitionParameters

public String policySetDefinitionParameters()

Get the policySetDefinitionParameters property: Policy set definition parameters, if the policy assignment is for a policy set.

Returns:

the policySetDefinitionParameters value.

policySetDefinitionVersion

public String policySetDefinitionVersion()

Get the policySetDefinitionVersion property: Evaluated policy set definition version.

Returns:

the policySetDefinitionVersion value.

resourceGroup

public String resourceGroup()

Get the resourceGroup property: Resource group name.

Returns:

the resourceGroup value.

resourceId

public String resourceId()

Get the resourceId property: Resource ID.

Returns:

the resourceId value.

resourceLocation

public String resourceLocation()

Get the resourceLocation property: Resource location.

Returns:

the resourceLocation value.

resourceType

public String resourceType()

Get the resourceType property: Resource type.

Returns:

the resourceType value.

subscriptionId

public String subscriptionId()

Get the subscriptionId property: Subscription ID.

Returns:

the subscriptionId value.

timestamp

public OffsetDateTime timestamp()

Get the timestamp property: Timestamp for the component policy state record.

Returns:

the timestamp value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withAdditionalProperties

public ComponentPolicyState withAdditionalProperties(Map<String,Object> additionalProperties)

Set the additionalProperties property: Component Policy State record.

Parameters:

additionalProperties - the additionalProperties value to set.

Returns:

the ComponentPolicyState object itself.

withPolicyEvaluationDetails

public ComponentPolicyState withPolicyEvaluationDetails(ComponentPolicyEvaluationDetails policyEvaluationDetails)

Set the policyEvaluationDetails property: Policy evaluation details. This is only included in the response if the request contains $expand=PolicyEvaluationDetails.

Parameters:

policyEvaluationDetails - the policyEvaluationDetails value to set.

Returns:

the ComponentPolicyState object itself.

Applies to