Class ListPrincipalsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ram.model.RamRequest
software.amazon.awssdk.services.ram.model.ListPrincipalsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListPrincipalsRequest.Builder,ListPrincipalsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListPrincipalsRequest extends RamRequest implements ToCopyableBuilder<ListPrincipalsRequest.Builder,ListPrincipalsRequest>

  • Method Details

    • resourceOwner

      public final ResourceOwner resourceOwner()

      Specifies that you want to list information for only resource shares that match the following:

      • SELF – principals that your account is sharing resources with

      • OTHER-ACCOUNTS – principals that are sharing resources with your account

      If the service returns an enum value that is not available in the current SDK version, resourceOwner will return ResourceOwner.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceOwnerAsString().

      Returns:
      Specifies that you want to list information for only resource shares that match the following:

      • SELF – principals that your account is sharing resources with

      • OTHER-ACCOUNTS – principals that are sharing resources with your account

      See Also:

    • resourceOwnerAsString

      public final String resourceOwnerAsString()

      Specifies that you want to list information for only resource shares that match the following:

      • SELF – principals that your account is sharing resources with

      • OTHER-ACCOUNTS – principals that are sharing resources with your account

      If the service returns an enum value that is not available in the current SDK version, resourceOwner will return ResourceOwner.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceOwnerAsString().

      Returns:
      Specifies that you want to list information for only resource shares that match the following:

      • SELF – principals that your account is sharing resources with

      • OTHER-ACCOUNTS – principals that are sharing resources with your account

      See Also:

    • resourceArn

      public final String resourceArn()

      Specifies that you want to list principal information for the resource share with the specified Amazon Resource Name (ARN).

      Returns:
      Specifies that you want to list principal information for the resource share with the specified Amazon Resource Name (ARN).

    • hasPrincipals

      public final boolean hasPrincipals()
      For responses, this returns true if the service returned a value for the Principals property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • principals

      public final List<String> principals()

      Specifies that you want to list information for only the listed principals.

      You can include the following values:

      • An Amazon Web Services account ID, for example: 123456789012

      • An Amazon Resource Name (ARN) of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid

      • An ARN of an organizational unit (OU) in Organizations, for example: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123

      • An ARN of an IAM role, for example: iam::123456789012:role/rolename

      • An ARN of an IAM user, for example: iam::123456789012user/username

      Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPrincipals() method.

      Returns:
      Specifies that you want to list information for only the listed principals.

      You can include the following values:

      • An Amazon Web Services account ID, for example: 123456789012

      • An Amazon Resource Name (ARN) of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid

      • An ARN of an organizational unit (OU) in Organizations, for example: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123

      • An ARN of an IAM role, for example: iam::123456789012:role/rolename

      • An ARN of an IAM user, for example: iam::123456789012user/username

      Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.

    • resourceType

      public final String resourceType()

      Specifies that you want to list information for only principals associated with resource shares that include the specified resource type.

      For a list of valid values, query the ListResourceTypes operation.

      Returns:
      Specifies that you want to list information for only principals associated with resource shares that include the specified resource type.

      For a list of valid values, query the ListResourceTypes operation.

    • hasResourceShareArns

      public final boolean hasResourceShareArns()
      For responses, this returns true if the service returned a value for the ResourceShareArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • resourceShareArns

      public final List<String> resourceShareArns()

      Specifies that you want to list information for only principals associated with the resource shares specified by a list the Amazon Resource Names (ARNs).

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResourceShareArns() method.

      Returns:
      Specifies that you want to list information for only principals associated with the resource shares specified by a list the Amazon Resource Names (ARNs).

    • nextToken

      public final String nextToken()

      Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

      Returns:
      Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

    • maxResults

      public final Integer maxResults()

      Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

      Returns:
      Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    • toBuilder

      public ListPrincipalsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListPrincipalsRequest.Builder,ListPrincipalsRequest>
      Specified by:
      toBuilder in class RamRequest
      Returns:
      a builder for type T

    • builder

      public static ListPrincipalsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListPrincipalsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.