@Generated(value="software.amazon.awssdk:codegen") public final class PutObjectRequest extends MediaStoreDataRequest implements ToCopyableBuilder<PutObjectRequest.Builder,PutObjectRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
PutObjectRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static PutObjectRequest.Builder |
builder() |
String |
cacheControl()
An optional
CacheControl header that allows the caller to control the object's cache behavior. |
String |
contentType()
The content type of the object.
|
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. |
int |
hashCode() |
String |
path()
The path (including the file name) where the object is stored in the container.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends PutObjectRequest.Builder> |
serializableBuilderClass() |
StorageClass |
storageClass()
Indicates the storage class of a
Put request. |
String |
storageClassAsString()
Indicates the storage class of a
Put request. |
PutObjectRequest.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.
|
UploadAvailability |
uploadAvailability()
Indicates the availability of an object while it is still uploading.
|
String |
uploadAvailabilityAsString()
Indicates the availability of an object while it is still uploading.
|
overrideConfigurationcopypublic final String path()
The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name>
For example, to upload the file mlaw.avi to the folder path premium\canada in the
container movies, enter the path premium/canada/mlaw.avi.
Do not include the container name in this path.
If the path includes any folders that don't exist yet, the service creates them. For example, suppose you have an
existing premium/usa subfolder. If you specify premium/canada, the service creates a
canada subfolder in the premium folder. You then have two subfolders, usa
and canada, in the premium folder.
There is no correlation between the path to the source and the path (folders) in the container in AWS Elemental MediaStore.
For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User Guide.
The file name is the name that is assigned to the file that you upload. The file can have the same name inside and outside of AWS Elemental MediaStore, or it can have the same name. The file name can include or omit an extension.
For example, to upload the file mlaw.avi to the folder path premium\canada in
the container movies, enter the path premium/canada/mlaw.avi.
Do not include the container name in this path.
If the path includes any folders that don't exist yet, the service creates them. For example, suppose you
have an existing premium/usa subfolder. If you specify premium/canada, the
service creates a canada subfolder in the premium folder. You then have two
subfolders, usa and canada, in the premium folder.
There is no correlation between the path to the source and the path (folders) in the container in AWS Elemental MediaStore.
For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User Guide.
The file name is the name that is assigned to the file that you upload. The file can have the same name inside and outside of AWS Elemental MediaStore, or it can have the same name. The file name can include or omit an extension.
public final String contentType()
The content type of the object.
public final String cacheControl()
An optional CacheControl header that allows the caller to control the object's cache behavior.
Headers can be passed in as specified in the HTTP at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
Headers with a custom user-defined value are also accepted.
CacheControl header that allows the caller to control the object's cache
behavior. Headers can be passed in as specified in the HTTP at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
Headers with a custom user-defined value are also accepted.
public final StorageClass storageClass()
Indicates the storage class of a Put request. Defaults to high-performance temporal storage class,
and objects are persisted into durable storage shortly after being received.
If the service returns an enum value that is not available in the current SDK version, storageClass will
return StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
storageClassAsString().
Put request. Defaults to high-performance temporal storage
class, and objects are persisted into durable storage shortly after being received.StorageClasspublic final String storageClassAsString()
Indicates the storage class of a Put request. Defaults to high-performance temporal storage class,
and objects are persisted into durable storage shortly after being received.
If the service returns an enum value that is not available in the current SDK version, storageClass will
return StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
storageClassAsString().
Put request. Defaults to high-performance temporal storage
class, and objects are persisted into durable storage shortly after being received.StorageClasspublic final UploadAvailability uploadAvailability()
Indicates the availability of an object while it is still uploading. If the value is set to
streaming, the object is available for downloading after some initial buffering but before the
object is uploaded completely. If the value is set to standard, the object is available for
downloading only when it is uploaded completely. The default value for this header is standard.
To use this header, you must also set the HTTP Transfer-Encoding header to chunked.
If the service returns an enum value that is not available in the current SDK version,
uploadAvailability will return UploadAvailability.UNKNOWN_TO_SDK_VERSION. The raw value returned
by the service is available from uploadAvailabilityAsString().
streaming, the object is available for downloading after some initial buffering but before
the object is uploaded completely. If the value is set to standard, the object is available
for downloading only when it is uploaded completely. The default value for this header is
standard.
To use this header, you must also set the HTTP Transfer-Encoding header to
chunked.
UploadAvailabilitypublic final String uploadAvailabilityAsString()
Indicates the availability of an object while it is still uploading. If the value is set to
streaming, the object is available for downloading after some initial buffering but before the
object is uploaded completely. If the value is set to standard, the object is available for
downloading only when it is uploaded completely. The default value for this header is standard.
To use this header, you must also set the HTTP Transfer-Encoding header to chunked.
If the service returns an enum value that is not available in the current SDK version,
uploadAvailability will return UploadAvailability.UNKNOWN_TO_SDK_VERSION. The raw value returned
by the service is available from uploadAvailabilityAsString().
streaming, the object is available for downloading after some initial buffering but before
the object is uploaded completely. If the value is set to standard, the object is available
for downloading only when it is uploaded completely. The default value for this header is
standard.
To use this header, you must also set the HTTP Transfer-Encoding header to
chunked.
UploadAvailabilitypublic PutObjectRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<PutObjectRequest.Builder,PutObjectRequest>toBuilder in class MediaStoreDataRequestpublic static PutObjectRequest.Builder builder()
public static Class<? extends PutObjectRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. 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.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.