Package software.amazon.awssdk.services.deadline.model

Class SearchJobsRequest

    • Method Detail

      • farmId

        public final String farmId()

        The farm ID of the job.

        Returns:
        The farm ID of the job.

      • filterExpressions

        public final SearchGroupedFilterExpressions filterExpressions()

        The filter expression, AND or OR, to use when searching among a group of search strings in a resource.

        You can use two groupings per search each within parenthesis ().

        Returns:
        The filter expression, AND or OR, to use when searching among a group of search strings in a resource.

        You can use two groupings per search each within parenthesis ().

      • itemOffset

        public final Integer itemOffset()

        Defines how far into the scrollable list to start the return of results.

        Returns:
        Defines how far into the scrollable list to start the return of results.

      • pageSize

        public final Integer pageSize()

        Specifies the number of items per page for the resource.

        Returns:
        Specifies the number of items per page for the resource.

      • hasQueueIds

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

      • queueIds

        public final List<String> queueIds()

        The queue ID to use in the job search.

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

        Returns:
        The queue ID to use in the job search.

      • hasSortExpressions

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

      • sortExpressions

        public final List<SearchSortExpression> sortExpressions()

        The search terms for a resource.

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

        Returns:
        The search terms for a resource.

      • 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