AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::Amplify::Model::StartJobRequest Class Reference

#include <StartJobRequest.h>

+ Inheritance diagram for Aws::Amplify::Model::StartJobRequest:

Public Member Functions

 StartJobRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetAppId () const
 
bool AppIdHasBeenSet () const
 
void SetAppId (const Aws::String &value)
 
void SetAppId (Aws::String &&value)
 
void SetAppId (const char *value)
 
StartJobRequestWithAppId (const Aws::String &value)
 
StartJobRequestWithAppId (Aws::String &&value)
 
StartJobRequestWithAppId (const char *value)
 
const Aws::StringGetBranchName () const
 
bool BranchNameHasBeenSet () const
 
void SetBranchName (const Aws::String &value)
 
void SetBranchName (Aws::String &&value)
 
void SetBranchName (const char *value)
 
StartJobRequestWithBranchName (const Aws::String &value)
 
StartJobRequestWithBranchName (Aws::String &&value)
 
StartJobRequestWithBranchName (const char *value)
 
const Aws::StringGetJobId () const
 
bool JobIdHasBeenSet () const
 
void SetJobId (const Aws::String &value)
 
void SetJobId (Aws::String &&value)
 
void SetJobId (const char *value)
 
StartJobRequestWithJobId (const Aws::String &value)
 
StartJobRequestWithJobId (Aws::String &&value)
 
StartJobRequestWithJobId (const char *value)
 
const JobTypeGetJobType () const
 
bool JobTypeHasBeenSet () const
 
void SetJobType (const JobType &value)
 
void SetJobType (JobType &&value)
 
StartJobRequestWithJobType (const JobType &value)
 
StartJobRequestWithJobType (JobType &&value)
 
const Aws::StringGetJobReason () const
 
bool JobReasonHasBeenSet () const
 
void SetJobReason (const Aws::String &value)
 
void SetJobReason (Aws::String &&value)
 
void SetJobReason (const char *value)
 
StartJobRequestWithJobReason (const Aws::String &value)
 
StartJobRequestWithJobReason (Aws::String &&value)
 
StartJobRequestWithJobReason (const char *value)
 
const Aws::StringGetCommitId () const
 
bool CommitIdHasBeenSet () const
 
void SetCommitId (const Aws::String &value)
 
void SetCommitId (Aws::String &&value)
 
void SetCommitId (const char *value)
 
StartJobRequestWithCommitId (const Aws::String &value)
 
StartJobRequestWithCommitId (Aws::String &&value)
 
StartJobRequestWithCommitId (const char *value)
 
const Aws::StringGetCommitMessage () const
 
bool CommitMessageHasBeenSet () const
 
void SetCommitMessage (const Aws::String &value)
 
void SetCommitMessage (Aws::String &&value)
 
void SetCommitMessage (const char *value)
 
StartJobRequestWithCommitMessage (const Aws::String &value)
 
StartJobRequestWithCommitMessage (Aws::String &&value)
 
StartJobRequestWithCommitMessage (const char *value)
 
const Aws::Utils::DateTimeGetCommitTime () const
 
bool CommitTimeHasBeenSet () const
 
void SetCommitTime (const Aws::Utils::DateTime &value)
 
void SetCommitTime (Aws::Utils::DateTime &&value)
 
StartJobRequestWithCommitTime (const Aws::Utils::DateTime &value)
 
StartJobRequestWithCommitTime (Aws::Utils::DateTime &&value)
 
- Public Member Functions inherited from Aws::Amplify::AmplifyRequest
virtual ~AmplifyRequest ()
 
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::Amplify::AmplifyRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

The request structure for the start job request.

See Also:

AWS API Reference

Definition at line 27 of file StartJobRequest.h.

Constructor & Destructor Documentation

◆ StartJobRequest()

Aws::Amplify::Model::StartJobRequest::StartJobRequest ( )

Member Function Documentation

◆ AppIdHasBeenSet()

bool Aws::Amplify::Model::StartJobRequest::AppIdHasBeenSet ( ) const
inline

The unique ID for an Amplify app.

Definition at line 49 of file StartJobRequest.h.

◆ BranchNameHasBeenSet()

bool Aws::Amplify::Model::StartJobRequest::BranchNameHasBeenSet ( ) const
inline

The branch name for the job.

Definition at line 90 of file StartJobRequest.h.

◆ CommitIdHasBeenSet()

bool Aws::Amplify::Model::StartJobRequest::CommitIdHasBeenSet ( ) const
inline

The commit ID from a third-party repository provider for the job.

Definition at line 276 of file StartJobRequest.h.

◆ CommitMessageHasBeenSet()

bool Aws::Amplify::Model::StartJobRequest::CommitMessageHasBeenSet ( ) const
inline

The commit message from a third-party repository provider for the job.

Definition at line 317 of file StartJobRequest.h.

◆ CommitTimeHasBeenSet()

bool Aws::Amplify::Model::StartJobRequest::CommitTimeHasBeenSet ( ) const
inline

The commit date and time for the job.

Definition at line 358 of file StartJobRequest.h.

◆ GetAppId()

const Aws::String& Aws::Amplify::Model::StartJobRequest::GetAppId ( ) const
inline

The unique ID for an Amplify app.

Definition at line 44 of file StartJobRequest.h.

◆ GetBranchName()

const Aws::String& Aws::Amplify::Model::StartJobRequest::GetBranchName ( ) const
inline

The branch name for the job.

Definition at line 85 of file StartJobRequest.h.

◆ GetCommitId()

const Aws::String& Aws::Amplify::Model::StartJobRequest::GetCommitId ( ) const
inline

The commit ID from a third-party repository provider for the job.

Definition at line 271 of file StartJobRequest.h.

◆ GetCommitMessage()

const Aws::String& Aws::Amplify::Model::StartJobRequest::GetCommitMessage ( ) const
inline

The commit message from a third-party repository provider for the job.

Definition at line 312 of file StartJobRequest.h.

◆ GetCommitTime()

const Aws::Utils::DateTime& Aws::Amplify::Model::StartJobRequest::GetCommitTime ( ) const
inline

The commit date and time for the job.

Definition at line 353 of file StartJobRequest.h.

◆ GetJobId()

const Aws::String& Aws::Amplify::Model::StartJobRequest::GetJobId ( ) const
inline

The unique ID for an existing job. This is required if the value of jobType is RETRY.

Definition at line 127 of file StartJobRequest.h.

◆ GetJobReason()

const Aws::String& Aws::Amplify::Model::StartJobRequest::GetJobReason ( ) const
inline

A descriptive reason for starting this job.

Definition at line 230 of file StartJobRequest.h.

◆ GetJobType()

const JobType& Aws::Amplify::Model::StartJobRequest::GetJobType ( ) const
inline

Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository. The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.

Definition at line 179 of file StartJobRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Amplify::Model::StartJobRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file StartJobRequest.h.

◆ JobIdHasBeenSet()

bool Aws::Amplify::Model::StartJobRequest::JobIdHasBeenSet ( ) const
inline

The unique ID for an existing job. This is required if the value of jobType is RETRY.

Definition at line 133 of file StartJobRequest.h.

◆ JobReasonHasBeenSet()

bool Aws::Amplify::Model::StartJobRequest::JobReasonHasBeenSet ( ) const
inline

A descriptive reason for starting this job.

Definition at line 235 of file StartJobRequest.h.

◆ JobTypeHasBeenSet()

bool Aws::Amplify::Model::StartJobRequest::JobTypeHasBeenSet ( ) const
inline

Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository. The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.

Definition at line 188 of file StartJobRequest.h.

◆ SerializePayload()

Aws::String Aws::Amplify::Model::StartJobRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAppId() [1/3]

void Aws::Amplify::Model::StartJobRequest::SetAppId ( const Aws::String value)
inline

The unique ID for an Amplify app.

Definition at line 54 of file StartJobRequest.h.

◆ SetAppId() [2/3]

void Aws::Amplify::Model::StartJobRequest::SetAppId ( Aws::String &&  value)
inline

The unique ID for an Amplify app.

Definition at line 59 of file StartJobRequest.h.

◆ SetAppId() [3/3]

void Aws::Amplify::Model::StartJobRequest::SetAppId ( const char *  value)
inline

The unique ID for an Amplify app.

Definition at line 64 of file StartJobRequest.h.

◆ SetBranchName() [1/3]

void Aws::Amplify::Model::StartJobRequest::SetBranchName ( const Aws::String value)
inline

The branch name for the job.

Definition at line 95 of file StartJobRequest.h.

◆ SetBranchName() [2/3]

void Aws::Amplify::Model::StartJobRequest::SetBranchName ( Aws::String &&  value)
inline

The branch name for the job.

Definition at line 100 of file StartJobRequest.h.

◆ SetBranchName() [3/3]

void Aws::Amplify::Model::StartJobRequest::SetBranchName ( const char *  value)
inline

The branch name for the job.

Definition at line 105 of file StartJobRequest.h.

◆ SetCommitId() [1/3]

void Aws::Amplify::Model::StartJobRequest::SetCommitId ( const Aws::String value)
inline

The commit ID from a third-party repository provider for the job.

Definition at line 281 of file StartJobRequest.h.

◆ SetCommitId() [2/3]

void Aws::Amplify::Model::StartJobRequest::SetCommitId ( Aws::String &&  value)
inline

The commit ID from a third-party repository provider for the job.

Definition at line 286 of file StartJobRequest.h.

◆ SetCommitId() [3/3]

void Aws::Amplify::Model::StartJobRequest::SetCommitId ( const char *  value)
inline

The commit ID from a third-party repository provider for the job.

Definition at line 291 of file StartJobRequest.h.

◆ SetCommitMessage() [1/3]

void Aws::Amplify::Model::StartJobRequest::SetCommitMessage ( const Aws::String value)
inline

The commit message from a third-party repository provider for the job.

Definition at line 322 of file StartJobRequest.h.

◆ SetCommitMessage() [2/3]

void Aws::Amplify::Model::StartJobRequest::SetCommitMessage ( Aws::String &&  value)
inline

The commit message from a third-party repository provider for the job.

Definition at line 327 of file StartJobRequest.h.

◆ SetCommitMessage() [3/3]

void Aws::Amplify::Model::StartJobRequest::SetCommitMessage ( const char *  value)
inline

The commit message from a third-party repository provider for the job.

Definition at line 332 of file StartJobRequest.h.

◆ SetCommitTime() [1/2]

void Aws::Amplify::Model::StartJobRequest::SetCommitTime ( const Aws::Utils::DateTime value)
inline

The commit date and time for the job.

Definition at line 363 of file StartJobRequest.h.

◆ SetCommitTime() [2/2]

void Aws::Amplify::Model::StartJobRequest::SetCommitTime ( Aws::Utils::DateTime &&  value)
inline

The commit date and time for the job.

Definition at line 368 of file StartJobRequest.h.

◆ SetJobId() [1/3]

void Aws::Amplify::Model::StartJobRequest::SetJobId ( const Aws::String value)
inline

The unique ID for an existing job. This is required if the value of jobType is RETRY.

Definition at line 139 of file StartJobRequest.h.

◆ SetJobId() [2/3]

void Aws::Amplify::Model::StartJobRequest::SetJobId ( Aws::String &&  value)
inline

The unique ID for an existing job. This is required if the value of jobType is RETRY.

Definition at line 145 of file StartJobRequest.h.

◆ SetJobId() [3/3]

void Aws::Amplify::Model::StartJobRequest::SetJobId ( const char *  value)
inline

The unique ID for an existing job. This is required if the value of jobType is RETRY.

Definition at line 151 of file StartJobRequest.h.

◆ SetJobReason() [1/3]

void Aws::Amplify::Model::StartJobRequest::SetJobReason ( const Aws::String value)
inline

A descriptive reason for starting this job.

Definition at line 240 of file StartJobRequest.h.

◆ SetJobReason() [2/3]

void Aws::Amplify::Model::StartJobRequest::SetJobReason ( Aws::String &&  value)
inline

A descriptive reason for starting this job.

Definition at line 245 of file StartJobRequest.h.

◆ SetJobReason() [3/3]

void Aws::Amplify::Model::StartJobRequest::SetJobReason ( const char *  value)
inline

A descriptive reason for starting this job.

Definition at line 250 of file StartJobRequest.h.

◆ SetJobType() [1/2]

void Aws::Amplify::Model::StartJobRequest::SetJobType ( const JobType value)
inline

Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository. The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.

Definition at line 197 of file StartJobRequest.h.

◆ SetJobType() [2/2]

void Aws::Amplify::Model::StartJobRequest::SetJobType ( JobType &&  value)
inline

Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository. The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.

Definition at line 206 of file StartJobRequest.h.

◆ WithAppId() [1/3]

StartJobRequest& Aws::Amplify::Model::StartJobRequest::WithAppId ( const Aws::String value)
inline

The unique ID for an Amplify app.

Definition at line 69 of file StartJobRequest.h.

◆ WithAppId() [2/3]

StartJobRequest& Aws::Amplify::Model::StartJobRequest::WithAppId ( Aws::String &&  value)
inline

The unique ID for an Amplify app.

Definition at line 74 of file StartJobRequest.h.

◆ WithAppId() [3/3]

StartJobRequest& Aws::Amplify::Model::StartJobRequest::WithAppId ( const char *  value)
inline

The unique ID for an Amplify app.

Definition at line 79 of file StartJobRequest.h.

◆ WithBranchName() [1/3]

StartJobRequest& Aws::Amplify::Model::StartJobRequest::WithBranchName ( const Aws::String value)
inline

The branch name for the job.

Definition at line 110 of file StartJobRequest.h.

◆ WithBranchName() [2/3]

StartJobRequest& Aws::Amplify::Model::StartJobRequest::WithBranchName ( Aws::String &&  value)
inline

The branch name for the job.

Definition at line 115 of file StartJobRequest.h.

◆ WithBranchName() [3/3]

StartJobRequest& Aws::Amplify::Model::StartJobRequest::WithBranchName ( const char *  value)
inline

The branch name for the job.

Definition at line 120 of file StartJobRequest.h.

◆ WithCommitId() [1/3]

StartJobRequest& Aws::Amplify::Model::StartJobRequest::WithCommitId ( const Aws::String value)
inline

The commit ID from a third-party repository provider for the job.

Definition at line 296 of file StartJobRequest.h.

◆ WithCommitId() [2/3]

StartJobRequest& Aws::Amplify::Model::StartJobRequest::WithCommitId ( Aws::String &&  value)
inline

The commit ID from a third-party repository provider for the job.

Definition at line 301 of file StartJobRequest.h.

◆ WithCommitId() [3/3]

StartJobRequest& Aws::Amplify::Model::StartJobRequest::WithCommitId ( const char *  value)
inline

The commit ID from a third-party repository provider for the job.

Definition at line 306 of file StartJobRequest.h.

◆ WithCommitMessage() [1/3]

StartJobRequest& Aws::Amplify::Model::StartJobRequest::WithCommitMessage ( const Aws::String value)
inline

The commit message from a third-party repository provider for the job.

Definition at line 337 of file StartJobRequest.h.

◆ WithCommitMessage() [2/3]

StartJobRequest& Aws::Amplify::Model::StartJobRequest::WithCommitMessage ( Aws::String &&  value)
inline

The commit message from a third-party repository provider for the job.

Definition at line 342 of file StartJobRequest.h.

◆ WithCommitMessage() [3/3]

StartJobRequest& Aws::Amplify::Model::StartJobRequest::WithCommitMessage ( const char *  value)
inline

The commit message from a third-party repository provider for the job.

Definition at line 347 of file StartJobRequest.h.

◆ WithCommitTime() [1/2]

StartJobRequest& Aws::Amplify::Model::StartJobRequest::WithCommitTime ( const Aws::Utils::DateTime value)
inline

The commit date and time for the job.

Definition at line 373 of file StartJobRequest.h.

◆ WithCommitTime() [2/2]

StartJobRequest& Aws::Amplify::Model::StartJobRequest::WithCommitTime ( Aws::Utils::DateTime &&  value)
inline

The commit date and time for the job.

Definition at line 378 of file StartJobRequest.h.

◆ WithJobId() [1/3]

StartJobRequest& Aws::Amplify::Model::StartJobRequest::WithJobId ( const Aws::String value)
inline

The unique ID for an existing job. This is required if the value of jobType is RETRY.

Definition at line 157 of file StartJobRequest.h.

◆ WithJobId() [2/3]

StartJobRequest& Aws::Amplify::Model::StartJobRequest::WithJobId ( Aws::String &&  value)
inline

The unique ID for an existing job. This is required if the value of jobType is RETRY.

Definition at line 163 of file StartJobRequest.h.

◆ WithJobId() [3/3]

StartJobRequest& Aws::Amplify::Model::StartJobRequest::WithJobId ( const char *  value)
inline

The unique ID for an existing job. This is required if the value of jobType is RETRY.

Definition at line 169 of file StartJobRequest.h.

◆ WithJobReason() [1/3]

StartJobRequest& Aws::Amplify::Model::StartJobRequest::WithJobReason ( const Aws::String value)
inline

A descriptive reason for starting this job.

Definition at line 255 of file StartJobRequest.h.

◆ WithJobReason() [2/3]

StartJobRequest& Aws::Amplify::Model::StartJobRequest::WithJobReason ( Aws::String &&  value)
inline

A descriptive reason for starting this job.

Definition at line 260 of file StartJobRequest.h.

◆ WithJobReason() [3/3]

StartJobRequest& Aws::Amplify::Model::StartJobRequest::WithJobReason ( const char *  value)
inline

A descriptive reason for starting this job.

Definition at line 265 of file StartJobRequest.h.

◆ WithJobType() [1/2]

StartJobRequest& Aws::Amplify::Model::StartJobRequest::WithJobType ( const JobType value)
inline

Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository. The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.

Definition at line 215 of file StartJobRequest.h.

◆ WithJobType() [2/2]

StartJobRequest& Aws::Amplify::Model::StartJobRequest::WithJobType ( JobType &&  value)
inline

Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository. The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.

Definition at line 224 of file StartJobRequest.h.


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