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

Class StartSearchJobRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartSearchJobRequest.Builder,StartSearchJobRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartSearchJobRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartSearchJobRequest.Builder	builder()
String	clientToken()	Include this parameter to allow multiple identical calls for idempotency.
String	encryptionKeyArn()	The encryption key for the specified search job.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
ItemFilters	itemFilters()	Item Filters represent all input item properties specified when the search was created.
String	name()	Include alphanumeric characters to create a name for this search job.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
SearchScope	searchScope()	This object can contain BackupResourceTypes, BackupResourceArns, BackupResourceCreationTime, BackupResourceTags, and SourceResourceArns to filter the recovery points returned by the search job.
static Class<? extends StartSearchJobRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	List of tags returned by the operation.
StartSearchJobRequest.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

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final Map<String,String> tags()

List of tags returned by the operation.

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

Returns:

List of tags returned by the operation.

name

public final String name()

Include alphanumeric characters to create a name for this search job.

Returns:

Include alphanumeric characters to create a name for this search job.

encryptionKeyArn

public final String encryptionKeyArn()

The encryption key for the specified search job.

Returns:

The encryption key for the specified search job.

clientToken

public final String clientToken()

Include this parameter to allow multiple identical calls for idempotency.

A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.

Returns:

Include this parameter to allow multiple identical calls for idempotency.

A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.

searchScope

public final SearchScope searchScope()

This object can contain BackupResourceTypes, BackupResourceArns, BackupResourceCreationTime, BackupResourceTags, and SourceResourceArns to filter the recovery points returned by the search job.

Returns:

This object can contain BackupResourceTypes, BackupResourceArns, BackupResourceCreationTime, BackupResourceTags, and SourceResourceArns to filter the recovery points returned by the search job.

itemFilters

public final ItemFilters itemFilters()

Item Filters represent all input item properties specified when the search was created.

Contains either EBSItemFilters or S3ItemFilters

Returns:

Item Filters represent all input item properties specified when the search was created.

Contains either EBSItemFilters or S3ItemFilters

toBuilder

public StartSearchJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartSearchJobRequest.Builder,StartSearchJobRequest>

Specified by:

toBuilder in class BackupSearchRequest

builder

public static StartSearchJobRequest.Builder builder()

serializableBuilderClass

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