com.amazonaws.services.verifiedpermissions.model.TemplateLinkedPolicyDefinition 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 created by instantiating a policy template.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class TemplateLinkedPolicyDefinition implements Serializable, Cloneable, StructuredPojo {
/**
*
* The unique identifier of the policy template used to create this policy.
*
*/
private String policyTemplateId;
/**
*
* The principal associated with this template-linked policy. Verified Permissions substitutes this principal for
* the ?principal placeholder in the policy template when it evaluates an authorization request.
*
*/
private EntityIdentifier principal;
/**
*
* The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the
* ?resource placeholder in the policy template when it evaluates an authorization request.
*
*/
private EntityIdentifier resource;
/**
*
* The unique identifier of the policy template used to create this policy.
*
*
* @param policyTemplateId
* The unique identifier of the policy template used to create this policy.
*/
public void setPolicyTemplateId(String policyTemplateId) {
this.policyTemplateId = policyTemplateId;
}
/**
*
* The unique identifier of the policy template used to create this policy.
*
*
* @return The unique identifier of the policy template used to create this policy.
*/
public String getPolicyTemplateId() {
return this.policyTemplateId;
}
/**
*
* The unique identifier of the policy template used to create this policy.
*
*
* @param policyTemplateId
* The unique identifier of the policy template used to create this policy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TemplateLinkedPolicyDefinition withPolicyTemplateId(String policyTemplateId) {
setPolicyTemplateId(policyTemplateId);
return this;
}
/**
*
* The principal associated with this template-linked policy. Verified Permissions substitutes this principal for
* the ?principal placeholder in the policy template when it evaluates an authorization request.
*
*
* @param principal
* The principal associated with this template-linked policy. Verified Permissions substitutes this principal
* for the ?principal placeholder in the policy template when it evaluates an authorization
* request.
*/
public void setPrincipal(EntityIdentifier principal) {
this.principal = principal;
}
/**
*
* The principal associated with this template-linked policy. Verified Permissions substitutes this principal for
* the ?principal placeholder in the policy template when it evaluates an authorization request.
*
*
* @return The principal associated with this template-linked policy. Verified Permissions substitutes this
* principal for the ?principal placeholder in the policy template when it evaluates an
* authorization request.
*/
public EntityIdentifier getPrincipal() {
return this.principal;
}
/**
*
* The principal associated with this template-linked policy. Verified Permissions substitutes this principal for
* the ?principal placeholder in the policy template when it evaluates an authorization request.
*
*
* @param principal
* The principal associated with this template-linked policy. Verified Permissions substitutes this principal
* for the ?principal placeholder in the policy template when it evaluates an authorization
* request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TemplateLinkedPolicyDefinition withPrincipal(EntityIdentifier principal) {
setPrincipal(principal);
return this;
}
/**
*
* The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the
* ?resource placeholder in the policy template when it evaluates an authorization request.
*
*
* @param resource
* The resource associated with this template-linked policy. Verified Permissions substitutes this resource
* for the ?resource placeholder in the policy template when it evaluates an authorization
* request.
*/
public void setResource(EntityIdentifier resource) {
this.resource = resource;
}
/**
*
* The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the
* ?resource placeholder in the policy template when it evaluates an authorization request.
*
*
* @return The resource associated with this template-linked policy. Verified Permissions substitutes this resource
* for the ?resource placeholder in the policy template when it evaluates an authorization
* request.
*/
public EntityIdentifier getResource() {
return this.resource;
}
/**
*
* The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the
* ?resource placeholder in the policy template when it evaluates an authorization request.
*
*
* @param resource
* The resource associated with this template-linked policy. Verified Permissions substitutes this resource
* for the ?resource placeholder in the policy template when it evaluates an authorization
* request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TemplateLinkedPolicyDefinition withResource(EntityIdentifier resource) {
setResource(resource);
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 (getPolicyTemplateId() != null)
sb.append("PolicyTemplateId: ").append(getPolicyTemplateId()).append(",");
if (getPrincipal() != null)
sb.append("Principal: ").append(getPrincipal()).append(",");
if (getResource() != null)
sb.append("Resource: ").append(getResource());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof TemplateLinkedPolicyDefinition == false)
return false;
TemplateLinkedPolicyDefinition other = (TemplateLinkedPolicyDefinition) obj;
if (other.getPolicyTemplateId() == null ^ this.getPolicyTemplateId() == null)
return false;
if (other.getPolicyTemplateId() != null && other.getPolicyTemplateId().equals(this.getPolicyTemplateId()) == 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;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPolicyTemplateId() == null) ? 0 : getPolicyTemplateId().hashCode());
hashCode = prime * hashCode + ((getPrincipal() == null) ? 0 : getPrincipal().hashCode());
hashCode = prime * hashCode + ((getResource() == null) ? 0 : getResource().hashCode());
return hashCode;
}
@Override
public TemplateLinkedPolicyDefinition clone() {
try {
return (TemplateLinkedPolicyDefinition) 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.TemplateLinkedPolicyDefinitionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}