AWS SDK for C++  1.8.60
AWS SDK for C++
Public Member Functions | List of all members
Aws::MediaStoreData::Model::PutObjectRequest Class Reference

#include <PutObjectRequest.h>

+ Inheritance diagram for Aws::MediaStoreData::Model::PutObjectRequest:

Public Member Functions

 PutObjectRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
bool SignBody () const override
 
bool IsChunked () const override
 
const Aws::StringGetPath () const
 
bool PathHasBeenSet () const
 
void SetPath (const Aws::String &value)
 
void SetPath (Aws::String &&value)
 
void SetPath (const char *value)
 
PutObjectRequestWithPath (const Aws::String &value)
 
PutObjectRequestWithPath (Aws::String &&value)
 
PutObjectRequestWithPath (const char *value)
 
const Aws::StringGetCacheControl () const
 
bool CacheControlHasBeenSet () const
 
void SetCacheControl (const Aws::String &value)
 
void SetCacheControl (Aws::String &&value)
 
void SetCacheControl (const char *value)
 
PutObjectRequestWithCacheControl (const Aws::String &value)
 
PutObjectRequestWithCacheControl (Aws::String &&value)
 
PutObjectRequestWithCacheControl (const char *value)
 
const StorageClassGetStorageClass () const
 
bool StorageClassHasBeenSet () const
 
void SetStorageClass (const StorageClass &value)
 
void SetStorageClass (StorageClass &&value)
 
PutObjectRequestWithStorageClass (const StorageClass &value)
 
PutObjectRequestWithStorageClass (StorageClass &&value)
 
const UploadAvailabilityGetUploadAvailability () const
 
bool UploadAvailabilityHasBeenSet () const
 
void SetUploadAvailability (const UploadAvailability &value)
 
void SetUploadAvailability (UploadAvailability &&value)
 
PutObjectRequestWithUploadAvailability (const UploadAvailability &value)
 
PutObjectRequestWithUploadAvailability (UploadAvailability &&value)
 
- Public Member Functions inherited from Aws::AmazonStreamingWebServiceRequest
 AmazonStreamingWebServiceRequest ()
 
virtual ~AmazonStreamingWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
void SetBody (const std::shared_ptr< Aws::IOStream > &body)
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
bool IsStreaming () const override
 
const Aws::StringGetContentType () const
 
void SetContentType (const Aws::String &contentType)
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsEventStreamRequest () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 24 of file PutObjectRequest.h.

Constructor & Destructor Documentation

◆ PutObjectRequest()

Aws::MediaStoreData::Model::PutObjectRequest::PutObjectRequest ( )

Member Function Documentation

◆ CacheControlHasBeenSet()

bool Aws::MediaStoreData::Model::PutObjectRequest::CacheControlHasBeenSet ( ) const
inline

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.

Definition at line 243 of file PutObjectRequest.h.

◆ GetCacheControl()

const Aws::String& Aws::MediaStoreData::Model::PutObjectRequest::GetCacheControl ( ) const
inline

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.

Definition at line 234 of file PutObjectRequest.h.

◆ GetPath()

const Aws::String& Aws::MediaStoreData::Model::PutObjectRequest::GetPath ( ) const
inline

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

Definition at line 63 of file PutObjectRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::MediaStoreData::Model::PutObjectRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Override this method to put data members from a subclass into the headers collection.

Reimplemented from Aws::AmazonStreamingWebServiceRequest.

◆ GetServiceRequestName()

virtual const char* Aws::MediaStoreData::Model::PutObjectRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file PutObjectRequest.h.

◆ GetStorageClass()

const StorageClass& Aws::MediaStoreData::Model::PutObjectRequest::GetStorageClass ( ) const
inline

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.

Definition at line 305 of file PutObjectRequest.h.

◆ GetUploadAvailability()

const UploadAvailability& Aws::MediaStoreData::Model::PutObjectRequest::GetUploadAvailability ( ) const
inline

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.

Definition at line 352 of file PutObjectRequest.h.

◆ IsChunked()

bool Aws::MediaStoreData::Model::PutObjectRequest::IsChunked ( ) const
inlineoverridevirtual

Defaults to false, if this is set to true, it supports chunked transfer encoding.

Reimplemented from Aws::AmazonWebServiceRequest.

Definition at line 39 of file PutObjectRequest.h.

◆ PathHasBeenSet()

bool Aws::MediaStoreData::Model::PutObjectRequest::PathHasBeenSet ( ) const
inline

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

Definition at line 86 of file PutObjectRequest.h.

◆ SetCacheControl() [1/3]

void Aws::MediaStoreData::Model::PutObjectRequest::SetCacheControl ( const Aws::String value)
inline

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.

Definition at line 252 of file PutObjectRequest.h.

◆ SetCacheControl() [2/3]

void Aws::MediaStoreData::Model::PutObjectRequest::SetCacheControl ( Aws::String &&  value)
inline

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.

Definition at line 261 of file PutObjectRequest.h.

◆ SetCacheControl() [3/3]

void Aws::MediaStoreData::Model::PutObjectRequest::SetCacheControl ( const char *  value)
inline

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.

Definition at line 270 of file PutObjectRequest.h.

◆ SetPath() [1/3]

void Aws::MediaStoreData::Model::PutObjectRequest::SetPath ( const Aws::String value)
inline

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

Definition at line 109 of file PutObjectRequest.h.

◆ SetPath() [2/3]

void Aws::MediaStoreData::Model::PutObjectRequest::SetPath ( Aws::String &&  value)
inline

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

Definition at line 132 of file PutObjectRequest.h.

◆ SetPath() [3/3]

void Aws::MediaStoreData::Model::PutObjectRequest::SetPath ( const char *  value)
inline

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

Definition at line 155 of file PutObjectRequest.h.

◆ SetStorageClass() [1/2]

void Aws::MediaStoreData::Model::PutObjectRequest::SetStorageClass ( const StorageClass value)
inline

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.

Definition at line 319 of file PutObjectRequest.h.

◆ SetStorageClass() [2/2]

void Aws::MediaStoreData::Model::PutObjectRequest::SetStorageClass ( StorageClass &&  value)
inline

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.

Definition at line 326 of file PutObjectRequest.h.

◆ SetUploadAvailability() [1/2]

void Aws::MediaStoreData::Model::PutObjectRequest::SetUploadAvailability ( const UploadAvailability value)
inline

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.

Definition at line 374 of file PutObjectRequest.h.

◆ SetUploadAvailability() [2/2]

void Aws::MediaStoreData::Model::PutObjectRequest::SetUploadAvailability ( UploadAvailability &&  value)
inline

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.

Definition at line 385 of file PutObjectRequest.h.

◆ SignBody()

bool Aws::MediaStoreData::Model::PutObjectRequest::SignBody ( ) const
inlineoverridevirtual

Defaults to true, if this is set to false, then signers, if they support body signing, will not do so

Reimplemented from Aws::AmazonWebServiceRequest.

Definition at line 37 of file PutObjectRequest.h.

◆ StorageClassHasBeenSet()

bool Aws::MediaStoreData::Model::PutObjectRequest::StorageClassHasBeenSet ( ) const
inline

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.

Definition at line 312 of file PutObjectRequest.h.

◆ UploadAvailabilityHasBeenSet()

bool Aws::MediaStoreData::Model::PutObjectRequest::UploadAvailabilityHasBeenSet ( ) const
inline

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.

Definition at line 363 of file PutObjectRequest.h.

◆ WithCacheControl() [1/3]

PutObjectRequest& Aws::MediaStoreData::Model::PutObjectRequest::WithCacheControl ( const Aws::String value)
inline

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.

Definition at line 279 of file PutObjectRequest.h.

◆ WithCacheControl() [2/3]

PutObjectRequest& Aws::MediaStoreData::Model::PutObjectRequest::WithCacheControl ( Aws::String &&  value)
inline

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.

Definition at line 288 of file PutObjectRequest.h.

◆ WithCacheControl() [3/3]

PutObjectRequest& Aws::MediaStoreData::Model::PutObjectRequest::WithCacheControl ( const char *  value)
inline

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.

Definition at line 297 of file PutObjectRequest.h.

◆ WithPath() [1/3]

PutObjectRequest& Aws::MediaStoreData::Model::PutObjectRequest::WithPath ( const Aws::String value)
inline

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

Definition at line 178 of file PutObjectRequest.h.

◆ WithPath() [2/3]

PutObjectRequest& Aws::MediaStoreData::Model::PutObjectRequest::WithPath ( Aws::String &&  value)
inline

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

Definition at line 201 of file PutObjectRequest.h.

◆ WithPath() [3/3]

PutObjectRequest& Aws::MediaStoreData::Model::PutObjectRequest::WithPath ( const char *  value)
inline

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

Definition at line 224 of file PutObjectRequest.h.

◆ WithStorageClass() [1/2]

PutObjectRequest& Aws::MediaStoreData::Model::PutObjectRequest::WithStorageClass ( const StorageClass value)
inline

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.

Definition at line 333 of file PutObjectRequest.h.

◆ WithStorageClass() [2/2]

PutObjectRequest& Aws::MediaStoreData::Model::PutObjectRequest::WithStorageClass ( StorageClass &&  value)
inline

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.

Definition at line 340 of file PutObjectRequest.h.

◆ WithUploadAvailability() [1/2]

PutObjectRequest& Aws::MediaStoreData::Model::PutObjectRequest::WithUploadAvailability ( const UploadAvailability value)
inline

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.

Definition at line 396 of file PutObjectRequest.h.

◆ WithUploadAvailability() [2/2]

PutObjectRequest& Aws::MediaStoreData::Model::PutObjectRequest::WithUploadAvailability ( UploadAvailability &&  value)
inline

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.

Definition at line 407 of file PutObjectRequest.h.


The documentation for this class was generated from the following file: