PolicyStateInner Class

Package:

com.azure.resourcemanager.policyinsights.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-policyinsights:1.0.0-beta.3

• java.lang.Object
• • com.azure.resourcemanager.policyinsights.fluent.models.PolicyStateInner

public final class PolicyStateInner

Policy state record.

Constructor Summary

Constructor	Description
PolicyStateInner()	Creates an instance of PolicyStateInner class.

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	additionalProperties() Get the additionalProperties property: Policy state record.
String	complianceState() Get the complianceState property: Compliance state of the resource.
List<ComponentStateDetails>	components() Get the components property: Components state compliance records populated only when URL contains $expand=components clause.
String	effectiveParameters() Get the effectiveParameters property: Effective parameters for the policy assignment.
Boolean	isCompliant() Get the isCompliant property: Flag which states whether the resource is compliant against the policy assignment it was evaluated against.
String	managementGroupIds() Get the managementGroupIds property: Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under.
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 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.
PolicyEvaluationDetails	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	resourceTags() Get the resourceTags property: List of resource tags.
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 policy state record.
void	validate() Validates the instance.
PolicyStateInner	withAdditionalProperties(Map<String,Object> additionalProperties) Set the additionalProperties property: Policy state record.
PolicyStateInner	withComplianceState(String complianceState) Set the complianceState property: Compliance state of the resource.
PolicyStateInner	withComponents(List<ComponentStateDetails> components) Set the components property: Components state compliance records populated only when URL contains $expand=components clause.
PolicyStateInner	withEffectiveParameters(String effectiveParameters) Set the effectiveParameters property: Effective parameters for the policy assignment.
PolicyStateInner	withIsCompliant(Boolean isCompliant) Set the isCompliant property: Flag which states whether the resource is compliant against the policy assignment it was evaluated against.
PolicyStateInner	withManagementGroupIds(String managementGroupIds) Set the managementGroupIds property: Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under.
PolicyStateInner	withOdataContext(String odataContext) Set the odataContext property: OData context string; used by OData clients to resolve type information based on metadata.
PolicyStateInner	withOdataId(String odataId) Set the odataId property: OData entity ID; always set to null since policy state records do not have an entity ID.
PolicyStateInner	withPolicyAssignmentId(String policyAssignmentId) Set the policyAssignmentId property: Policy assignment ID.
PolicyStateInner	withPolicyAssignmentName(String policyAssignmentName) Set the policyAssignmentName property: Policy assignment name.
PolicyStateInner	withPolicyAssignmentOwner(String policyAssignmentOwner) Set the policyAssignmentOwner property: Policy assignment owner.
PolicyStateInner	withPolicyAssignmentParameters(String policyAssignmentParameters) Set the policyAssignmentParameters property: Policy assignment parameters.
PolicyStateInner	withPolicyAssignmentScope(String policyAssignmentScope) Set the policyAssignmentScope property: Policy assignment scope.
PolicyStateInner	withPolicyDefinitionAction(String policyDefinitionAction) Set the policyDefinitionAction property: Policy definition action, i.e.
PolicyStateInner	withPolicyDefinitionCategory(String policyDefinitionCategory) Set the policyDefinitionCategory property: Policy definition category.
PolicyStateInner	withPolicyDefinitionGroupNames(List<String> policyDefinitionGroupNames) Set the policyDefinitionGroupNames property: Policy definition group names.
PolicyStateInner	withPolicyDefinitionId(String policyDefinitionId) Set the policyDefinitionId property: Policy definition ID.
PolicyStateInner	withPolicyDefinitionName(String policyDefinitionName) Set the policyDefinitionName property: Policy definition name.
PolicyStateInner	withPolicyDefinitionReferenceId(String policyDefinitionReferenceId) Set the policyDefinitionReferenceId property: Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set.
PolicyStateInner	withPolicyEvaluationDetails(PolicyEvaluationDetails policyEvaluationDetails) Set the policyEvaluationDetails property: Policy evaluation details.
PolicyStateInner	withPolicySetDefinitionCategory(String policySetDefinitionCategory) Set the policySetDefinitionCategory property: Policy set definition category, if the policy assignment is for a policy set.
PolicyStateInner	withPolicySetDefinitionId(String policySetDefinitionId) Set the policySetDefinitionId property: Policy set definition ID, if the policy assignment is for a policy set.
PolicyStateInner	withPolicySetDefinitionName(String policySetDefinitionName) Set the policySetDefinitionName property: Policy set definition name, if the policy assignment is for a policy set.
PolicyStateInner	withPolicySetDefinitionOwner(String policySetDefinitionOwner) Set the policySetDefinitionOwner property: Policy set definition owner, if the policy assignment is for a policy set.
PolicyStateInner	withPolicySetDefinitionParameters(String policySetDefinitionParameters) Set the policySetDefinitionParameters property: Policy set definition parameters, if the policy assignment is for a policy set.
PolicyStateInner	withResourceGroup(String resourceGroup) Set the resourceGroup property: Resource group name.
PolicyStateInner	withResourceId(String resourceId) Set the resourceId property: Resource ID.
PolicyStateInner	withResourceLocation(String resourceLocation) Set the resourceLocation property: Resource location.
PolicyStateInner	withResourceTags(String resourceTags) Set the resourceTags property: List of resource tags.
PolicyStateInner	withResourceType(String resourceType) Set the resourceType property: Resource type.
PolicyStateInner	withSubscriptionId(String subscriptionId) Set the subscriptionId property: Subscription ID.
PolicyStateInner	withTimestamp(OffsetDateTime timestamp) Set the timestamp property: Timestamp for the policy state record.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

PolicyStateInner

public PolicyStateInner()

Creates an instance of PolicyStateInner class.

Method Details

additionalProperties

public Map additionalProperties()

Get the additionalProperties property: Policy state record.

Returns:

the additionalProperties value.

complianceState

public String complianceState()

Get the complianceState property: Compliance state of the resource.

Returns:

the complianceState value.

components

public List components()

Get the components property: Components state compliance records populated only when URL contains $expand=components clause.

Returns:

the components value.

effectiveParameters

public String effectiveParameters()

Get the effectiveParameters property: Effective parameters for the policy assignment.

Returns:

the effectiveParameters value.

isCompliant

public Boolean isCompliant()

Get the isCompliant property: Flag which states whether the resource is compliant against the policy assignment it was evaluated against. This property is deprecated; please use ComplianceState instead.

Returns:

the isCompliant value.

managementGroupIds

public String managementGroupIds()

Get the managementGroupIds property: Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under.

Returns:

the managementGroupIds value.

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 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 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 PolicyEvaluationDetails policyEvaluationDetails()

Get the policyEvaluationDetails property: Policy evaluation details.

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.

resourceTags

public String resourceTags()

Get the resourceTags property: List of resource tags.

Returns:

the resourceTags 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 policy state record.

Returns:

the timestamp value.

validate

public void validate()

Validates the instance.

withAdditionalProperties

public PolicyStateInner withAdditionalProperties(Map additionalProperties)

Set the additionalProperties property: Policy state record.

Parameters:

additionalProperties - the additionalProperties value to set.

Returns:

the PolicyStateInner object itself.

withComplianceState

public PolicyStateInner withComplianceState(String complianceState)

Set the complianceState property: Compliance state of the resource.

Parameters:

complianceState - the complianceState value to set.

Returns:

the PolicyStateInner object itself.

withComponents

public PolicyStateInner withComponents(List components)

Set the components property: Components state compliance records populated only when URL contains $expand=components clause.

Parameters:

components - the components value to set.

Returns:

the PolicyStateInner object itself.

withEffectiveParameters

public PolicyStateInner withEffectiveParameters(String effectiveParameters)

Set the effectiveParameters property: Effective parameters for the policy assignment.

Parameters:

effectiveParameters - the effectiveParameters value to set.

Returns:

the PolicyStateInner object itself.

withIsCompliant

public PolicyStateInner withIsCompliant(Boolean isCompliant)

Set the isCompliant property: Flag which states whether the resource is compliant against the policy assignment it was evaluated against. This property is deprecated; please use ComplianceState instead.

Parameters:

isCompliant - the isCompliant value to set.

Returns:

the PolicyStateInner object itself.

withManagementGroupIds

public PolicyStateInner withManagementGroupIds(String managementGroupIds)

Set the managementGroupIds property: Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under.

Parameters:

managementGroupIds - the managementGroupIds value to set.

Returns:

the PolicyStateInner object itself.

withOdataContext

public PolicyStateInner withOdataContext(String odataContext)

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

Parameters:

odataContext - the odataContext value to set.

Returns:

the PolicyStateInner object itself.

withOdataId

public PolicyStateInner withOdataId(String odataId)

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

Parameters:

odataId - the odataId value to set.

Returns:

the PolicyStateInner object itself.

withPolicyAssignmentId

public PolicyStateInner withPolicyAssignmentId(String policyAssignmentId)

Set the policyAssignmentId property: Policy assignment ID.

Parameters:

policyAssignmentId - the policyAssignmentId value to set.

Returns:

the PolicyStateInner object itself.

withPolicyAssignmentName

public PolicyStateInner withPolicyAssignmentName(String policyAssignmentName)

Set the policyAssignmentName property: Policy assignment name.

Parameters:

policyAssignmentName - the policyAssignmentName value to set.

Returns:

the PolicyStateInner object itself.

withPolicyAssignmentOwner

public PolicyStateInner withPolicyAssignmentOwner(String policyAssignmentOwner)

Set the policyAssignmentOwner property: Policy assignment owner.

Parameters:

policyAssignmentOwner - the policyAssignmentOwner value to set.

Returns:

the PolicyStateInner object itself.

withPolicyAssignmentParameters

public PolicyStateInner withPolicyAssignmentParameters(String policyAssignmentParameters)

Set the policyAssignmentParameters property: Policy assignment parameters.

Parameters:

policyAssignmentParameters - the policyAssignmentParameters value to set.

Returns:

the PolicyStateInner object itself.

withPolicyAssignmentScope

public PolicyStateInner withPolicyAssignmentScope(String policyAssignmentScope)

Set the policyAssignmentScope property: Policy assignment scope.

Parameters:

policyAssignmentScope - the policyAssignmentScope value to set.

Returns:

the PolicyStateInner object itself.

withPolicyDefinitionAction

public PolicyStateInner withPolicyDefinitionAction(String policyDefinitionAction)

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

Parameters:

policyDefinitionAction - the policyDefinitionAction value to set.

Returns:

the PolicyStateInner object itself.

withPolicyDefinitionCategory

public PolicyStateInner withPolicyDefinitionCategory(String policyDefinitionCategory)

Set the policyDefinitionCategory property: Policy definition category.

Parameters:

policyDefinitionCategory - the policyDefinitionCategory value to set.

Returns:

the PolicyStateInner object itself.

withPolicyDefinitionGroupNames

public PolicyStateInner withPolicyDefinitionGroupNames(List policyDefinitionGroupNames)

Set the policyDefinitionGroupNames property: Policy definition group names.

Parameters:

policyDefinitionGroupNames - the policyDefinitionGroupNames value to set.

Returns:

the PolicyStateInner object itself.

withPolicyDefinitionId

public PolicyStateInner withPolicyDefinitionId(String policyDefinitionId)

Set the policyDefinitionId property: Policy definition ID.

Parameters:

policyDefinitionId - the policyDefinitionId value to set.

Returns:

the PolicyStateInner object itself.

withPolicyDefinitionName

public PolicyStateInner withPolicyDefinitionName(String policyDefinitionName)

Set the policyDefinitionName property: Policy definition name.

Parameters:

policyDefinitionName - the policyDefinitionName value to set.

Returns:

the PolicyStateInner object itself.

withPolicyDefinitionReferenceId

public PolicyStateInner withPolicyDefinitionReferenceId(String policyDefinitionReferenceId)

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

Parameters:

policyDefinitionReferenceId - the policyDefinitionReferenceId value to set.

Returns:

the PolicyStateInner object itself.

withPolicyEvaluationDetails

public PolicyStateInner withPolicyEvaluationDetails(PolicyEvaluationDetails policyEvaluationDetails)

Set the policyEvaluationDetails property: Policy evaluation details.

Parameters:

policyEvaluationDetails - the policyEvaluationDetails value to set.

Returns:

the PolicyStateInner object itself.

withPolicySetDefinitionCategory

public PolicyStateInner withPolicySetDefinitionCategory(String policySetDefinitionCategory)

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

Parameters:

policySetDefinitionCategory - the policySetDefinitionCategory value to set.

Returns:

the PolicyStateInner object itself.

withPolicySetDefinitionId

public PolicyStateInner withPolicySetDefinitionId(String policySetDefinitionId)

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

Parameters:

policySetDefinitionId - the policySetDefinitionId value to set.

Returns:

the PolicyStateInner object itself.

withPolicySetDefinitionName

public PolicyStateInner withPolicySetDefinitionName(String policySetDefinitionName)

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

Parameters:

policySetDefinitionName - the policySetDefinitionName value to set.

Returns:

the PolicyStateInner object itself.

withPolicySetDefinitionOwner

public PolicyStateInner withPolicySetDefinitionOwner(String policySetDefinitionOwner)

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

Parameters:

policySetDefinitionOwner - the policySetDefinitionOwner value to set.

Returns:

the PolicyStateInner object itself.

withPolicySetDefinitionParameters

public PolicyStateInner withPolicySetDefinitionParameters(String policySetDefinitionParameters)

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

Parameters:

policySetDefinitionParameters - the policySetDefinitionParameters value to set.

Returns:

the PolicyStateInner object itself.

withResourceGroup

public PolicyStateInner withResourceGroup(String resourceGroup)

Set the resourceGroup property: Resource group name.

Parameters:

resourceGroup - the resourceGroup value to set.

Returns:

the PolicyStateInner object itself.

withResourceId

public PolicyStateInner withResourceId(String resourceId)

Set the resourceId property: Resource ID.

Parameters:

resourceId - the resourceId value to set.

Returns:

the PolicyStateInner object itself.

withResourceLocation

public PolicyStateInner withResourceLocation(String resourceLocation)

Set the resourceLocation property: Resource location.

Parameters:

resourceLocation - the resourceLocation value to set.

Returns:

the PolicyStateInner object itself.

withResourceTags

public PolicyStateInner withResourceTags(String resourceTags)

Set the resourceTags property: List of resource tags.

Parameters:

resourceTags - the resourceTags value to set.

Returns:

the PolicyStateInner object itself.

withResourceType

public PolicyStateInner withResourceType(String resourceType)

Set the resourceType property: Resource type.

Parameters:

resourceType - the resourceType value to set.

Returns:

the PolicyStateInner object itself.

withSubscriptionId

public PolicyStateInner withSubscriptionId(String subscriptionId)

Set the subscriptionId property: Subscription ID.

Parameters:

subscriptionId - the subscriptionId value to set.

Returns:

the PolicyStateInner object itself.

withTimestamp

public PolicyStateInner withTimestamp(OffsetDateTime timestamp)

Set the timestamp property: Timestamp for the policy state record.

Parameters:

timestamp - the timestamp value to set.

Returns:

the PolicyStateInner object itself.