AWS SDK for C++  1.8.129
AWS SDK for C++
Public Member Functions | List of all members
Aws::GameLift::Model::UpdateScriptRequest Class Reference

#include <UpdateScriptRequest.h>

+ Inheritance diagram for Aws::GameLift::Model::UpdateScriptRequest:

Public Member Functions

 UpdateScriptRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetScriptId () const
 
bool ScriptIdHasBeenSet () const
 
void SetScriptId (const Aws::String &value)
 
void SetScriptId (Aws::String &&value)
 
void SetScriptId (const char *value)
 
UpdateScriptRequestWithScriptId (const Aws::String &value)
 
UpdateScriptRequestWithScriptId (Aws::String &&value)
 
UpdateScriptRequestWithScriptId (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
UpdateScriptRequestWithName (const Aws::String &value)
 
UpdateScriptRequestWithName (Aws::String &&value)
 
UpdateScriptRequestWithName (const char *value)
 
const Aws::StringGetVersion () const
 
bool VersionHasBeenSet () const
 
void SetVersion (const Aws::String &value)
 
void SetVersion (Aws::String &&value)
 
void SetVersion (const char *value)
 
UpdateScriptRequestWithVersion (const Aws::String &value)
 
UpdateScriptRequestWithVersion (Aws::String &&value)
 
UpdateScriptRequestWithVersion (const char *value)
 
const S3LocationGetStorageLocation () const
 
bool StorageLocationHasBeenSet () const
 
void SetStorageLocation (const S3Location &value)
 
void SetStorageLocation (S3Location &&value)
 
UpdateScriptRequestWithStorageLocation (const S3Location &value)
 
UpdateScriptRequestWithStorageLocation (S3Location &&value)
 
const Aws::Utils::ByteBufferGetZipFile () const
 
bool ZipFileHasBeenSet () const
 
void SetZipFile (const Aws::Utils::ByteBuffer &value)
 
void SetZipFile (Aws::Utils::ByteBuffer &&value)
 
UpdateScriptRequestWithZipFile (const Aws::Utils::ByteBuffer &value)
 
UpdateScriptRequestWithZipFile (Aws::Utils::ByteBuffer &&value)
 
- Public Member Functions inherited from Aws::GameLift::GameLiftRequest
virtual ~GameLiftRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- 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 IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () 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 23 of file UpdateScriptRequest.h.

Constructor & Destructor Documentation

◆ UpdateScriptRequest()

Aws::GameLift::Model::UpdateScriptRequest::UpdateScriptRequest ( )

Member Function Documentation

◆ GetName()

const Aws::String& Aws::GameLift::Model::UpdateScriptRequest::GetName ( ) const
inline

A descriptive label that is associated with a script. Script names do not need to be unique.

Definition at line 92 of file UpdateScriptRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::GameLift::Model::UpdateScriptRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetScriptId()

const Aws::String& Aws::GameLift::Model::UpdateScriptRequest::GetScriptId ( ) const
inline

A unique identifier for a Realtime script to update. You can use either the script ID or ARN value.

Definition at line 43 of file UpdateScriptRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::GameLift::Model::UpdateScriptRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file UpdateScriptRequest.h.

◆ GetStorageLocation()

const S3Location& Aws::GameLift::Model::UpdateScriptRequest::GetStorageLocation ( ) const
inline

The Amazon S3 location of your Realtime scripts. The storage location must specify the S3 bucket name, the zip file name (the "key"), and an IAM role ARN that allows Amazon GameLift to access the S3 storage location. The S3 bucket must be in the same Region as the script you're updating. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version. To call this operation with a storage location, you must have IAM PassRole permission. For more details on IAM roles and PassRole permissions, see Set up a role for GameLift access.

Definition at line 199 of file UpdateScriptRequest.h.

◆ GetVersion()

const Aws::String& Aws::GameLift::Model::UpdateScriptRequest::GetVersion ( ) const
inline

The version that is associated with a build or script. Version strings do not need to be unique.

Definition at line 141 of file UpdateScriptRequest.h.

◆ GetZipFile()

const Aws::Utils::ByteBuffer& Aws::GameLift::Model::UpdateScriptRequest::GetZipFile ( ) const
inline

A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.

When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: –zip-file fileb://myRealtimeScript.zip.

Definition at line 285 of file UpdateScriptRequest.h.

◆ NameHasBeenSet()

bool Aws::GameLift::Model::UpdateScriptRequest::NameHasBeenSet ( ) const
inline

A descriptive label that is associated with a script. Script names do not need to be unique.

Definition at line 98 of file UpdateScriptRequest.h.

◆ ScriptIdHasBeenSet()

bool Aws::GameLift::Model::UpdateScriptRequest::ScriptIdHasBeenSet ( ) const
inline

A unique identifier for a Realtime script to update. You can use either the script ID or ARN value.

Definition at line 49 of file UpdateScriptRequest.h.

◆ SerializePayload()

Aws::String Aws::GameLift::Model::UpdateScriptRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetName() [1/3]

void Aws::GameLift::Model::UpdateScriptRequest::SetName ( Aws::String &&  value)
inline

A descriptive label that is associated with a script. Script names do not need to be unique.

Definition at line 110 of file UpdateScriptRequest.h.

◆ SetName() [2/3]

void Aws::GameLift::Model::UpdateScriptRequest::SetName ( const Aws::String value)
inline

A descriptive label that is associated with a script. Script names do not need to be unique.

Definition at line 104 of file UpdateScriptRequest.h.

◆ SetName() [3/3]

void Aws::GameLift::Model::UpdateScriptRequest::SetName ( const char *  value)
inline

A descriptive label that is associated with a script. Script names do not need to be unique.

Definition at line 116 of file UpdateScriptRequest.h.

◆ SetScriptId() [1/3]

void Aws::GameLift::Model::UpdateScriptRequest::SetScriptId ( Aws::String &&  value)
inline

A unique identifier for a Realtime script to update. You can use either the script ID or ARN value.

Definition at line 61 of file UpdateScriptRequest.h.

◆ SetScriptId() [2/3]

void Aws::GameLift::Model::UpdateScriptRequest::SetScriptId ( const Aws::String value)
inline

A unique identifier for a Realtime script to update. You can use either the script ID or ARN value.

Definition at line 55 of file UpdateScriptRequest.h.

◆ SetScriptId() [3/3]

void Aws::GameLift::Model::UpdateScriptRequest::SetScriptId ( const char *  value)
inline

A unique identifier for a Realtime script to update. You can use either the script ID or ARN value.

Definition at line 67 of file UpdateScriptRequest.h.

◆ SetStorageLocation() [1/2]

void Aws::GameLift::Model::UpdateScriptRequest::SetStorageLocation ( const S3Location value)
inline

The Amazon S3 location of your Realtime scripts. The storage location must specify the S3 bucket name, the zip file name (the "key"), and an IAM role ARN that allows Amazon GameLift to access the S3 storage location. The S3 bucket must be in the same Region as the script you're updating. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version. To call this operation with a storage location, you must have IAM PassRole permission. For more details on IAM roles and PassRole permissions, see Set up a role for GameLift access.

Definition at line 229 of file UpdateScriptRequest.h.

◆ SetStorageLocation() [2/2]

void Aws::GameLift::Model::UpdateScriptRequest::SetStorageLocation ( S3Location &&  value)
inline

The Amazon S3 location of your Realtime scripts. The storage location must specify the S3 bucket name, the zip file name (the "key"), and an IAM role ARN that allows Amazon GameLift to access the S3 storage location. The S3 bucket must be in the same Region as the script you're updating. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version. To call this operation with a storage location, you must have IAM PassRole permission. For more details on IAM roles and PassRole permissions, see Set up a role for GameLift access.

Definition at line 244 of file UpdateScriptRequest.h.

◆ SetVersion() [1/3]

void Aws::GameLift::Model::UpdateScriptRequest::SetVersion ( Aws::String &&  value)
inline

The version that is associated with a build or script. Version strings do not need to be unique.

Definition at line 159 of file UpdateScriptRequest.h.

◆ SetVersion() [2/3]

void Aws::GameLift::Model::UpdateScriptRequest::SetVersion ( const Aws::String value)
inline

The version that is associated with a build or script. Version strings do not need to be unique.

Definition at line 153 of file UpdateScriptRequest.h.

◆ SetVersion() [3/3]

void Aws::GameLift::Model::UpdateScriptRequest::SetVersion ( const char *  value)
inline

The version that is associated with a build or script. Version strings do not need to be unique.

Definition at line 165 of file UpdateScriptRequest.h.

◆ SetZipFile() [1/2]

void Aws::GameLift::Model::UpdateScriptRequest::SetZipFile ( Aws::Utils::ByteBuffer &&  value)
inline

A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.

When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: –zip-file fileb://myRealtimeScript.zip.

Definition at line 315 of file UpdateScriptRequest.h.

◆ SetZipFile() [2/2]

void Aws::GameLift::Model::UpdateScriptRequest::SetZipFile ( const Aws::Utils::ByteBuffer value)
inline

A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.

When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: –zip-file fileb://myRealtimeScript.zip.

Definition at line 305 of file UpdateScriptRequest.h.

◆ StorageLocationHasBeenSet()

bool Aws::GameLift::Model::UpdateScriptRequest::StorageLocationHasBeenSet ( ) const
inline

The Amazon S3 location of your Realtime scripts. The storage location must specify the S3 bucket name, the zip file name (the "key"), and an IAM role ARN that allows Amazon GameLift to access the S3 storage location. The S3 bucket must be in the same Region as the script you're updating. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version. To call this operation with a storage location, you must have IAM PassRole permission. For more details on IAM roles and PassRole permissions, see Set up a role for GameLift access.

Definition at line 214 of file UpdateScriptRequest.h.

◆ VersionHasBeenSet()

bool Aws::GameLift::Model::UpdateScriptRequest::VersionHasBeenSet ( ) const
inline

The version that is associated with a build or script. Version strings do not need to be unique.

Definition at line 147 of file UpdateScriptRequest.h.

◆ WithName() [1/3]

UpdateScriptRequest& Aws::GameLift::Model::UpdateScriptRequest::WithName ( Aws::String &&  value)
inline

A descriptive label that is associated with a script. Script names do not need to be unique.

Definition at line 128 of file UpdateScriptRequest.h.

◆ WithName() [2/3]

UpdateScriptRequest& Aws::GameLift::Model::UpdateScriptRequest::WithName ( const Aws::String value)
inline

A descriptive label that is associated with a script. Script names do not need to be unique.

Definition at line 122 of file UpdateScriptRequest.h.

◆ WithName() [3/3]

UpdateScriptRequest& Aws::GameLift::Model::UpdateScriptRequest::WithName ( const char *  value)
inline

A descriptive label that is associated with a script. Script names do not need to be unique.

Definition at line 134 of file UpdateScriptRequest.h.

◆ WithScriptId() [1/3]

UpdateScriptRequest& Aws::GameLift::Model::UpdateScriptRequest::WithScriptId ( Aws::String &&  value)
inline

A unique identifier for a Realtime script to update. You can use either the script ID or ARN value.

Definition at line 79 of file UpdateScriptRequest.h.

◆ WithScriptId() [2/3]

UpdateScriptRequest& Aws::GameLift::Model::UpdateScriptRequest::WithScriptId ( const Aws::String value)
inline

A unique identifier for a Realtime script to update. You can use either the script ID or ARN value.

Definition at line 73 of file UpdateScriptRequest.h.

◆ WithScriptId() [3/3]

UpdateScriptRequest& Aws::GameLift::Model::UpdateScriptRequest::WithScriptId ( const char *  value)
inline

A unique identifier for a Realtime script to update. You can use either the script ID or ARN value.

Definition at line 85 of file UpdateScriptRequest.h.

◆ WithStorageLocation() [1/2]

UpdateScriptRequest& Aws::GameLift::Model::UpdateScriptRequest::WithStorageLocation ( const S3Location value)
inline

The Amazon S3 location of your Realtime scripts. The storage location must specify the S3 bucket name, the zip file name (the "key"), and an IAM role ARN that allows Amazon GameLift to access the S3 storage location. The S3 bucket must be in the same Region as the script you're updating. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version. To call this operation with a storage location, you must have IAM PassRole permission. For more details on IAM roles and PassRole permissions, see Set up a role for GameLift access.

Definition at line 259 of file UpdateScriptRequest.h.

◆ WithStorageLocation() [2/2]

UpdateScriptRequest& Aws::GameLift::Model::UpdateScriptRequest::WithStorageLocation ( S3Location &&  value)
inline

The Amazon S3 location of your Realtime scripts. The storage location must specify the S3 bucket name, the zip file name (the "key"), and an IAM role ARN that allows Amazon GameLift to access the S3 storage location. The S3 bucket must be in the same Region as the script you're updating. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version. To call this operation with a storage location, you must have IAM PassRole permission. For more details on IAM roles and PassRole permissions, see Set up a role for GameLift access.

Definition at line 274 of file UpdateScriptRequest.h.

◆ WithVersion() [1/3]

UpdateScriptRequest& Aws::GameLift::Model::UpdateScriptRequest::WithVersion ( Aws::String &&  value)
inline

The version that is associated with a build or script. Version strings do not need to be unique.

Definition at line 177 of file UpdateScriptRequest.h.

◆ WithVersion() [2/3]

UpdateScriptRequest& Aws::GameLift::Model::UpdateScriptRequest::WithVersion ( const Aws::String value)
inline

The version that is associated with a build or script. Version strings do not need to be unique.

Definition at line 171 of file UpdateScriptRequest.h.

◆ WithVersion() [3/3]

UpdateScriptRequest& Aws::GameLift::Model::UpdateScriptRequest::WithVersion ( const char *  value)
inline

The version that is associated with a build or script. Version strings do not need to be unique.

Definition at line 183 of file UpdateScriptRequest.h.

◆ WithZipFile() [1/2]

UpdateScriptRequest& Aws::GameLift::Model::UpdateScriptRequest::WithZipFile ( Aws::Utils::ByteBuffer &&  value)
inline

A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.

When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: –zip-file fileb://myRealtimeScript.zip.

Definition at line 335 of file UpdateScriptRequest.h.

◆ WithZipFile() [2/2]

UpdateScriptRequest& Aws::GameLift::Model::UpdateScriptRequest::WithZipFile ( const Aws::Utils::ByteBuffer value)
inline

A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.

When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: –zip-file fileb://myRealtimeScript.zip.

Definition at line 325 of file UpdateScriptRequest.h.

◆ ZipFileHasBeenSet()

bool Aws::GameLift::Model::UpdateScriptRequest::ZipFileHasBeenSet ( ) const
inline

A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.

When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: –zip-file fileb://myRealtimeScript.zip.

Definition at line 295 of file UpdateScriptRequest.h.


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