Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 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.identitymanagement.model;
 
 
Container for the parameters to the ListEntitiesForPolicy operation.

Lists all users, groups, and roles that the specified managed policy is attached to.

You can use the optional EntityFilter parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set EntityFilter to Role .

You can paginate the results using the MaxItems and Marker parameters.

 
 public class ListEntitiesForPolicyRequest extends AmazonWebServiceRequest implements SerializableCloneable {

    
The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Constraints:
Length: 20 - 2048

 
     private String policyArn;

    
The entity type to use for filtering the results.

For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned.

Constraints:
Allowed Values: User, Role, Group, LocalManagedPolicy, AWSManagedPolicy

 
     private String entityFilter;

    
The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.

Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)

 
     private String pathPrefix;

    
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*

 
     private String marker;

    
Use this only when paginating results to indicate the maximum number of entities you want in the response. If there are additional entities beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.

Constraints:
Range: 1 - 1000

 
     private Integer maxItems;

    
The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Constraints:
Length: 20 - 2048

Returns:
The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    public String getPolicyArn() {
        return ;
    }
    
    
The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Constraints:
Length: 20 - 2048

Parameters:
policyArn The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    public void setPolicyArn(String policyArn) {
        this. = policyArn;
    }
    
    
The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 20 - 2048

Parameters:
policyArn The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Returns:
A reference to this updated object so that method calls can be chained together.
    public ListEntitiesForPolicyRequest withPolicyArn(String policyArn) {
        this. = policyArn;
        return this;
    }

    
The entity type to use for filtering the results.

For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned.

Constraints:
Allowed Values: User, Role, Group, LocalManagedPolicy, AWSManagedPolicy

Returns:
The entity type to use for filtering the results.

For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned.

See also:
EntityType
    public String getEntityFilter() {
        return ;
    }
    
    
The entity type to use for filtering the results.

For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned.

Constraints:
Allowed Values: User, Role, Group, LocalManagedPolicy, AWSManagedPolicy

Parameters:
entityFilter The entity type to use for filtering the results.

For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned.

See also:
EntityType
    public void setEntityFilter(String entityFilter) {
        this. = entityFilter;
    }
    
    
The entity type to use for filtering the results.

For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: User, Role, Group, LocalManagedPolicy, AWSManagedPolicy

Parameters:
entityFilter The entity type to use for filtering the results.

For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned.

Returns:
A reference to this updated object so that method calls can be chained together.
See also:
EntityType
    public ListEntitiesForPolicyRequest withEntityFilter(String entityFilter) {
        this. = entityFilter;
        return this;
    }

    
The entity type to use for filtering the results.

For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned.

Constraints:
Allowed Values: User, Role, Group, LocalManagedPolicy, AWSManagedPolicy

Parameters:
entityFilter The entity type to use for filtering the results.

For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned.

See also:
EntityType
    public void setEntityFilter(EntityType entityFilter) {
        this. = entityFilter.toString();
    }
    
    
The entity type to use for filtering the results.

For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: User, Role, Group, LocalManagedPolicy, AWSManagedPolicy

Parameters:
entityFilter The entity type to use for filtering the results.

For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned.

Returns:
A reference to this updated object so that method calls can be chained together.
See also:
EntityType
        this. = entityFilter.toString();
        return this;
    }

    
The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.

Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)

Returns:
The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.
    public String getPathPrefix() {
        return ;
    }
    
    
The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.

Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)

Parameters:
pathPrefix The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.
    public void setPathPrefix(String pathPrefix) {
        this. = pathPrefix;
    }
    
    
The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)

Parameters:
pathPrefix The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.
Returns:
A reference to this updated object so that method calls can be chained together.
    public ListEntitiesForPolicyRequest withPathPrefix(String pathPrefix) {
        this. = pathPrefix;
        return this;
    }

    
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*

Returns:
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
    public String getMarker() {
        return ;
    }
    
    
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*

Parameters:
marker Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
    public void setMarker(String marker) {
        this. = marker;
    }
    
    
Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*

Parameters:
marker Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
Returns:
A reference to this updated object so that method calls can be chained together.
        this. = marker;
        return this;
    }

    
Use this only when paginating results to indicate the maximum number of entities you want in the response. If there are additional entities beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.

Constraints:
Range: 1 - 1000

Returns:
Use this only when paginating results to indicate the maximum number of entities you want in the response. If there are additional entities beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
    public Integer getMaxItems() {
        return ;
    }
    
    
Use this only when paginating results to indicate the maximum number of entities you want in the response. If there are additional entities beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.

Constraints:
Range: 1 - 1000

Parameters:
maxItems Use this only when paginating results to indicate the maximum number of entities you want in the response. If there are additional entities beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
    public void setMaxItems(Integer maxItems) {
        this. = maxItems;
    }
    
    
Use this only when paginating results to indicate the maximum number of entities you want in the response. If there are additional entities beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 - 1000

Parameters:
maxItems Use this only when paginating results to indicate the maximum number of entities you want in the response. If there are additional entities beyond the maximum you specify, the IsTruncated response element is true. This parameter is optional. If you do not include it, it defaults to 100.
Returns:
A reference to this updated object so that method calls can be chained together.
        this. = maxItems;
        return this;
    }

    
Returns a string representation of this object; useful for testing and debugging.

Returns:
A string representation of this object.
See also:
java.lang.Object.toString()
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getPolicyArn() != nullsb.append("PolicyArn: " + getPolicyArn() + ",");
        if (getEntityFilter() != nullsb.append("EntityFilter: " + getEntityFilter() + ",");
        if (getPathPrefix() != nullsb.append("PathPrefix: " + getPathPrefix() + ",");
        if (getMarker() != nullsb.append("Marker: " + getMarker() + ",");
        if (getMaxItems() != nullsb.append("MaxItems: " + getMaxItems() );
        sb.append("}");
        return sb.toString();
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        
        hashCode = prime * hashCode + ((getPolicyArn() == null) ? 0 : getPolicyArn().hashCode()); 
        hashCode = prime * hashCode + ((getEntityFilter() == null) ? 0 : getEntityFilter().hashCode()); 
        hashCode = prime * hashCode + ((getPathPrefix() == null) ? 0 : getPathPrefix().hashCode()); 
        hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode()); 
        hashCode = prime * hashCode + ((getMaxItems() == null) ? 0 : getMaxItems().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof ListEntitiesForPolicyRequest == falsereturn false;
        
        if (other.getPolicyArn() == null ^ this.getPolicyArn() == nullreturn false;
        if (other.getPolicyArn() != null && other.getPolicyArn().equals(this.getPolicyArn()) == falsereturn false
        if (other.getEntityFilter() == null ^ this.getEntityFilter() == nullreturn false;
        if (other.getEntityFilter() != null && other.getEntityFilter().equals(this.getEntityFilter()) == falsereturn false
        if (other.getPathPrefix() == null ^ this.getPathPrefix() == nullreturn false;
        if (other.getPathPrefix() != null && other.getPathPrefix().equals(this.getPathPrefix()) == falsereturn false
        if (other.getMarker() == null ^ this.getMarker() == nullreturn false;
        if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == falsereturn false
        if (other.getMaxItems() == null ^ this.getMaxItems() == nullreturn false;
        if (other.getMaxItems() != null && other.getMaxItems().equals(this.getMaxItems()) == falsereturn false
        return true;
    }
    
    @Override
        
            return (ListEntitiesForPolicyRequestsuper.clone();
    }
}
    
New to GrepCode? Check out our FAQ X