com.amazonaws.services.verifiedpermissions.model.PolicyItem Maven / Gradle / Ivy
Show all versions of aws-java-sdk-verifiedpermissions Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.verifiedpermissions.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Contains information about a policy.
*
*
* This data type is used as a response parameter for the ListPolicies
* operation.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PolicyItem implements Serializable, Cloneable, StructuredPojo {
/**
*
* The identifier of the PolicyStore where the policy you want information about is stored.
*
*/
private String policyStoreId;
/**
*
* The identifier of the policy you want information about.
*
*/
private String policyId;
/**
*
* The type of the policy. This is one of the following values:
*
*
* -
*
* static
*
*
* -
*
* templateLinked
*
*
*
*/
private String policyType;
/**
*
* The principal associated with the policy.
*
*/
private EntityIdentifier principal;
/**
*
* The resource associated with the policy.
*
*/
private EntityIdentifier resource;
/**
*
* The action that a policy permits or forbids. For example,
* {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]}
* .
*
*/
private java.util.List actions;
/**
*
* The policy definition of an item in the list of policies returned.
*
*/
private PolicyDefinitionItem definition;
/**
*
* The date and time the policy was created.
*
*/
private java.util.Date createdDate;
/**
*
* The date and time the policy was most recently updated.
*
*/
private java.util.Date lastUpdatedDate;
/**
*
* The effect of the decision that a policy returns to an authorization request. For example,
* "effect": "Permit".
*
*/
private String effect;
/**
*
* The identifier of the PolicyStore where the policy you want information about is stored.
*
*
* @param policyStoreId
* The identifier of the PolicyStore where the policy you want information about is stored.
*/
public void setPolicyStoreId(String policyStoreId) {
this.policyStoreId = policyStoreId;
}
/**
*
* The identifier of the PolicyStore where the policy you want information about is stored.
*
*
* @return The identifier of the PolicyStore where the policy you want information about is stored.
*/
public String getPolicyStoreId() {
return this.policyStoreId;
}
/**
*
* The identifier of the PolicyStore where the policy you want information about is stored.
*
*
* @param policyStoreId
* The identifier of the PolicyStore where the policy you want information about is stored.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PolicyItem withPolicyStoreId(String policyStoreId) {
setPolicyStoreId(policyStoreId);
return this;
}
/**
*
* The identifier of the policy you want information about.
*
*
* @param policyId
* The identifier of the policy you want information about.
*/
public void setPolicyId(String policyId) {
this.policyId = policyId;
}
/**
*
* The identifier of the policy you want information about.
*
*
* @return The identifier of the policy you want information about.
*/
public String getPolicyId() {
return this.policyId;
}
/**
*
* The identifier of the policy you want information about.
*
*
* @param policyId
* The identifier of the policy you want information about.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PolicyItem withPolicyId(String policyId) {
setPolicyId(policyId);
return this;
}
/**
*
* The type of the policy. This is one of the following values:
*
*
* -
*
* static
*
*
* -
*
* templateLinked
*
*
*
*
* @param policyType
* The type of the policy. This is one of the following values:
*
* -
*
* static
*
*
* -
*
* templateLinked
*
*
* @see PolicyType
*/
public void setPolicyType(String policyType) {
this.policyType = policyType;
}
/**
*
* The type of the policy. This is one of the following values:
*
*
* -
*
* static
*
*
* -
*
* templateLinked
*
*
*
*
* @return The type of the policy. This is one of the following values:
*
* -
*
* static
*
*
* -
*
* templateLinked
*
*
* @see PolicyType
*/
public String getPolicyType() {
return this.policyType;
}
/**
*
* The type of the policy. This is one of the following values:
*
*
* -
*
* static
*
*
* -
*
* templateLinked
*
*
*
*
* @param policyType
* The type of the policy. This is one of the following values:
*
* -
*
* static
*
*
* -
*
* templateLinked
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see PolicyType
*/
public PolicyItem withPolicyType(String policyType) {
setPolicyType(policyType);
return this;
}
/**
*
* The type of the policy. This is one of the following values:
*
*
* -
*
* static
*
*
* -
*
* templateLinked
*
*
*
*
* @param policyType
* The type of the policy. This is one of the following values:
*
* -
*
* static
*
*
* -
*
* templateLinked
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see PolicyType
*/
public PolicyItem withPolicyType(PolicyType policyType) {
this.policyType = policyType.toString();
return this;
}
/**
*
* The principal associated with the policy.
*
*
* @param principal
* The principal associated with the policy.
*/
public void setPrincipal(EntityIdentifier principal) {
this.principal = principal;
}
/**
*
* The principal associated with the policy.
*
*
* @return The principal associated with the policy.
*/
public EntityIdentifier getPrincipal() {
return this.principal;
}
/**
*
* The principal associated with the policy.
*
*
* @param principal
* The principal associated with the policy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PolicyItem withPrincipal(EntityIdentifier principal) {
setPrincipal(principal);
return this;
}
/**
*
* The resource associated with the policy.
*
*
* @param resource
* The resource associated with the policy.
*/
public void setResource(EntityIdentifier resource) {
this.resource = resource;
}
/**
*
* The resource associated with the policy.
*
*
* @return The resource associated with the policy.
*/
public EntityIdentifier getResource() {
return this.resource;
}
/**
*
* The resource associated with the policy.
*
*
* @param resource
* The resource associated with the policy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PolicyItem withResource(EntityIdentifier resource) {
setResource(resource);
return this;
}
/**
*
* The action that a policy permits or forbids. For example,
* {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]}
* .
*
*
* @return The action that a policy permits or forbids. For example,
* {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]}
* .
*/
public java.util.List getActions() {
return actions;
}
/**
*
* The action that a policy permits or forbids. For example,
* {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]}
* .
*
*
* @param actions
* The action that a policy permits or forbids. For example,
* {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]}
* .
*/
public void setActions(java.util.Collection actions) {
if (actions == null) {
this.actions = null;
return;
}
this.actions = new java.util.ArrayList(actions);
}
/**
*
* The action that a policy permits or forbids. For example,
* {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]}
* .
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setActions(java.util.Collection)} or {@link #withActions(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param actions
* The action that a policy permits or forbids. For example,
* {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]}
* .
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PolicyItem withActions(ActionIdentifier... actions) {
if (this.actions == null) {
setActions(new java.util.ArrayList(actions.length));
}
for (ActionIdentifier ele : actions) {
this.actions.add(ele);
}
return this;
}
/**
*
* The action that a policy permits or forbids. For example,
* {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]}
* .
*
*
* @param actions
* The action that a policy permits or forbids. For example,
* {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]}
* .
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PolicyItem withActions(java.util.Collection actions) {
setActions(actions);
return this;
}
/**
*
* The policy definition of an item in the list of policies returned.
*
*
* @param definition
* The policy definition of an item in the list of policies returned.
*/
public void setDefinition(PolicyDefinitionItem definition) {
this.definition = definition;
}
/**
*
* The policy definition of an item in the list of policies returned.
*
*
* @return The policy definition of an item in the list of policies returned.
*/
public PolicyDefinitionItem getDefinition() {
return this.definition;
}
/**
*
* The policy definition of an item in the list of policies returned.
*
*
* @param definition
* The policy definition of an item in the list of policies returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PolicyItem withDefinition(PolicyDefinitionItem definition) {
setDefinition(definition);
return this;
}
/**
*
* The date and time the policy was created.
*
*
* @param createdDate
* The date and time the policy was created.
*/
public void setCreatedDate(java.util.Date createdDate) {
this.createdDate = createdDate;
}
/**
*
* The date and time the policy was created.
*
*
* @return The date and time the policy was created.
*/
public java.util.Date getCreatedDate() {
return this.createdDate;
}
/**
*
* The date and time the policy was created.
*
*
* @param createdDate
* The date and time the policy was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PolicyItem withCreatedDate(java.util.Date createdDate) {
setCreatedDate(createdDate);
return this;
}
/**
*
* The date and time the policy was most recently updated.
*
*
* @param lastUpdatedDate
* The date and time the policy was most recently updated.
*/
public void setLastUpdatedDate(java.util.Date lastUpdatedDate) {
this.lastUpdatedDate = lastUpdatedDate;
}
/**
*
* The date and time the policy was most recently updated.
*
*
* @return The date and time the policy was most recently updated.
*/
public java.util.Date getLastUpdatedDate() {
return this.lastUpdatedDate;
}
/**
*
* The date and time the policy was most recently updated.
*
*
* @param lastUpdatedDate
* The date and time the policy was most recently updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PolicyItem withLastUpdatedDate(java.util.Date lastUpdatedDate) {
setLastUpdatedDate(lastUpdatedDate);
return this;
}
/**
*
* The effect of the decision that a policy returns to an authorization request. For example,
* "effect": "Permit".
*
*
* @param effect
* The effect of the decision that a policy returns to an authorization request. For example,
* "effect": "Permit".
* @see PolicyEffect
*/
public void setEffect(String effect) {
this.effect = effect;
}
/**
*
* The effect of the decision that a policy returns to an authorization request. For example,
* "effect": "Permit".
*
*
* @return The effect of the decision that a policy returns to an authorization request. For example,
* "effect": "Permit".
* @see PolicyEffect
*/
public String getEffect() {
return this.effect;
}
/**
*
* The effect of the decision that a policy returns to an authorization request. For example,
* "effect": "Permit".
*
*
* @param effect
* The effect of the decision that a policy returns to an authorization request. For example,
* "effect": "Permit".
* @return Returns a reference to this object so that method calls can be chained together.
* @see PolicyEffect
*/
public PolicyItem withEffect(String effect) {
setEffect(effect);
return this;
}
/**
*
* The effect of the decision that a policy returns to an authorization request. For example,
* "effect": "Permit".
*
*
* @param effect
* The effect of the decision that a policy returns to an authorization request. For example,
* "effect": "Permit".
* @return Returns a reference to this object so that method calls can be chained together.
* @see PolicyEffect
*/
public PolicyItem withEffect(PolicyEffect effect) {
this.effect = effect.toString();
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getPolicyStoreId() != null)
sb.append("PolicyStoreId: ").append(getPolicyStoreId()).append(",");
if (getPolicyId() != null)
sb.append("PolicyId: ").append(getPolicyId()).append(",");
if (getPolicyType() != null)
sb.append("PolicyType: ").append(getPolicyType()).append(",");
if (getPrincipal() != null)
sb.append("Principal: ").append(getPrincipal()).append(",");
if (getResource() != null)
sb.append("Resource: ").append(getResource()).append(",");
if (getActions() != null)
sb.append("Actions: ").append(getActions()).append(",");
if (getDefinition() != null)
sb.append("Definition: ").append(getDefinition()).append(",");
if (getCreatedDate() != null)
sb.append("CreatedDate: ").append(getCreatedDate()).append(",");
if (getLastUpdatedDate() != null)
sb.append("LastUpdatedDate: ").append(getLastUpdatedDate()).append(",");
if (getEffect() != null)
sb.append("Effect: ").append(getEffect());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PolicyItem == false)
return false;
PolicyItem other = (PolicyItem) obj;
if (other.getPolicyStoreId() == null ^ this.getPolicyStoreId() == null)
return false;
if (other.getPolicyStoreId() != null && other.getPolicyStoreId().equals(this.getPolicyStoreId()) == false)
return false;
if (other.getPolicyId() == null ^ this.getPolicyId() == null)
return false;
if (other.getPolicyId() != null && other.getPolicyId().equals(this.getPolicyId()) == false)
return false;
if (other.getPolicyType() == null ^ this.getPolicyType() == null)
return false;
if (other.getPolicyType() != null && other.getPolicyType().equals(this.getPolicyType()) == false)
return false;
if (other.getPrincipal() == null ^ this.getPrincipal() == null)
return false;
if (other.getPrincipal() != null && other.getPrincipal().equals(this.getPrincipal()) == false)
return false;
if (other.getResource() == null ^ this.getResource() == null)
return false;
if (other.getResource() != null && other.getResource().equals(this.getResource()) == false)
return false;
if (other.getActions() == null ^ this.getActions() == null)
return false;
if (other.getActions() != null && other.getActions().equals(this.getActions()) == false)
return false;
if (other.getDefinition() == null ^ this.getDefinition() == null)
return false;
if (other.getDefinition() != null && other.getDefinition().equals(this.getDefinition()) == false)
return false;
if (other.getCreatedDate() == null ^ this.getCreatedDate() == null)
return false;
if (other.getCreatedDate() != null && other.getCreatedDate().equals(this.getCreatedDate()) == false)
return false;
if (other.getLastUpdatedDate() == null ^ this.getLastUpdatedDate() == null)
return false;
if (other.getLastUpdatedDate() != null && other.getLastUpdatedDate().equals(this.getLastUpdatedDate()) == false)
return false;
if (other.getEffect() == null ^ this.getEffect() == null)
return false;
if (other.getEffect() != null && other.getEffect().equals(this.getEffect()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPolicyStoreId() == null) ? 0 : getPolicyStoreId().hashCode());
hashCode = prime * hashCode + ((getPolicyId() == null) ? 0 : getPolicyId().hashCode());
hashCode = prime * hashCode + ((getPolicyType() == null) ? 0 : getPolicyType().hashCode());
hashCode = prime * hashCode + ((getPrincipal() == null) ? 0 : getPrincipal().hashCode());
hashCode = prime * hashCode + ((getResource() == null) ? 0 : getResource().hashCode());
hashCode = prime * hashCode + ((getActions() == null) ? 0 : getActions().hashCode());
hashCode = prime * hashCode + ((getDefinition() == null) ? 0 : getDefinition().hashCode());
hashCode = prime * hashCode + ((getCreatedDate() == null) ? 0 : getCreatedDate().hashCode());
hashCode = prime * hashCode + ((getLastUpdatedDate() == null) ? 0 : getLastUpdatedDate().hashCode());
hashCode = prime * hashCode + ((getEffect() == null) ? 0 : getEffect().hashCode());
return hashCode;
}
@Override
public PolicyItem clone() {
try {
return (PolicyItem) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.verifiedpermissions.model.transform.PolicyItemMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}