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

Class GetResourceSharesRequest

    • Method Detail

      • 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 the Amazon Resource Names (ARNs) of individual resource shares that you want information about.

        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 the Amazon Resource Names (ARNs) of individual resource shares that you want information about.

      • resourceShareStatus

        public final ResourceShareStatus resourceShareStatus()

        Specifies that you want to retrieve details of only those resource shares that have this status.

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

        Returns:
        Specifies that you want to retrieve details of only those resource shares that have this status.
        See Also:
        ResourceShareStatus

      • resourceShareStatusAsString

        public final String resourceShareStatusAsString()

        Specifies that you want to retrieve details of only those resource shares that have this status.

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

        Returns:
        Specifies that you want to retrieve details of only those resource shares that have this status.
        See Also:
        ResourceShareStatus

      • resourceOwner

        public final ResourceOwner resourceOwner()

        Specifies that you want to retrieve details of only those resource shares that match the following:

        • SELF – resource shares that your account shares with other accounts

        • OTHER-ACCOUNTS – resource shares 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 retrieve details of only those resource shares that match the following:

        • SELF – resource shares that your account shares with other accounts

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

        See Also:
        ResourceOwner

      • resourceOwnerAsString

        public final String resourceOwnerAsString()

        Specifies that you want to retrieve details of only those resource shares that match the following:

        • SELF – resource shares that your account shares with other accounts

        • OTHER-ACCOUNTS – resource shares 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 retrieve details of only those resource shares that match the following:

        • SELF – resource shares that your account shares with other accounts

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

        See Also:
        ResourceOwner

      • name

        public final String name()

        Specifies the name of an individual resource share that you want to retrieve details about.

        Returns:
        Specifies the name of an individual resource share that you want to retrieve details about.

      • hasTagFilters

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

      • tagFilters

        public final List<TagFilter> tagFilters()

        Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.

        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 hasTagFilters() method.

        Returns:
        Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.

      • 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.

      • permissionArn

        public final String permissionArn()

        Specifies that you want to retrieve details of only those resource shares that use the managed permission with this Amazon Resource Name (ARN).

        Returns:
        Specifies that you want to retrieve details of only those resource shares that use the managed permission with this Amazon Resource Name (ARN).

      • permissionVersion

        public final Integer permissionVersion()

        Specifies that you want to retrieve details for only those resource shares that use the specified version of the managed permission.

        Returns:
        Specifies that you want to retrieve details for only those resource shares that use the specified version of the managed permission.

      • 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