Package software.amazon.awssdk.services.datasync.model

Class StartDiscoveryJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.datasync.model.DataSyncRequest

software.amazon.awssdk.services.datasync.model.StartDiscoveryJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartDiscoveryJobRequest.Builder,StartDiscoveryJobRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartDiscoveryJobRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartDiscoveryJobRequest.Builder	builder()
String	clientToken()	Specifies a client token to make sure requests with this API operation are idempotent.
Integer	collectionDurationMinutes()	Specifies in minutes how long you want the discovery job to run.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends StartDiscoveryJobRequest.Builder>	serializableBuilderClass()
String	storageSystemArn()	Specifies the Amazon Resource Name (ARN) of the on-premises storage system that you want to run the discovery job on.
List<TagListEntry>	tags()	Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.
StartDiscoveryJobRequest.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

storageSystemArn

public final String storageSystemArn()

Specifies the Amazon Resource Name (ARN) of the on-premises storage system that you want to run the discovery job on.

Returns:

Specifies the Amazon Resource Name (ARN) of the on-premises storage system that you want to run the discovery job on.

collectionDurationMinutes

public final Integer collectionDurationMinutes()

Specifies in minutes how long you want the discovery job to run.

For more accurate recommendations, we recommend a duration of at least 14 days. Longer durations allow time to collect a sufficient number of data points and provide a realistic representation of storage performance and utilization.

Returns:

Specifies in minutes how long you want the discovery job to run.

For more accurate recommendations, we recommend a duration of at least 14 days. Longer durations allow time to collect a sufficient number of data points and provide a realistic representation of storage performance and utilization.

clientToken

public final String clientToken()

Specifies a client token to make sure requests with this API operation are idempotent. If you don't specify a client token, DataSync generates one for you automatically.

Returns:

Specifies a client token to make sure requests with this API operation are idempotent. If you don't specify a client token, DataSync generates one for you automatically.

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 List<TagListEntry> tags()

Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.

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:

Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.

toBuilder

public StartDiscoveryJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartDiscoveryJobRequest.Builder,StartDiscoveryJobRequest>

Specified by:

toBuilder in class DataSyncRequest

builder

public static StartDiscoveryJobRequest.Builder builder()

serializableBuilderClass

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