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

#include <UpdateFleetAttributesRequest.h>

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

Public Member Functions

 UpdateFleetAttributesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetFleetId () const
 
bool FleetIdHasBeenSet () const
 
void SetFleetId (const Aws::String &value)
 
void SetFleetId (Aws::String &&value)
 
void SetFleetId (const char *value)
 
UpdateFleetAttributesRequestWithFleetId (const Aws::String &value)
 
UpdateFleetAttributesRequestWithFleetId (Aws::String &&value)
 
UpdateFleetAttributesRequestWithFleetId (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)
 
UpdateFleetAttributesRequestWithName (const Aws::String &value)
 
UpdateFleetAttributesRequestWithName (Aws::String &&value)
 
UpdateFleetAttributesRequestWithName (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
UpdateFleetAttributesRequestWithDescription (const Aws::String &value)
 
UpdateFleetAttributesRequestWithDescription (Aws::String &&value)
 
UpdateFleetAttributesRequestWithDescription (const char *value)
 
const ProtectionPolicyGetNewGameSessionProtectionPolicy () const
 
bool NewGameSessionProtectionPolicyHasBeenSet () const
 
void SetNewGameSessionProtectionPolicy (const ProtectionPolicy &value)
 
void SetNewGameSessionProtectionPolicy (ProtectionPolicy &&value)
 
UpdateFleetAttributesRequestWithNewGameSessionProtectionPolicy (const ProtectionPolicy &value)
 
UpdateFleetAttributesRequestWithNewGameSessionProtectionPolicy (ProtectionPolicy &&value)
 
const ResourceCreationLimitPolicyGetResourceCreationLimitPolicy () const
 
bool ResourceCreationLimitPolicyHasBeenSet () const
 
void SetResourceCreationLimitPolicy (const ResourceCreationLimitPolicy &value)
 
void SetResourceCreationLimitPolicy (ResourceCreationLimitPolicy &&value)
 
UpdateFleetAttributesRequestWithResourceCreationLimitPolicy (const ResourceCreationLimitPolicy &value)
 
UpdateFleetAttributesRequestWithResourceCreationLimitPolicy (ResourceCreationLimitPolicy &&value)
 
const Aws::Vector< Aws::String > & GetMetricGroups () const
 
bool MetricGroupsHasBeenSet () const
 
void SetMetricGroups (const Aws::Vector< Aws::String > &value)
 
void SetMetricGroups (Aws::Vector< Aws::String > &&value)
 
UpdateFleetAttributesRequestWithMetricGroups (const Aws::Vector< Aws::String > &value)
 
UpdateFleetAttributesRequestWithMetricGroups (Aws::Vector< Aws::String > &&value)
 
UpdateFleetAttributesRequestAddMetricGroups (const Aws::String &value)
 
UpdateFleetAttributesRequestAddMetricGroups (Aws::String &&value)
 
UpdateFleetAttributesRequestAddMetricGroups (const char *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

Represents the input for a request operation.

See Also:

AWS API Reference

Definition at line 27 of file UpdateFleetAttributesRequest.h.

Constructor & Destructor Documentation

◆ UpdateFleetAttributesRequest()

Aws::GameLift::Model::UpdateFleetAttributesRequest::UpdateFleetAttributesRequest ( )

Member Function Documentation

◆ AddMetricGroups() [1/3]

UpdateFleetAttributesRequest& Aws::GameLift::Model::UpdateFleetAttributesRequest::AddMetricGroups ( Aws::String &&  value)
inline

The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.

Definition at line 348 of file UpdateFleetAttributesRequest.h.

◆ AddMetricGroups() [2/3]

UpdateFleetAttributesRequest& Aws::GameLift::Model::UpdateFleetAttributesRequest::AddMetricGroups ( const Aws::String value)
inline

The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.

Definition at line 340 of file UpdateFleetAttributesRequest.h.

◆ AddMetricGroups() [3/3]

UpdateFleetAttributesRequest& Aws::GameLift::Model::UpdateFleetAttributesRequest::AddMetricGroups ( const char *  value)
inline

The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.

Definition at line 356 of file UpdateFleetAttributesRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::GameLift::Model::UpdateFleetAttributesRequest::DescriptionHasBeenSet ( ) const
inline

A human-readable description of a fleet.

Definition at line 149 of file UpdateFleetAttributesRequest.h.

◆ FleetIdHasBeenSet()

bool Aws::GameLift::Model::UpdateFleetAttributesRequest::FleetIdHasBeenSet ( ) const
inline

A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.

Definition at line 53 of file UpdateFleetAttributesRequest.h.

◆ GetDescription()

const Aws::String& Aws::GameLift::Model::UpdateFleetAttributesRequest::GetDescription ( ) const
inline

A human-readable description of a fleet.

Definition at line 144 of file UpdateFleetAttributesRequest.h.

◆ GetFleetId()

const Aws::String& Aws::GameLift::Model::UpdateFleetAttributesRequest::GetFleetId ( ) const
inline

A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.

Definition at line 47 of file UpdateFleetAttributesRequest.h.

◆ GetMetricGroups()

const Aws::Vector<Aws::String>& Aws::GameLift::Model::UpdateFleetAttributesRequest::GetMetricGroups ( ) const
inline

The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.

Definition at line 292 of file UpdateFleetAttributesRequest.h.

◆ GetName()

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

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

Definition at line 96 of file UpdateFleetAttributesRequest.h.

◆ GetNewGameSessionProtectionPolicy()

const ProtectionPolicy& Aws::GameLift::Model::UpdateFleetAttributesRequest::GetNewGameSessionProtectionPolicy ( ) const
inline

The game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession.

  • NoProtection – The game session can be terminated during a scale-down event.

  • FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Definition at line 191 of file UpdateFleetAttributesRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetResourceCreationLimitPolicy()

const ResourceCreationLimitPolicy& Aws::GameLift::Model::UpdateFleetAttributesRequest::GetResourceCreationLimitPolicy ( ) const
inline

Policy settings that limit the number of game sessions an individual player can create over a span of time.

Definition at line 253 of file UpdateFleetAttributesRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file UpdateFleetAttributesRequest.h.

◆ MetricGroupsHasBeenSet()

bool Aws::GameLift::Model::UpdateFleetAttributesRequest::MetricGroupsHasBeenSet ( ) const
inline

The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.

Definition at line 300 of file UpdateFleetAttributesRequest.h.

◆ NameHasBeenSet()

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

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

Definition at line 102 of file UpdateFleetAttributesRequest.h.

◆ NewGameSessionProtectionPolicyHasBeenSet()

bool Aws::GameLift::Model::UpdateFleetAttributesRequest::NewGameSessionProtectionPolicyHasBeenSet ( ) const
inline

The game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession.

  • NoProtection – The game session can be terminated during a scale-down event.

  • FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Definition at line 202 of file UpdateFleetAttributesRequest.h.

◆ ResourceCreationLimitPolicyHasBeenSet()

bool Aws::GameLift::Model::UpdateFleetAttributesRequest::ResourceCreationLimitPolicyHasBeenSet ( ) const
inline

Policy settings that limit the number of game sessions an individual player can create over a span of time.

Definition at line 259 of file UpdateFleetAttributesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDescription() [1/3]

void Aws::GameLift::Model::UpdateFleetAttributesRequest::SetDescription ( Aws::String &&  value)
inline

A human-readable description of a fleet.

Definition at line 159 of file UpdateFleetAttributesRequest.h.

◆ SetDescription() [2/3]

void Aws::GameLift::Model::UpdateFleetAttributesRequest::SetDescription ( const Aws::String value)
inline

A human-readable description of a fleet.

Definition at line 154 of file UpdateFleetAttributesRequest.h.

◆ SetDescription() [3/3]

void Aws::GameLift::Model::UpdateFleetAttributesRequest::SetDescription ( const char *  value)
inline

A human-readable description of a fleet.

Definition at line 164 of file UpdateFleetAttributesRequest.h.

◆ SetFleetId() [1/3]

void Aws::GameLift::Model::UpdateFleetAttributesRequest::SetFleetId ( Aws::String &&  value)
inline

A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.

Definition at line 65 of file UpdateFleetAttributesRequest.h.

◆ SetFleetId() [2/3]

void Aws::GameLift::Model::UpdateFleetAttributesRequest::SetFleetId ( const Aws::String value)
inline

A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.

Definition at line 59 of file UpdateFleetAttributesRequest.h.

◆ SetFleetId() [3/3]

void Aws::GameLift::Model::UpdateFleetAttributesRequest::SetFleetId ( const char *  value)
inline

A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.

Definition at line 71 of file UpdateFleetAttributesRequest.h.

◆ SetMetricGroups() [1/2]

void Aws::GameLift::Model::UpdateFleetAttributesRequest::SetMetricGroups ( Aws::Vector< Aws::String > &&  value)
inline

The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.

Definition at line 316 of file UpdateFleetAttributesRequest.h.

◆ SetMetricGroups() [2/2]

void Aws::GameLift::Model::UpdateFleetAttributesRequest::SetMetricGroups ( const Aws::Vector< Aws::String > &  value)
inline

The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.

Definition at line 308 of file UpdateFleetAttributesRequest.h.

◆ SetName() [1/3]

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

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

Definition at line 114 of file UpdateFleetAttributesRequest.h.

◆ SetName() [2/3]

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

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

Definition at line 108 of file UpdateFleetAttributesRequest.h.

◆ SetName() [3/3]

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

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

Definition at line 120 of file UpdateFleetAttributesRequest.h.

◆ SetNewGameSessionProtectionPolicy() [1/2]

void Aws::GameLift::Model::UpdateFleetAttributesRequest::SetNewGameSessionProtectionPolicy ( const ProtectionPolicy value)
inline

The game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession.

  • NoProtection – The game session can be terminated during a scale-down event.

  • FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Definition at line 213 of file UpdateFleetAttributesRequest.h.

◆ SetNewGameSessionProtectionPolicy() [2/2]

void Aws::GameLift::Model::UpdateFleetAttributesRequest::SetNewGameSessionProtectionPolicy ( ProtectionPolicy &&  value)
inline

The game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession.

  • NoProtection – The game session can be terminated during a scale-down event.

  • FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Definition at line 224 of file UpdateFleetAttributesRequest.h.

◆ SetResourceCreationLimitPolicy() [1/2]

void Aws::GameLift::Model::UpdateFleetAttributesRequest::SetResourceCreationLimitPolicy ( const ResourceCreationLimitPolicy value)
inline

Policy settings that limit the number of game sessions an individual player can create over a span of time.

Definition at line 265 of file UpdateFleetAttributesRequest.h.

◆ SetResourceCreationLimitPolicy() [2/2]

void Aws::GameLift::Model::UpdateFleetAttributesRequest::SetResourceCreationLimitPolicy ( ResourceCreationLimitPolicy &&  value)
inline

Policy settings that limit the number of game sessions an individual player can create over a span of time.

Definition at line 271 of file UpdateFleetAttributesRequest.h.

◆ WithDescription() [1/3]

UpdateFleetAttributesRequest& Aws::GameLift::Model::UpdateFleetAttributesRequest::WithDescription ( Aws::String &&  value)
inline

A human-readable description of a fleet.

Definition at line 174 of file UpdateFleetAttributesRequest.h.

◆ WithDescription() [2/3]

UpdateFleetAttributesRequest& Aws::GameLift::Model::UpdateFleetAttributesRequest::WithDescription ( const Aws::String value)
inline

A human-readable description of a fleet.

Definition at line 169 of file UpdateFleetAttributesRequest.h.

◆ WithDescription() [3/3]

UpdateFleetAttributesRequest& Aws::GameLift::Model::UpdateFleetAttributesRequest::WithDescription ( const char *  value)
inline

A human-readable description of a fleet.

Definition at line 179 of file UpdateFleetAttributesRequest.h.

◆ WithFleetId() [1/3]

UpdateFleetAttributesRequest& Aws::GameLift::Model::UpdateFleetAttributesRequest::WithFleetId ( Aws::String &&  value)
inline

A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.

Definition at line 83 of file UpdateFleetAttributesRequest.h.

◆ WithFleetId() [2/3]

UpdateFleetAttributesRequest& Aws::GameLift::Model::UpdateFleetAttributesRequest::WithFleetId ( const Aws::String value)
inline

A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.

Definition at line 77 of file UpdateFleetAttributesRequest.h.

◆ WithFleetId() [3/3]

UpdateFleetAttributesRequest& Aws::GameLift::Model::UpdateFleetAttributesRequest::WithFleetId ( const char *  value)
inline

A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.

Definition at line 89 of file UpdateFleetAttributesRequest.h.

◆ WithMetricGroups() [1/2]

UpdateFleetAttributesRequest& Aws::GameLift::Model::UpdateFleetAttributesRequest::WithMetricGroups ( Aws::Vector< Aws::String > &&  value)
inline

The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.

Definition at line 332 of file UpdateFleetAttributesRequest.h.

◆ WithMetricGroups() [2/2]

UpdateFleetAttributesRequest& Aws::GameLift::Model::UpdateFleetAttributesRequest::WithMetricGroups ( const Aws::Vector< Aws::String > &  value)
inline

The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.

Definition at line 324 of file UpdateFleetAttributesRequest.h.

◆ WithName() [1/3]

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

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

Definition at line 132 of file UpdateFleetAttributesRequest.h.

◆ WithName() [2/3]

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

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

Definition at line 126 of file UpdateFleetAttributesRequest.h.

◆ WithName() [3/3]

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

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

Definition at line 138 of file UpdateFleetAttributesRequest.h.

◆ WithNewGameSessionProtectionPolicy() [1/2]

UpdateFleetAttributesRequest& Aws::GameLift::Model::UpdateFleetAttributesRequest::WithNewGameSessionProtectionPolicy ( const ProtectionPolicy value)
inline

The game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession.

  • NoProtection – The game session can be terminated during a scale-down event.

  • FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Definition at line 235 of file UpdateFleetAttributesRequest.h.

◆ WithNewGameSessionProtectionPolicy() [2/2]

UpdateFleetAttributesRequest& Aws::GameLift::Model::UpdateFleetAttributesRequest::WithNewGameSessionProtectionPolicy ( ProtectionPolicy &&  value)
inline

The game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession.

  • NoProtection – The game session can be terminated during a scale-down event.

  • FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Definition at line 246 of file UpdateFleetAttributesRequest.h.

◆ WithResourceCreationLimitPolicy() [1/2]

UpdateFleetAttributesRequest& Aws::GameLift::Model::UpdateFleetAttributesRequest::WithResourceCreationLimitPolicy ( const ResourceCreationLimitPolicy value)
inline

Policy settings that limit the number of game sessions an individual player can create over a span of time.

Definition at line 277 of file UpdateFleetAttributesRequest.h.

◆ WithResourceCreationLimitPolicy() [2/2]

UpdateFleetAttributesRequest& Aws::GameLift::Model::UpdateFleetAttributesRequest::WithResourceCreationLimitPolicy ( ResourceCreationLimitPolicy &&  value)
inline

Policy settings that limit the number of game sessions an individual player can create over a span of time.

Definition at line 283 of file UpdateFleetAttributesRequest.h.


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