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

Class LocationListEntry

java.lang.Object
software.amazon.awssdk.services.datasync.model.LocationListEntry
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LocationListEntry.Builder,LocationListEntry>
@Generated("software.amazon.awssdk:codegen") public final class LocationListEntry extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LocationListEntry.Builder,LocationListEntry>

Represents a single entry in a list of locations. LocationListEntry returns an array that contains a list of locations when the ListLocations operation is called.

See Also:

  • Method Details

    • locationArn

      public final String locationArn()

      The Amazon Resource Name (ARN) of the location. For Network File System (NFS) or Amazon EFS, the location is the export path. For Amazon S3, the location is the prefix path that you want to mount and use as the root of the location.

      Returns:
      The Amazon Resource Name (ARN) of the location. For Network File System (NFS) or Amazon EFS, the location is the export path. For Amazon S3, the location is the prefix path that you want to mount and use as the root of the location.

    • locationUri

      public final String locationUri()

      Represents a list of URIs of a location. LocationUri returns an array that contains a list of locations when the ListLocations operation is called.

      Format: TYPE://GLOBAL_ID/SUBDIR.

      TYPE designates the type of location (for example, nfs or s3).

      GLOBAL_ID is the globally unique identifier of the resource that backs the location. An example for EFS is us-east-2.fs-abcd1234. An example for Amazon S3 is the bucket name, such as myBucket. An example for NFS is a valid IPv4 address or a hostname that is compliant with Domain Name Service (DNS).

      SUBDIR is a valid file system path, delimited by forward slashes as is the *nix convention. For NFS and Amazon EFS, it's the export path to mount the location. For Amazon S3, it's the prefix path that you mount to and treat as the root of the location.

      Returns:
      Represents a list of URIs of a location. LocationUri returns an array that contains a list of locations when the ListLocations operation is called.

      Format: TYPE://GLOBAL_ID/SUBDIR.

      TYPE designates the type of location (for example, nfs or s3).

      GLOBAL_ID is the globally unique identifier of the resource that backs the location. An example for EFS is us-east-2.fs-abcd1234. An example for Amazon S3 is the bucket name, such as myBucket. An example for NFS is a valid IPv4 address or a hostname that is compliant with Domain Name Service (DNS).

      SUBDIR is a valid file system path, delimited by forward slashes as is the *nix convention. For NFS and Amazon EFS, it's the export path to mount the location. For Amazon S3, it's the prefix path that you mount to and treat as the root of the location.

    • toBuilder

      public LocationListEntry.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<LocationListEntry.Builder,LocationListEntry>
      Returns:
      a builder for type T

    • builder

      public static LocationListEntry.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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