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

Class UpdateLocationObjectStorageRequest

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

  • Method Details

    • locationArn

      public final String locationArn()

      Specifies the ARN of the object storage system location that you're updating.

      Returns:
      Specifies the ARN of the object storage system location that you're updating.

    • serverPort

      public final Integer serverPort()

      Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

      Returns:
      Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

    • serverProtocol

      public final ObjectStorageServerProtocol serverProtocol()

      Specifies the protocol that your object storage server uses to communicate.

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

      Returns:
      Specifies the protocol that your object storage server uses to communicate.
      See Also:

    • serverProtocolAsString

      public final String serverProtocolAsString()

      Specifies the protocol that your object storage server uses to communicate.

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

      Returns:
      Specifies the protocol that your object storage server uses to communicate.
      See Also:

    • subdirectory

      public final String subdirectory()

      Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.

      Returns:
      Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.

    • accessKey

      public final String accessKey()

      Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

      Returns:
      Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

    • secretKey

      public final String secretKey()

      Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

      Returns:
      Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

    • 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 Names (ARNs) of the DataSync agents that can securely connect with your location.

      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 Names (ARNs) of the DataSync agents that can securely connect with your location.

    • serverCertificate

      public final SdkBytes serverCertificate()

      Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA). You must specify a Base64-encoded .pem file (for example, file:///home/user/.ssh/storage_sys_certificate.pem). The certificate can be up to 32768 bytes (before Base64 encoding).

      To use this parameter, configure ServerProtocol to HTTPS.

      Updating the certificate doesn't interfere with tasks that you have in progress.

      Returns:
      Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA). You must specify a Base64-encoded .pem file (for example, file:///home/user/.ssh/storage_sys_certificate.pem). The certificate can be up to 32768 bytes (before Base64 encoding).

      To use this parameter, configure ServerProtocol to HTTPS.

      Updating the certificate doesn't interfere with tasks that you have in progress.

    • toBuilder

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

    • builder

      public static UpdateLocationObjectStorageRequest.Builder builder()

    • serializableBuilderClass

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