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

Class ListResourcesRequest

    • Method Detail

      • 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:
        ResourceOwner

      • 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:
        ResourceOwner

      • 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:
        ResourceRegionScopeFilter

      • 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:
        ResourceRegionScopeFilter

      • 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