Package software.amazon.awssdk.services.backupsearch.model

Class ListSearchJobsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.backupsearch.model.BackupSearchRequest

software.amazon.awssdk.services.backupsearch.model.ListSearchJobsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListSearchJobsRequest.Builder,ListSearchJobsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListSearchJobsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListSearchJobsRequest.Builder	builder()
SearchJobState	byStatus()	Include this parameter to filter list by search job status.
String	byStatusAsString()	Include this parameter to filter list by search job status.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of resource list items to be returned.
String	nextToken()	The next item following a partial list of returned search jobs.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListSearchJobsRequest.Builder>	serializableBuilderClass()
ListSearchJobsRequest.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

byStatus

public final SearchJobState byStatus()

Include this parameter to filter list by search job status.

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

Returns:

Include this parameter to filter list by search job status.

See Also:

SearchJobState

byStatusAsString

public final String byStatusAsString()

Include this parameter to filter list by search job status.

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

Returns:

Include this parameter to filter list by search job status.

See Also:

SearchJobState

nextToken

public final String nextToken()

The next item following a partial list of returned search jobs.

For example, if a request is made to return MaxResults number of backups, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Returns:

The next item following a partial list of returned search jobs.

For example, if a request is made to return MaxResults number of backups, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

maxResults

public final Integer maxResults()

The maximum number of resource list items to be returned.

Returns:

The maximum number of resource list items to be returned.

toBuilder

public ListSearchJobsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListSearchJobsRequest.Builder,ListSearchJobsRequest>

Specified by:

toBuilder in class BackupSearchRequest

builder

public static ListSearchJobsRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo