Package software.amazon.awssdk.services.ram.model

Class ListResourcesRequest

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.ListResourcesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListResourcesRequest.Builder,ListResourcesRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListResourcesRequest extends RamRequest implements ToCopyableBuilder<ListResourcesRequest.Builder,ListResourcesRequest>

  • Method Details

    • resourceOwner

      public final ResourceOwner resourceOwner()

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

      • SELF – resources that your account shares with other accounts

      • OTHER-ACCOUNTS – resources that other accounts share 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 only the resource shares that match the following:

      • SELF – resources that your account shares with other accounts

      • OTHER-ACCOUNTS – resources that other accounts share with your account

      See Also:

    • resourceOwnerAsString

      public final String resourceOwnerAsString()

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

      • SELF – resources that your account shares with other accounts

      • OTHER-ACCOUNTS – resources that other accounts share 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 only the resource shares that match the following:

      • SELF – resources that your account shares with other accounts

      • OTHER-ACCOUNTS – resources that other accounts share with your account

      See Also:

    • principal

      public final String principal()

      Specifies that you want to list only the resource shares that are associated with the specified principal.

      Returns:
      Specifies that you want to list only the resource shares that are associated with the specified principal.

    • resourceType

      public final String resourceType()

      Specifies that you want to list only the resource shares that include resources of the specified resource type.

      For valid values, query the ListResourceTypes operation.

      Returns:
      Specifies that you want to list only the resource shares that include resources of the specified resource type.

      For valid values, query the ListResourceTypes operation.

    • hasResourceArns

      public final boolean hasResourceArns()
      For responses, this returns true if the service returned a value for the ResourceArns 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.

    • resourceArns

      public final List<String> resourceArns()

      Specifies that you want to list only the resource shares that include resources with the specified 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 hasResourceArns() method.

      Returns:
      Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).

    • 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 only resources in the resource shares identified by the specified 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 only resources in the resource shares identified by the specified 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.

    • resourceRegionScope

      public final ResourceRegionScopeFilter resourceRegionScope()

      Specifies that you want the results to include only resources that have the specified scope.

      • ALL – the results include both global and regional resources or resource types.

      • GLOBAL – the results include only global resources or resource types.

      • REGIONAL – the results include only regional resources or resource types.

      The default value is ALL.

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

      Returns:
      Specifies that you want the results to include only resources that have the specified scope.

      • ALL – the results include both global and regional resources or resource types.

      • GLOBAL – the results include only global resources or resource types.

      • REGIONAL – the results include only regional resources or resource types.

      The default value is ALL.

      See Also:

    • resourceRegionScopeAsString

      public final String resourceRegionScopeAsString()

      Specifies that you want the results to include only resources that have the specified scope.

      • ALL – the results include both global and regional resources or resource types.

      • GLOBAL – the results include only global resources or resource types.

      • REGIONAL – the results include only regional resources or resource types.

      The default value is ALL.

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

      Returns:
      Specifies that you want the results to include only resources that have the specified scope.

      • ALL – the results include both global and regional resources or resource types.

      • GLOBAL – the results include only global resources or resource types.

      • REGIONAL – the results include only regional resources or resource types.

      The default value is ALL.

      See Also:

    • toBuilder

      public ListResourcesRequest.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<ListResourcesRequest.Builder,ListResourcesRequest>
      Specified by:
      toBuilder in class RamRequest
      Returns:
      a builder for type T

    • builder

      public static ListResourcesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListResourcesRequest.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.