Class ListApplicationComponentsRequest

    • Method Detail

      • filterValue

        public final String filterValue()

        Specify the value based on the application component criteria type. For example, if applicationComponentCriteria is set to SERVER_ID and filterValue is set to server1, then ListApplicationComponents returns all the application components running on server1.

        Returns:
        Specify the value based on the application component criteria type. For example, if applicationComponentCriteria is set to SERVER_ID and filterValue is set to server1, then ListApplicationComponents returns all the application components running on server1.
      • hasGroupIdFilter

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

        public final List<Group> groupIdFilter()

        The group ID specified in to filter on.

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

        Returns:
        The group ID specified in to filter on.
      • maxResults

        public final Integer maxResults()

        The maximum number of items to include in the response. The maximum value is 100.

        Returns:
        The maximum number of items to include in the response. The maximum value is 100.
      • nextToken

        public final String nextToken()

        The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set maxResults to 10. You'll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

        Returns:
        The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set maxResults to 10. You'll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.
      • sort

        public final SortOrder sort()

        Specifies whether to sort by ascending (ASC) or descending (DESC) order.

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

        Returns:
        Specifies whether to sort by ascending (ASC) or descending (DESC) order.
        See Also:
        SortOrder
      • sortAsString

        public final String sortAsString()

        Specifies whether to sort by ascending (ASC) or descending (DESC) order.

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

        Returns:
        Specifies whether to sort by ascending (ASC) or descending (DESC) order.
        See Also:
        SortOrder
      • 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