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

Class DescribeStorageSystemResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.datasync.model.DataSyncResponse
software.amazon.awssdk.services.datasync.model.DescribeStorageSystemResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeStorageSystemResponse.Builder,DescribeStorageSystemResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeStorageSystemResponse extends DataSyncResponse implements ToCopyableBuilder<DescribeStorageSystemResponse.Builder,DescribeStorageSystemResponse>

  • Method Details

    • storageSystemArn

      public final String storageSystemArn()

      The ARN of the on-premises storage system that the discovery job looked at.

      Returns:
      The ARN of the on-premises storage system that the discovery job looked at.

    • serverConfiguration

      public final DiscoveryServerConfiguration serverConfiguration()

      The server name and network port required to connect with your on-premises storage system's management interface.

      Returns:
      The server name and network port required to connect with your on-premises storage system's management interface.

    • systemType

      public final DiscoverySystemType systemType()

      The type of on-premises storage system.

      DataSync Discovery currently only 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:
      The type of on-premises storage system.

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

      See Also:

    • systemTypeAsString

      public final String systemTypeAsString()

      The type of on-premises storage system.

      DataSync Discovery currently only 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:
      The type of on-premises storage system.

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

      See Also:

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

      The ARN of the DataSync agent that connects to and reads from 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 hasAgentArns() method.

      Returns:
      The ARN of the DataSync agent that connects to and reads from your on-premises storage system.

    • name

      public final String name()

      The name that you gave your on-premises storage system when adding it to DataSync Discovery.

      Returns:
      The name that you gave your on-premises storage system when adding it to DataSync Discovery.

    • errorMessage

      public final String errorMessage()

      Describes the connectivity error that the DataSync agent is encountering with your on-premises storage system.

      Returns:
      Describes the connectivity error that the DataSync agent is encountering with your on-premises storage system.

    • connectivityStatus

      public final StorageSystemConnectivityStatus connectivityStatus()

      Indicates whether your DataSync agent can connect to your on-premises storage system.

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

      Returns:
      Indicates whether your DataSync agent can connect to your on-premises storage system.
      See Also:

    • connectivityStatusAsString

      public final String connectivityStatusAsString()

      Indicates whether your DataSync agent can connect to your on-premises storage system.

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

      Returns:
      Indicates whether your DataSync agent can connect to your on-premises storage system.
      See Also:

    • cloudWatchLogGroupArn

      public final String cloudWatchLogGroupArn()

      The ARN of the Amazon CloudWatch log group that's used to monitor and log discovery job events.

      Returns:
      The ARN of the Amazon CloudWatch log group that's used to monitor and log discovery job events.

    • creationTime

      public final Instant creationTime()

      The time when you added the on-premises storage system to DataSync Discovery.

      Returns:
      The time when you added the on-premises storage system to DataSync Discovery.

    • secretsManagerArn

      public final String secretsManagerArn()

      The ARN of the secret that stores your on-premises storage system's credentials. DataSync Discovery stores these credentials in Secrets Manager.

      Returns:
      The ARN of the secret that stores your on-premises storage system's credentials. DataSync Discovery stores these credentials in Secrets Manager.

    • toBuilder

      public DescribeStorageSystemResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeStorageSystemResponse.Builder,DescribeStorageSystemResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeStorageSystemResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeStorageSystemResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.