PutObjectRequest (AWS Java SDK for AWS Elemental MediaStore Data Plane 1.11.377 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.mediastoredata.model.PutObjectRequest

All Implemented Interfaces:: SignerTypeAware, HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutObjectRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, SignerTypeAware

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

PutObjectRequest()

Constructors
Constructor and Description
`PutObjectRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PutObjectRequest`	`clone()`
`boolean`	`equals(Object obj)`
`InputStream`	`getBody()` The bytes to be stored.
`String`	`getCacheControl()` An optional `CacheControl` header that allows the caller to control the object's cache behavior.
`String`	`getContentType()` The content type of the object.
`String`	`getPath()` The path (including the file name) where the object is stored in the container.
`String`	`getSignerType()`
`String`	`getStorageClass()` Indicates the storage class of a `Put` request.
`int`	`hashCode()`
`void`	`setBody(InputStream body)` The bytes to be stored.
`void`	`setCacheControl(String cacheControl)` An optional `CacheControl` header that allows the caller to control the object's cache behavior.
`void`	`setContentType(String contentType)` The content type of the object.
`void`	`setPath(String path)` The path (including the file name) where the object is stored in the container.
`void`	`setStorageClass(String storageClass)` Indicates the storage class of a `Put` request.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`PutObjectRequest`	`withBody(InputStream body)` The bytes to be stored.
`PutObjectRequest`	`withCacheControl(String cacheControl)` An optional `CacheControl` header that allows the caller to control the object's cache behavior.
`PutObjectRequest`	`withContentType(String contentType)` The content type of the object.
`PutObjectRequest`	`withPath(String path)` The path (including the file name) where the object is stored in the container.
`PutObjectRequest`	`withStorageClass(StorageClass storageClass)` Indicates the storage class of a `Put` request.
`PutObjectRequest`	`withStorageClass(String storageClass)` Indicates the storage class of a `Put` request.

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

- Constructor Detail
  - PutObjectRequest
```
public PutObjectRequest()
```
- Method Detail
  - setBody
```
public void setBody(InputStream body)
```
    The bytes to be stored.
    
    Parameters:
    
    body - The bytes to be stored.
  - getBody
```
public InputStream getBody()
```
    The bytes to be stored.
    
    Returns:
    
    The bytes to be stored.
  - withBody
```
public PutObjectRequest withBody(InputStream body)
```
    The bytes to be stored.
    
    Parameters:
    
    body - The bytes to be stored.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPath
```
public void setPath(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.
    
    Parameters:
    
    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.
  - getPath
```
public String getPath()
```
    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.
  - withPath
```
public PutObjectRequest withPath(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContentType
```
public void setContentType(String contentType)
```
    The content type of the object.
    
    Parameters:
    
    contentType - The content type of the object.
  - getContentType
```
public String getContentType()
```
    The content type of the object.
    
    Returns:
    
    The content type of the object.
  - withContentType
```
public PutObjectRequest withContentType(String contentType)
```
    The content type of the object.
    
    Parameters:
    
    contentType - The content type of the object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCacheControl
```
public void setCacheControl(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.
    
    Parameters:
    
    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.
  - getCacheControl
```
public String getCacheControl()
```
    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.
  - withCacheControl
```
public PutObjectRequest withCacheControl(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStorageClass
```
public void setStorageClass(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    StorageClass
  - getStorageClass
```
public String getStorageClass()
```
    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.
    
    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
  - withStorageClass
```
public PutObjectRequest withStorageClass(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StorageClass
  - withStorageClass
```
public PutObjectRequest withStorageClass(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StorageClass
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PutObjectRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest
  - getSignerType
```
public String getSignerType()
```
    Specified by:
    
    getSignerType in interface SignerTypeAware

Class PutObjectRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

PutObjectRequest

Method Detail

setBody

getBody

withBody

setPath

getPath

withPath

setContentType

getContentType

withContentType

setCacheControl

getCacheControl

withCacheControl

setStorageClass

getStorageClass

withStorageClass

withStorageClass

toString

equals

hashCode

clone

getSignerType