PutObjectRequest (AWS Java SDK :: Services :: AWS Elemental MediaStore Data 2.15.49 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.mediastoredata.model.MediaStoreDataRequest
    - - software.amazon.awssdk.services.mediastoredata.model.PutObjectRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PutObjectRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`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()`
`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.

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

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - path
```
public 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.
    
    Returns:
    
    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.
  - contentType
```
public final String contentType()
```
    The content type of the object.
    
    Returns:
    
    The content type of the object.
  - cacheControl
```
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.
    
    Returns:
    
    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.
  - storageClass
```
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().
    
    Returns:
    
    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.
    
    See Also:
    
    StorageClass
  - storageClassAsString
```
public 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().
    
    Returns:
    
    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.
    
    See Also:
    
    StorageClass
  - uploadAvailability
```
public 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().
    
    Returns:
    
    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.
    
    See Also:
    
    UploadAvailability
  - uploadAvailabilityAsString
```
public 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().
    
    Returns:
    
    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.
    
    See Also:
    
    UploadAvailability
  - toBuilder
```
public PutObjectRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PutObjectRequest.Builder,PutObjectRequest>
    
    Specified by:
    
    toBuilder in class MediaStoreDataRequest
  - builder
```
public static PutObjectRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PutObjectRequest.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class PutObjectRequest

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

path

contentType

cacheControl

storageClass

storageClassAsString

uploadAvailability

uploadAvailabilityAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields