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

Class CreateLocationHdfsRequest

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.CreateLocationHdfsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateLocationHdfsRequest.Builder,CreateLocationHdfsRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateLocationHdfsRequest extends DataSyncRequest implements ToCopyableBuilder<CreateLocationHdfsRequest.Builder,CreateLocationHdfsRequest>

  • Method Details

    • subdirectory

      public final String subdirectory()

      A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to /.

      Returns:
      A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to /.

    • hasNameNodes

      public final boolean hasNameNodes()
      For responses, this returns true if the service returned a value for the NameNodes 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.

    • nameNodes

      public final List<HdfsNameNode> nameNodes()

      The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. You can use only one NameNode.

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

      Returns:
      The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. You can use only one NameNode.

    • blockSize

      public final Integer blockSize()

      The size of data blocks to write into the HDFS cluster. The block size must be a multiple of 512 bytes. The default block size is 128 mebibytes (MiB).

      Returns:
      The size of data blocks to write into the HDFS cluster. The block size must be a multiple of 512 bytes. The default block size is 128 mebibytes (MiB).

    • replicationFactor

      public final Integer replicationFactor()

      The number of DataNodes to replicate the data to when writing to the HDFS cluster. By default, data is replicated to three DataNodes.

      Returns:
      The number of DataNodes to replicate the data to when writing to the HDFS cluster. By default, data is replicated to three DataNodes.

    • kmsKeyProviderUri

      public final String kmsKeyProviderUri()

      The URI of the HDFS cluster's Key Management Server (KMS).

      Returns:
      The URI of the HDFS cluster's Key Management Server (KMS).

    • qopConfiguration

      public final QopConfiguration qopConfiguration()

      The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer protection settings configured on the Hadoop Distributed File System (HDFS) cluster. If QopConfiguration isn't specified, RpcProtection and DataTransferProtection default to PRIVACY. If you set RpcProtection or DataTransferProtection, the other parameter assumes the same value.

      Returns:
      The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer protection settings configured on the Hadoop Distributed File System (HDFS) cluster. If QopConfiguration isn't specified, RpcProtection and DataTransferProtection default to PRIVACY. If you set RpcProtection or DataTransferProtection, the other parameter assumes the same value.

    • authenticationType

      public final HdfsAuthenticationType authenticationType()

      The type of authentication used to determine the identity of the user.

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

      Returns:
      The type of authentication used to determine the identity of the user.
      See Also:

    • authenticationTypeAsString

      public final String authenticationTypeAsString()

      The type of authentication used to determine the identity of the user.

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

      Returns:
      The type of authentication used to determine the identity of the user.
      See Also:

    • simpleUser

      public final String simpleUser()

      The user name used to identify the client on the host operating system.

      If SIMPLE is specified for AuthenticationType, this parameter is required.

      Returns:
      The user name used to identify the client on the host operating system.

      If SIMPLE is specified for AuthenticationType, this parameter is required.

    • kerberosPrincipal

      public final String kerberosPrincipal()

      The Kerberos principal with access to the files and folders on the HDFS cluster.

      If KERBEROS is specified for AuthenticationType, this parameter is required.

      Returns:
      The Kerberos principal with access to the files and folders on the HDFS cluster.

      If KERBEROS is specified for AuthenticationType, this parameter is required.

    • kerberosKeytab

      public final SdkBytes kerberosKeytab()

      The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address. If you're using the CLI, it performs base64 encoding for you. Otherwise, provide the base64-encoded text.

      If KERBEROS is specified for AuthenticationType, this parameter is required.

      Returns:
      The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address. If you're using the CLI, it performs base64 encoding for you. Otherwise, provide the base64-encoded text.

      If KERBEROS is specified for AuthenticationType, this parameter is required.

    • kerberosKrb5Conf

      public final SdkBytes kerberosKrb5Conf()

      The krb5.conf file that contains the Kerberos configuration information. You can load the krb5.conf file by providing the file's address. If you're using the CLI, it performs the base64 encoding for you. Otherwise, provide the base64-encoded text.

      If KERBEROS is specified for AuthenticationType, this parameter is required.

      Returns:
      The krb5.conf file that contains the Kerberos configuration information. You can load the krb5.conf file by providing the file's address. If you're using the CLI, it performs the base64 encoding for you. Otherwise, provide the base64-encoded text.

      If KERBEROS is specified for AuthenticationType, this parameter is required.

    • 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 Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS cluster.

      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 Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS cluster.

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

      The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your 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:
      The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

    • toBuilder

      public CreateLocationHdfsRequest.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<CreateLocationHdfsRequest.Builder,CreateLocationHdfsRequest>
      Specified by:
      toBuilder in class DataSyncRequest
      Returns:
      a builder for type T

    • builder

      public static CreateLocationHdfsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateLocationHdfsRequest.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)
      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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.