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

Class StartSearchResultExportJobRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartSearchResultExportJobRequest.Builder,StartSearchResultExportJobRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartSearchResultExportJobRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartSearchResultExportJobRequest.Builder	builder()
String	clientToken()	Include this parameter to allow multiple identical calls for idempotency.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ExportSpecification	exportSpecification()	This specification contains a required string of the destination bucket; optionally, you can include the destination prefix.
<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.
String	roleArn()	This parameter specifies the role ARN used to start the search results export jobs.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
String	searchJobIdentifier()	The unique string that specifies the search job.
static Class<? extends StartSearchResultExportJobRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	Optional tags to include.
StartSearchResultExportJobRequest.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

searchJobIdentifier

public final String searchJobIdentifier()

The unique string that specifies the search job.

Returns:

The unique string that specifies the search job.

exportSpecification

public final ExportSpecification exportSpecification()

This specification contains a required string of the destination bucket; optionally, you can include the destination prefix.

Returns:

This specification contains a required string of the destination bucket; optionally, you can include the destination prefix.

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.

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()

Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

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:

Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

roleArn

public final String roleArn()

This parameter specifies the role ARN used to start the search results export jobs.

Returns:

This parameter specifies the role ARN used to start the search results export jobs.

toBuilder

public StartSearchResultExportJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartSearchResultExportJobRequest.Builder,StartSearchResultExportJobRequest>

Specified by:

toBuilder in class BackupSearchRequest

builder

public static StartSearchResultExportJobRequest.Builder builder()

serializableBuilderClass

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