Class CreateLocationObjectStorageRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateLocationObjectStorageRequest.Builder,
CreateLocationObjectStorageRequest>
CreateLocationObjectStorageRequest
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.final String
Specifies the name of the object storage bucket involved in the transfer.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the AgentArns property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.static Class
<? extends CreateLocationObjectStorageRequest.Builder> final SdkBytes
Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA).final String
Specifies the domain name or IP address of the object storage server.final Integer
Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).Specifies the protocol that your object storage server uses to communicate.final String
Specifies the protocol that your object storage server uses to communicate.final String
Specifies the object prefix for your object storage server.final List
<TagListEntry> tags()
Specifies the key-value pair that represents a tag that you want to add to the resource.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
serverHostname
Specifies the domain name or IP address of the object storage server. A DataSync agent uses this hostname to mount the object storage server in a network.
- Returns:
- Specifies the domain name or IP address of the object storage server. A DataSync agent uses this hostname to mount the object storage server in a network.
-
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
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 returnObjectStorageServerProtocol.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromserverProtocolAsString()
.- Returns:
- Specifies the protocol that your object storage server uses to communicate.
- See Also:
-
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 returnObjectStorageServerProtocol.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromserverProtocolAsString()
.- Returns:
- Specifies the protocol that your object storage server uses to communicate.
- See Also:
-
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.
-
bucketName
Specifies the name of the object storage bucket involved in the transfer.
- Returns:
- Specifies the name of the object storage bucket involved in the transfer.
-
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
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 theisEmpty()
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
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.
-
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 theisEmpty()
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
Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for 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
hasTags()
method.- Returns:
- Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.
-
serverCertificate
Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). You must specify a single
.pem
file with a full certificate chain (for example,file:///home/user/.ssh/object_storage_certificates.pem
).The certificate chain might include:
-
The object storage system's certificate
-
All intermediate certificates (if there are any)
-
The root certificate of the signing CA
You can concatenate your certificates into a
.pem
file (which can be up to 32768 bytes before base64 encoding). The following examplecat
command creates anobject_storage_certificates.pem
file that includes three certificates:cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem
To use this parameter, configure
ServerProtocol
toHTTPS
.- Returns:
- Specifies a certificate chain for DataSync to authenticate with your object storage system if the system
uses a private or self-signed certificate authority (CA). You must specify a single
.pem
file with a full certificate chain (for example,file:///home/user/.ssh/object_storage_certificates.pem
).The certificate chain might include:
-
The object storage system's certificate
-
All intermediate certificates (if there are any)
-
The root certificate of the signing CA
You can concatenate your certificates into a
.pem
file (which can be up to 32768 bytes before base64 encoding). The following examplecat
command creates anobject_storage_certificates.pem
file that includes three certificates:cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem
To use this parameter, configure
ServerProtocol
toHTTPS
. -
-
-
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 interfaceToCopyableBuilder<CreateLocationObjectStorageRequest.Builder,
CreateLocationObjectStorageRequest> - Specified by:
toBuilder
in classDataSyncRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends CreateLocationObjectStorageRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-