com.amazonaws.services.simplesystemsmanagement.model.DescribeDocumentPermissionRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ssm 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.simplesystemsmanagement.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 DescribeDocumentPermissionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the document for which you are the owner.
*
*/
private String name;
/**
*
* The permission type for the document. The permission type can be Share.
*
*/
private String permissionType;
/**
*
* The maximum number of items to return for this call. The call also returns a token that you can specify in a
* subsequent call to get the next set of results.
*
*/
private Integer maxResults;
/**
*
* The token for the next set of items to return. (You received this token from a previous call.)
*
*/
private String nextToken;
/**
*
* The name of the document for which you are the owner.
*
*
* @param name
* The name of the document for which you are the owner.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the document for which you are the owner.
*
*
* @return The name of the document for which you are the owner.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the document for which you are the owner.
*
*
* @param name
* The name of the document for which you are the owner.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDocumentPermissionRequest withName(String name) {
setName(name);
return this;
}
/**
*
* The permission type for the document. The permission type can be Share.
*
*
* @param permissionType
* The permission type for the document. The permission type can be Share.
* @see DocumentPermissionType
*/
public void setPermissionType(String permissionType) {
this.permissionType = permissionType;
}
/**
*
* The permission type for the document. The permission type can be Share.
*
*
* @return The permission type for the document. The permission type can be Share.
* @see DocumentPermissionType
*/
public String getPermissionType() {
return this.permissionType;
}
/**
*
* The permission type for the document. The permission type can be Share.
*
*
* @param permissionType
* The permission type for the document. The permission type can be Share.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DocumentPermissionType
*/
public DescribeDocumentPermissionRequest withPermissionType(String permissionType) {
setPermissionType(permissionType);
return this;
}
/**
*
* The permission type for the document. The permission type can be Share.
*
*
* @param permissionType
* The permission type for the document. The permission type can be Share.
* @see DocumentPermissionType
*/
public void setPermissionType(DocumentPermissionType permissionType) {
withPermissionType(permissionType);
}
/**
*
* The permission type for the document. The permission type can be Share.
*
*
* @param permissionType
* The permission type for the document. The permission type can be Share.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DocumentPermissionType
*/
public DescribeDocumentPermissionRequest withPermissionType(DocumentPermissionType permissionType) {
this.permissionType = permissionType.toString();
return this;
}
/**
*
* The maximum number of items to return for this call. The call also returns a token that you can specify in a
* subsequent call to get the next set of results.
*
*
* @param maxResults
* The maximum number of items to return for this call. The call also returns a token that you can specify in
* a subsequent call to get the next set of results.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of items to return for this call. The call also returns a token that you can specify in a
* subsequent call to get the next set of results.
*
*
* @return The maximum number of items to return for this call. The call also returns a token that you can specify
* in a subsequent call to get the next set of results.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of items to return for this call. The call also returns a token that you can specify in a
* subsequent call to get the next set of results.
*
*
* @param maxResults
* The maximum number of items to return for this call. The call also returns a token that you can specify in
* a subsequent call to get the next set of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDocumentPermissionRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The token for the next set of items to return. (You received this token from a previous call.)
*
*
* @param nextToken
* The token for the next set of items to return. (You received this token from a previous call.)
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The token for the next set of items to return. (You received this token from a previous call.)
*
*
* @return The token for the next set of items to return. (You received this token from a previous call.)
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The token for the next set of items to return. (You received this token from a previous call.)
*
*
* @param nextToken
* The token for the next set of items to return. (You received this token from a previous call.)
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDocumentPermissionRequest withNextToken(String nextToken) {
setNextToken(nextToken);
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 (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getPermissionType() != null)
sb.append("PermissionType: ").append(getPermissionType()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeDocumentPermissionRequest == false)
return false;
DescribeDocumentPermissionRequest other = (DescribeDocumentPermissionRequest) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getPermissionType() == null ^ this.getPermissionType() == null)
return false;
if (other.getPermissionType() != null && other.getPermissionType().equals(this.getPermissionType()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getPermissionType() == null) ? 0 : getPermissionType().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public DescribeDocumentPermissionRequest clone() {
return (DescribeDocumentPermissionRequest) super.clone();
}
}