CreateLocationObjectStorageRequest (AWS SDK for Java

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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateLocationObjectStorageRequest.Builder,CreateLocationObjectStorageRequest>

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

CreateLocationObjectStorageRequest

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateLocationObjectStorageRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateLocationObjectStorageRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`accessKey()` Optional.
`List<String>`	`agentArns()` The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
`String`	`bucketName()` The bucket on the self-managed object storage server that is used to read data from.
`static CreateLocationObjectStorageRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`boolean`	`hasAgentArns()` Returns true if the AgentArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<SdkField<?>>`	`sdkFields()`
`String`	`secretKey()` Optional.
`static Class<? extends CreateLocationObjectStorageRequest.Builder>`	`serializableBuilderClass()`
`String`	`serverHostname()` The name of the self-managed object storage server.
`Integer`	`serverPort()` The port that your self-managed object storage server accepts inbound network traffic on.
`ObjectStorageServerProtocol`	`serverProtocol()` The protocol that the object storage server uses to communicate.
`String`	`serverProtocolAsString()` The protocol that the object storage server uses to communicate.
`String`	`subdirectory()` The subdirectory in the self-managed object storage server that is used to read data from.
`List<TagListEntry>`	`tags()` The key-value pair that represents the tag that you want to add to the location.
`CreateLocationObjectStorageRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`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
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - serverHostname
```
public final String serverHostname()
```
    The name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server. An agent uses this host name to mount the object storage server in a network.
    
    Returns:
    
    The name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server. An agent uses this host name to mount the object storage server in a network.
  - serverPort
```
public final Integer serverPort()
```
    The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.
    
    Returns:
    
    The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.
  - serverProtocol
```
public final ObjectStorageServerProtocol serverProtocol()
```
    The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.
    
    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:
    
    The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.
    
    See Also:
    
    ObjectStorageServerProtocol
  - serverProtocolAsString
```
public final String serverProtocolAsString()
```
    The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.
    
    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:
    
    The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.
    
    See Also:
    
    ObjectStorageServerProtocol
  - subdirectory
```
public final String subdirectory()
```
    The subdirectory in the self-managed object storage server that is used to read data from.
    
    Returns:
    
    The subdirectory in the self-managed object storage server that is used to read data from.
  - bucketName
```
public final String bucketName()
```
    The bucket on the self-managed object storage server that is used to read data from.
    
    Returns:
    
    The bucket on the self-managed object storage server that is used to read data from.
  - accessKey
```
public final String accessKey()
```
    Optional. The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.
    
    Returns:
    
    Optional. The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.
  - secretKey
```
public final String secretKey()
```
    Optional. The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.
    
    Returns:
    
    Optional. The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.
  - hasAgentArns
```
public final boolean hasAgentArns()
```
    Returns true if the AgentArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - agentArns
```
public final List<String> agentArns()
```
    The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAgentArns() to see if a value was sent in this field.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    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 CreateLocationObjectStorageRequest.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<CreateLocationObjectStorageRequest.Builder,CreateLocationObjectStorageRequest>
    
    Specified by:
    
    toBuilder in class DataSyncRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateLocationObjectStorageRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateLocationObjectStorageRequest.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.

AWS SDK for Java API Reference - 2.16.62

Class CreateLocationObjectStorageRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

serverHostname

serverPort

serverProtocol

serverProtocolAsString

subdirectory

bucketName

accessKey

secretKey

hasAgentArns

agentArns

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields