software.amazon.awssdk.services.datasync.model

Class AddStorageSystemRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AddStorageSystemRequest.Builder,AddStorageSystemRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AddStorageSystemRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	agentArns() Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads from your on-premises storage system's management interface.
static AddStorageSystemRequest.Builder	builder()
String	clientToken() Specifies a client token to make sure requests with this API operation are idempotent.
String	cloudWatchLogGroupArn() Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events.
Credentials	credentials() Specifies the user name and password for accessing your on-premises storage system's management interface.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAgentArns() For responses, this returns true if the service returned a value for the AgentArns property.
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	name() Specifies a familiar name for your on-premises storage system.
List<SdkField<?>>	sdkFields()
static Class<? extends AddStorageSystemRequest.Builder>	serializableBuilderClass()
DiscoveryServerConfiguration	serverConfiguration() Specifies the server name and network port required to connect with the management interface of your on-premises storage system.
DiscoverySystemType	systemType() Specifies the type of on-premises storage system that you want DataSync Discovery to collect information about.
String	systemTypeAsString() Specifies the type of on-premises storage system that you want DataSync Discovery to collect information about.
List<TagListEntry>	tags() Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.
AddStorageSystemRequest.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

serverConfiguration

public final DiscoveryServerConfiguration serverConfiguration()

Specifies the server name and network port required to connect with the management interface of your on-premises storage system.

Returns:

Specifies the server name and network port required to connect with the management interface of your on-premises storage system.

systemType

public final DiscoverySystemType systemType()

Specifies the type of on-premises storage system that you want DataSync Discovery to collect information about.

DataSync Discovery currently supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.

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

Returns:

Specifies the type of on-premises storage system that you want DataSync Discovery to collect information about.

DataSync Discovery currently supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.

See Also:

DiscoverySystemType

systemTypeAsString

public final String systemTypeAsString()

Specifies the type of on-premises storage system that you want DataSync Discovery to collect information about.

DataSync Discovery currently supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.

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

Returns:

Specifies the type of on-premises storage system that you want DataSync Discovery to collect information about.

DataSync Discovery currently supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.

See Also:

DiscoverySystemType

hasAgentArns

public final boolean hasAgentArns()

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

agentArns

public final List<String> agentArns()

Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads from your on-premises storage system's management interface. You can only specify one ARN.

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

Returns:

Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads from your on-premises storage system's management interface. You can only specify one ARN.

cloudWatchLogGroupArn

public final String cloudWatchLogGroupArn()

Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events.

Returns:

Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events.

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. We recommend creating at least a name tag for your on-premises storage system.

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. We recommend creating at least a name tag for your on-premises storage system.

name

public final String name()

Specifies a familiar name for your on-premises storage system.

Returns:

Specifies a familiar name for your on-premises storage system.

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.

credentials

public final Credentials credentials()

Specifies the user name and password for accessing your on-premises storage system's management interface.

Returns:

Specifies the user name and password for accessing your on-premises storage system's management interface.

toBuilder

public AddStorageSystemRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AddStorageSystemRequest.Builder,AddStorageSystemRequest>

Specified by:

toBuilder in class DataSyncRequest

builder

public static AddStorageSystemRequest.Builder builder()

serializableBuilderClass

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