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

Class SearchStepsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.deadline.model.DeadlineRequest

software.amazon.awssdk.services.deadline.model.SearchStepsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchStepsRequest.Builder,SearchStepsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class SearchStepsRequest
extends DeadlineRequest
implements ToCopyableBuilder<SearchStepsRequest.Builder,SearchStepsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchStepsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static SearchStepsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	farmId()	The farm ID to use for the step search.
SearchGroupedFilterExpressions	filterExpressions()	The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasQueueIds()	For responses, this returns true if the service returned a value for the QueueIds property.
boolean	hasSortExpressions()	For responses, this returns true if the service returned a value for the SortExpressions property.
Integer	itemOffset()	Defines how far into the scrollable list to start the return of results.
String	jobId()	The job ID to use in the step search.
Integer	pageSize()	Specifies the number of items per page for the resource.
List<String>	queueIds()	The queue IDs in the step search.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchStepsRequest.Builder>	serializableBuilderClass()
List<SearchSortExpression>	sortExpressions()	The search terms for a resource.
SearchStepsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

farmId

public final String farmId()

The farm ID to use for the step search.

Returns:

The farm ID to use for the step search.

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.

jobId

public final String jobId()

The job ID to use in the step search.

Returns:

The job ID to use in the step search.

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 IDs in the step 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 IDs in the step 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.

toBuilder

public SearchStepsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchStepsRequest.Builder,SearchStepsRequest>

Specified by:

toBuilder in class DeadlineRequest

builder

public static SearchStepsRequest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo