com.amazonaws.services.ram.model

Class ListPrincipalsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ram.model.ListPrincipalsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListPrincipalsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListPrincipalsRequest()

Method Summary

Modifier and Type	Method and Description
ListPrincipalsRequest	clone()
boolean	equals(Object obj)
Integer	getMaxResults() The maximum number of results to return with a single call.
String	getNextToken() The token for the next page of results.
List<String>	getPrincipals() The principals.
String	getResourceArn() The Amazon Resource Name (ARN) of the resource.
String	getResourceOwner() The type of owner.
List<String>	getResourceShareArns() The Amazon Resource Names (ARN) of the resource shares.
String	getResourceType() The resource type.
int	hashCode()
void	setMaxResults(Integer maxResults) The maximum number of results to return with a single call.
void	setNextToken(String nextToken) The token for the next page of results.
void	setPrincipals(Collection<String> principals) The principals.
void	setResourceArn(String resourceArn) The Amazon Resource Name (ARN) of the resource.
void	setResourceOwner(String resourceOwner) The type of owner.
void	setResourceShareArns(Collection<String> resourceShareArns) The Amazon Resource Names (ARN) of the resource shares.
void	setResourceType(String resourceType) The resource type.
String	toString() Returns a string representation of this object.
ListPrincipalsRequest	withMaxResults(Integer maxResults) The maximum number of results to return with a single call.
ListPrincipalsRequest	withNextToken(String nextToken) The token for the next page of results.
ListPrincipalsRequest	withPrincipals(Collection<String> principals) The principals.
ListPrincipalsRequest	withPrincipals(String... principals) The principals.
ListPrincipalsRequest	withResourceArn(String resourceArn) The Amazon Resource Name (ARN) of the resource.
ListPrincipalsRequest	withResourceOwner(ResourceOwner resourceOwner) The type of owner.
ListPrincipalsRequest	withResourceOwner(String resourceOwner) The type of owner.
ListPrincipalsRequest	withResourceShareArns(Collection<String> resourceShareArns) The Amazon Resource Names (ARN) of the resource shares.
ListPrincipalsRequest	withResourceShareArns(String... resourceShareArns) The Amazon Resource Names (ARN) of the resource shares.
ListPrincipalsRequest	withResourceType(String resourceType) The resource type.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListPrincipalsRequest

public ListPrincipalsRequest()

Method Detail

setResourceOwner

public void setResourceOwner(String resourceOwner)

The type of owner.

Parameters:

resourceOwner - The type of owner.

See Also:

ResourceOwner

getResourceOwner

public String getResourceOwner()

The type of owner.

Returns:

The type of owner.

See Also:

ResourceOwner

withResourceOwner

public ListPrincipalsRequest withResourceOwner(String resourceOwner)

The type of owner.

Parameters:

resourceOwner - The type of owner.

Returns:

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

See Also:

ResourceOwner

withResourceOwner

public ListPrincipalsRequest withResourceOwner(ResourceOwner resourceOwner)

The type of owner.

Parameters:

resourceOwner - The type of owner.

Returns:

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

See Also:

ResourceOwner

setResourceArn

public void setResourceArn(String resourceArn)

The Amazon Resource Name (ARN) of the resource.

Parameters:

resourceArn - The Amazon Resource Name (ARN) of the resource.

getResourceArn

public String getResourceArn()

The Amazon Resource Name (ARN) of the resource.

Returns:

The Amazon Resource Name (ARN) of the resource.

withResourceArn

public ListPrincipalsRequest withResourceArn(String resourceArn)

The Amazon Resource Name (ARN) of the resource.

Parameters:

resourceArn - The Amazon Resource Name (ARN) of the resource.

Returns:

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

getPrincipals

public List<String> getPrincipals()

The principals.

Returns:

The principals.

setPrincipals

public void setPrincipals(Collection<String> principals)

The principals.

Parameters:

principals - The principals.

withPrincipals

public ListPrincipalsRequest withPrincipals(String... principals)

The principals.

NOTE: This method appends the values to the existing list (if any). Use setPrincipals(java.util.Collection) or withPrincipals(java.util.Collection) if you want to override the existing values.

Parameters:

principals - The principals.

Returns:

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

withPrincipals

public ListPrincipalsRequest withPrincipals(Collection<String> principals)

The principals.

Parameters:

principals - The principals.

Returns:

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

setResourceType

public void setResourceType(String resourceType)

The resource type.

Valid values: acm-pca:CertificateAuthority | appmesh:Mesh | codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:LocalGatewayRouteTable | ec2:PrefixList | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe | glue:Catalog | glue:Database | glue:Table | license-manager:LicenseConfiguration I network-firewall:FirewallPolicy | network-firewall:StatefulRuleGroup | network-firewall:StatelessRuleGroup | outposts:Outpost | resource-groups:Group | rds:Cluster | route53resolver:FirewallRuleGroup | route53resolver:ResolverQueryLogConfig | route53resolver:ResolverRule

Parameters:

resourceType - The resource type.

Valid values: acm-pca:CertificateAuthority | appmesh:Mesh | codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:LocalGatewayRouteTable | ec2:PrefixList | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe | glue:Catalog | glue:Database | glue:Table | license-manager:LicenseConfiguration I network-firewall:FirewallPolicy | network-firewall:StatefulRuleGroup | network-firewall:StatelessRuleGroup | outposts:Outpost | resource-groups:Group | rds:Cluster | route53resolver:FirewallRuleGroup |route53resolver:ResolverQueryLogConfig | route53resolver:ResolverRule

getResourceType

public String getResourceType()

The resource type.

Valid values: acm-pca:CertificateAuthority | appmesh:Mesh | codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:LocalGatewayRouteTable | ec2:PrefixList | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe | glue:Catalog | glue:Database | glue:Table | license-manager:LicenseConfiguration I network-firewall:FirewallPolicy | network-firewall:StatefulRuleGroup | network-firewall:StatelessRuleGroup | outposts:Outpost | resource-groups:Group | rds:Cluster | route53resolver:FirewallRuleGroup | route53resolver:ResolverQueryLogConfig | route53resolver:ResolverRule

Returns:

The resource type.

Valid values: acm-pca:CertificateAuthority | appmesh:Mesh | codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:LocalGatewayRouteTable | ec2:PrefixList | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe | glue:Catalog | glue:Database | glue:Table | license-manager:LicenseConfiguration I network-firewall:FirewallPolicy | network-firewall:StatefulRuleGroup | network-firewall:StatelessRuleGroup | outposts:Outpost | resource-groups:Group | rds:Cluster | route53resolver:FirewallRuleGroup |route53resolver:ResolverQueryLogConfig | route53resolver:ResolverRule

withResourceType

public ListPrincipalsRequest withResourceType(String resourceType)

The resource type.

Valid values: acm-pca:CertificateAuthority | appmesh:Mesh | codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:LocalGatewayRouteTable | ec2:PrefixList | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe | glue:Catalog | glue:Database | glue:Table | license-manager:LicenseConfiguration I network-firewall:FirewallPolicy | network-firewall:StatefulRuleGroup | network-firewall:StatelessRuleGroup | outposts:Outpost | resource-groups:Group | rds:Cluster | route53resolver:FirewallRuleGroup | route53resolver:ResolverQueryLogConfig | route53resolver:ResolverRule

Parameters:

resourceType - The resource type.

Valid values: acm-pca:CertificateAuthority | appmesh:Mesh | codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:LocalGatewayRouteTable | ec2:PrefixList | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe | glue:Catalog | glue:Database | glue:Table | license-manager:LicenseConfiguration I network-firewall:FirewallPolicy | network-firewall:StatefulRuleGroup | network-firewall:StatelessRuleGroup | outposts:Outpost | resource-groups:Group | rds:Cluster | route53resolver:FirewallRuleGroup |route53resolver:ResolverQueryLogConfig | route53resolver:ResolverRule

Returns:

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

getResourceShareArns

public List<String> getResourceShareArns()

The Amazon Resource Names (ARN) of the resource shares.

Returns:

The Amazon Resource Names (ARN) of the resource shares.

setResourceShareArns

public void setResourceShareArns(Collection<String> resourceShareArns)

The Amazon Resource Names (ARN) of the resource shares.

Parameters:

resourceShareArns - The Amazon Resource Names (ARN) of the resource shares.

withResourceShareArns

public ListPrincipalsRequest withResourceShareArns(String... resourceShareArns)

The Amazon Resource Names (ARN) of the resource shares.

NOTE: This method appends the values to the existing list (if any). Use setResourceShareArns(java.util.Collection) or withResourceShareArns(java.util.Collection) if you want to override the existing values.

Parameters:

resourceShareArns - The Amazon Resource Names (ARN) of the resource shares.

Returns:

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

withResourceShareArns

public ListPrincipalsRequest withResourceShareArns(Collection<String> resourceShareArns)

The Amazon Resource Names (ARN) of the resource shares.

Parameters:

resourceShareArns - The Amazon Resource Names (ARN) of the resource shares.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

The token for the next page of results.

Parameters:

nextToken - The token for the next page of results.

getNextToken

public String getNextToken()

The token for the next page of results.

Returns:

The token for the next page of results.

withNextToken

public ListPrincipalsRequest withNextToken(String nextToken)

The token for the next page of results.

Parameters:

nextToken - The token for the next page of results.

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Parameters:

maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

getMaxResults

public Integer getMaxResults()

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Returns:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

withMaxResults

public ListPrincipalsRequest withMaxResults(Integer maxResults)

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Parameters:

maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Returns:

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

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListPrincipalsRequest clone()

Overrides:

clone in class AmazonWebServiceRequest