com.amazonaws.services.iotsitewise.model.CreateAccessPolicyRequest Maven / Gradle / Ivy
/*
* Copyright 2016-2021 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.iotsitewise.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateAccessPolicyRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The identity for this access policy. Choose an Amazon Web Services SSO user, an Amazon Web Services SSO group, or
* an IAM user.
*
*/
private Identity accessPolicyIdentity;
/**
*
* The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.
*
*/
private Resource accessPolicyResource;
/**
*
* The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a
* project owner.
*
*/
private String accessPolicyPermission;
/**
*
* A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse
* this client token if a new idempotent request is required.
*
*/
private String clientToken;
/**
*
* A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your IoT SiteWise
* resources in the IoT SiteWise User Guide.
*
*/
private java.util.Map tags;
/**
*
* The identity for this access policy. Choose an Amazon Web Services SSO user, an Amazon Web Services SSO group, or
* an IAM user.
*
*
* @param accessPolicyIdentity
* The identity for this access policy. Choose an Amazon Web Services SSO user, an Amazon Web Services SSO
* group, or an IAM user.
*/
public void setAccessPolicyIdentity(Identity accessPolicyIdentity) {
this.accessPolicyIdentity = accessPolicyIdentity;
}
/**
*
* The identity for this access policy. Choose an Amazon Web Services SSO user, an Amazon Web Services SSO group, or
* an IAM user.
*
*
* @return The identity for this access policy. Choose an Amazon Web Services SSO user, an Amazon Web Services SSO
* group, or an IAM user.
*/
public Identity getAccessPolicyIdentity() {
return this.accessPolicyIdentity;
}
/**
*
* The identity for this access policy. Choose an Amazon Web Services SSO user, an Amazon Web Services SSO group, or
* an IAM user.
*
*
* @param accessPolicyIdentity
* The identity for this access policy. Choose an Amazon Web Services SSO user, an Amazon Web Services SSO
* group, or an IAM user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAccessPolicyRequest withAccessPolicyIdentity(Identity accessPolicyIdentity) {
setAccessPolicyIdentity(accessPolicyIdentity);
return this;
}
/**
*
* The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.
*
*
* @param accessPolicyResource
* The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.
*/
public void setAccessPolicyResource(Resource accessPolicyResource) {
this.accessPolicyResource = accessPolicyResource;
}
/**
*
* The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.
*
*
* @return The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.
*/
public Resource getAccessPolicyResource() {
return this.accessPolicyResource;
}
/**
*
* The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.
*
*
* @param accessPolicyResource
* The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAccessPolicyRequest withAccessPolicyResource(Resource accessPolicyResource) {
setAccessPolicyResource(accessPolicyResource);
return this;
}
/**
*
* The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a
* project owner.
*
*
* @param accessPolicyPermission
* The permission level for this access policy. Note that a project ADMINISTRATOR is also known
* as a project owner.
* @see Permission
*/
public void setAccessPolicyPermission(String accessPolicyPermission) {
this.accessPolicyPermission = accessPolicyPermission;
}
/**
*
* The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a
* project owner.
*
*
* @return The permission level for this access policy. Note that a project ADMINISTRATOR is also known
* as a project owner.
* @see Permission
*/
public String getAccessPolicyPermission() {
return this.accessPolicyPermission;
}
/**
*
* The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a
* project owner.
*
*
* @param accessPolicyPermission
* The permission level for this access policy. Note that a project ADMINISTRATOR is also known
* as a project owner.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Permission
*/
public CreateAccessPolicyRequest withAccessPolicyPermission(String accessPolicyPermission) {
setAccessPolicyPermission(accessPolicyPermission);
return this;
}
/**
*
* The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a
* project owner.
*
*
* @param accessPolicyPermission
* The permission level for this access policy. Note that a project ADMINISTRATOR is also known
* as a project owner.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Permission
*/
public CreateAccessPolicyRequest withAccessPolicyPermission(Permission accessPolicyPermission) {
this.accessPolicyPermission = accessPolicyPermission.toString();
return this;
}
/**
*
* A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse
* this client token if a new idempotent request is required.
*
*
* @param clientToken
* A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't
* reuse this client token if a new idempotent request is required.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse
* this client token if a new idempotent request is required.
*
*
* @return A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't
* reuse this client token if a new idempotent request is required.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse
* this client token if a new idempotent request is required.
*
*
* @param clientToken
* A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't
* reuse this client token if a new idempotent request is required.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAccessPolicyRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
*
* A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your IoT SiteWise
* resources in the IoT SiteWise User Guide.
*
*
* @return A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your IoT
* SiteWise resources in the IoT SiteWise User Guide.
*/
public java.util.Map getTags() {
return tags;
}
/**
*
* A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your IoT SiteWise
* resources in the IoT SiteWise User Guide.
*
*
* @param tags
* A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your IoT
* SiteWise resources in the IoT SiteWise User Guide.
*/
public void setTags(java.util.Map tags) {
this.tags = tags;
}
/**
*
* A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your IoT SiteWise
* resources in the IoT SiteWise User Guide.
*
*
* @param tags
* A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your IoT
* SiteWise resources in the IoT SiteWise User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAccessPolicyRequest withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see CreateAccessPolicyRequest#withTags
* @returns a reference to this object so that method calls can be chained together.
*/
public CreateAccessPolicyRequest addTagsEntry(String key, String value) {
if (null == this.tags) {
this.tags = new java.util.HashMap();
}
if (this.tags.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.tags.put(key, value);
return this;
}
/**
* Removes all the entries added into Tags.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAccessPolicyRequest clearTagsEntries() {
this.tags = null;
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 (getAccessPolicyIdentity() != null)
sb.append("AccessPolicyIdentity: ").append(getAccessPolicyIdentity()).append(",");
if (getAccessPolicyResource() != null)
sb.append("AccessPolicyResource: ").append(getAccessPolicyResource()).append(",");
if (getAccessPolicyPermission() != null)
sb.append("AccessPolicyPermission: ").append(getAccessPolicyPermission()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateAccessPolicyRequest == false)
return false;
CreateAccessPolicyRequest other = (CreateAccessPolicyRequest) obj;
if (other.getAccessPolicyIdentity() == null ^ this.getAccessPolicyIdentity() == null)
return false;
if (other.getAccessPolicyIdentity() != null && other.getAccessPolicyIdentity().equals(this.getAccessPolicyIdentity()) == false)
return false;
if (other.getAccessPolicyResource() == null ^ this.getAccessPolicyResource() == null)
return false;
if (other.getAccessPolicyResource() != null && other.getAccessPolicyResource().equals(this.getAccessPolicyResource()) == false)
return false;
if (other.getAccessPolicyPermission() == null ^ this.getAccessPolicyPermission() == null)
return false;
if (other.getAccessPolicyPermission() != null && other.getAccessPolicyPermission().equals(this.getAccessPolicyPermission()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAccessPolicyIdentity() == null) ? 0 : getAccessPolicyIdentity().hashCode());
hashCode = prime * hashCode + ((getAccessPolicyResource() == null) ? 0 : getAccessPolicyResource().hashCode());
hashCode = prime * hashCode + ((getAccessPolicyPermission() == null) ? 0 : getAccessPolicyPermission().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateAccessPolicyRequest clone() {
return (CreateAccessPolicyRequest) super.clone();
}
}