AWS SDK for C++  1.9.72
AWS SDK for C++
Public Member Functions | List of all members
Aws::StorageGateway::Model::VolumeInfo Class Reference

#include <VolumeInfo.h>

Public Member Functions

 VolumeInfo ()
 
 VolumeInfo (Aws::Utils::Json::JsonView jsonValue)
 
VolumeInfooperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetVolumeARN () const
 
bool VolumeARNHasBeenSet () const
 
void SetVolumeARN (const Aws::String &value)
 
void SetVolumeARN (Aws::String &&value)
 
void SetVolumeARN (const char *value)
 
VolumeInfoWithVolumeARN (const Aws::String &value)
 
VolumeInfoWithVolumeARN (Aws::String &&value)
 
VolumeInfoWithVolumeARN (const char *value)
 
const Aws::StringGetVolumeId () const
 
bool VolumeIdHasBeenSet () const
 
void SetVolumeId (const Aws::String &value)
 
void SetVolumeId (Aws::String &&value)
 
void SetVolumeId (const char *value)
 
VolumeInfoWithVolumeId (const Aws::String &value)
 
VolumeInfoWithVolumeId (Aws::String &&value)
 
VolumeInfoWithVolumeId (const char *value)
 
const Aws::StringGetGatewayARN () const
 
bool GatewayARNHasBeenSet () const
 
void SetGatewayARN (const Aws::String &value)
 
void SetGatewayARN (Aws::String &&value)
 
void SetGatewayARN (const char *value)
 
VolumeInfoWithGatewayARN (const Aws::String &value)
 
VolumeInfoWithGatewayARN (Aws::String &&value)
 
VolumeInfoWithGatewayARN (const char *value)
 
const Aws::StringGetGatewayId () const
 
bool GatewayIdHasBeenSet () const
 
void SetGatewayId (const Aws::String &value)
 
void SetGatewayId (Aws::String &&value)
 
void SetGatewayId (const char *value)
 
VolumeInfoWithGatewayId (const Aws::String &value)
 
VolumeInfoWithGatewayId (Aws::String &&value)
 
VolumeInfoWithGatewayId (const char *value)
 
const Aws::StringGetVolumeType () const
 
bool VolumeTypeHasBeenSet () const
 
void SetVolumeType (const Aws::String &value)
 
void SetVolumeType (Aws::String &&value)
 
void SetVolumeType (const char *value)
 
VolumeInfoWithVolumeType (const Aws::String &value)
 
VolumeInfoWithVolumeType (Aws::String &&value)
 
VolumeInfoWithVolumeType (const char *value)
 
long long GetVolumeSizeInBytes () const
 
bool VolumeSizeInBytesHasBeenSet () const
 
void SetVolumeSizeInBytes (long long value)
 
VolumeInfoWithVolumeSizeInBytes (long long value)
 
const Aws::StringGetVolumeAttachmentStatus () const
 
bool VolumeAttachmentStatusHasBeenSet () const
 
void SetVolumeAttachmentStatus (const Aws::String &value)
 
void SetVolumeAttachmentStatus (Aws::String &&value)
 
void SetVolumeAttachmentStatus (const char *value)
 
VolumeInfoWithVolumeAttachmentStatus (const Aws::String &value)
 
VolumeInfoWithVolumeAttachmentStatus (Aws::String &&value)
 
VolumeInfoWithVolumeAttachmentStatus (const char *value)
 

Detailed Description

Describes a storage volume object.

See Also:

AWS API Reference

Definition at line 31 of file VolumeInfo.h.

Constructor & Destructor Documentation

◆ VolumeInfo() [1/2]

Aws::StorageGateway::Model::VolumeInfo::VolumeInfo ( )

◆ VolumeInfo() [2/2]

Aws::StorageGateway::Model::VolumeInfo::VolumeInfo ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GatewayARNHasBeenSet()

bool Aws::StorageGateway::Model::VolumeInfo::GatewayARNHasBeenSet ( ) const
inline

Definition at line 182 of file VolumeInfo.h.

◆ GatewayIdHasBeenSet()

bool Aws::StorageGateway::Model::VolumeInfo::GatewayIdHasBeenSet ( ) const
inline

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 217 of file VolumeInfo.h.

◆ GetGatewayARN()

const Aws::String& Aws::StorageGateway::Model::VolumeInfo::GetGatewayARN ( ) const
inline

Definition at line 179 of file VolumeInfo.h.

◆ GetGatewayId()

const Aws::String& Aws::StorageGateway::Model::VolumeInfo::GetGatewayId ( ) const
inline

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 209 of file VolumeInfo.h.

◆ GetVolumeARN()

const Aws::String& Aws::StorageGateway::Model::VolumeInfo::GetVolumeARN ( ) const
inline

The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:

arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 47 of file VolumeInfo.h.

◆ GetVolumeAttachmentStatus()

const Aws::String& Aws::StorageGateway::Model::VolumeInfo::GetVolumeAttachmentStatus ( ) const
inline

One of the VolumeStatus values that indicates the state of the storage volume.

Definition at line 346 of file VolumeInfo.h.

◆ GetVolumeId()

const Aws::String& Aws::StorageGateway::Model::VolumeInfo::GetVolumeId ( ) const
inline

The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 119 of file VolumeInfo.h.

◆ GetVolumeSizeInBytes()

long long Aws::StorageGateway::Model::VolumeInfo::GetVolumeSizeInBytes ( ) const
inline

The size of the volume in bytes.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 321 of file VolumeInfo.h.

◆ GetVolumeType()

const Aws::String& Aws::StorageGateway::Model::VolumeInfo::GetVolumeType ( ) const
inline

One of the VolumeType enumeration values describing the type of the volume.

Definition at line 272 of file VolumeInfo.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::StorageGateway::Model::VolumeInfo::Jsonize ( ) const

◆ operator=()

VolumeInfo& Aws::StorageGateway::Model::VolumeInfo::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetGatewayARN() [1/3]

void Aws::StorageGateway::Model::VolumeInfo::SetGatewayARN ( Aws::String &&  value)
inline

Definition at line 188 of file VolumeInfo.h.

◆ SetGatewayARN() [2/3]

void Aws::StorageGateway::Model::VolumeInfo::SetGatewayARN ( const Aws::String value)
inline

Definition at line 185 of file VolumeInfo.h.

◆ SetGatewayARN() [3/3]

void Aws::StorageGateway::Model::VolumeInfo::SetGatewayARN ( const char *  value)
inline

Definition at line 191 of file VolumeInfo.h.

◆ SetGatewayId() [1/3]

void Aws::StorageGateway::Model::VolumeInfo::SetGatewayId ( Aws::String &&  value)
inline

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 233 of file VolumeInfo.h.

◆ SetGatewayId() [2/3]

void Aws::StorageGateway::Model::VolumeInfo::SetGatewayId ( const Aws::String value)
inline

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 225 of file VolumeInfo.h.

◆ SetGatewayId() [3/3]

void Aws::StorageGateway::Model::VolumeInfo::SetGatewayId ( const char *  value)
inline

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 241 of file VolumeInfo.h.

◆ SetVolumeARN() [1/3]

void Aws::StorageGateway::Model::VolumeInfo::SetVolumeARN ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:

arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 74 of file VolumeInfo.h.

◆ SetVolumeARN() [2/3]

void Aws::StorageGateway::Model::VolumeInfo::SetVolumeARN ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:

arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 65 of file VolumeInfo.h.

◆ SetVolumeARN() [3/3]

void Aws::StorageGateway::Model::VolumeInfo::SetVolumeARN ( const char *  value)
inline

The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:

arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 83 of file VolumeInfo.h.

◆ SetVolumeAttachmentStatus() [1/3]

void Aws::StorageGateway::Model::VolumeInfo::SetVolumeAttachmentStatus ( Aws::String &&  value)
inline

One of the VolumeStatus values that indicates the state of the storage volume.

Definition at line 364 of file VolumeInfo.h.

◆ SetVolumeAttachmentStatus() [2/3]

void Aws::StorageGateway::Model::VolumeInfo::SetVolumeAttachmentStatus ( const Aws::String value)
inline

One of the VolumeStatus values that indicates the state of the storage volume.

Definition at line 358 of file VolumeInfo.h.

◆ SetVolumeAttachmentStatus() [3/3]

void Aws::StorageGateway::Model::VolumeInfo::SetVolumeAttachmentStatus ( const char *  value)
inline

One of the VolumeStatus values that indicates the state of the storage volume.

Definition at line 370 of file VolumeInfo.h.

◆ SetVolumeId() [1/3]

void Aws::StorageGateway::Model::VolumeInfo::SetVolumeId ( Aws::String &&  value)
inline

The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 143 of file VolumeInfo.h.

◆ SetVolumeId() [2/3]

void Aws::StorageGateway::Model::VolumeInfo::SetVolumeId ( const Aws::String value)
inline

The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 135 of file VolumeInfo.h.

◆ SetVolumeId() [3/3]

void Aws::StorageGateway::Model::VolumeInfo::SetVolumeId ( const char *  value)
inline

The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 151 of file VolumeInfo.h.

◆ SetVolumeSizeInBytes()

void Aws::StorageGateway::Model::VolumeInfo::SetVolumeSizeInBytes ( long long  value)
inline

The size of the volume in bytes.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 333 of file VolumeInfo.h.

◆ SetVolumeType() [1/3]

void Aws::StorageGateway::Model::VolumeInfo::SetVolumeType ( Aws::String &&  value)
inline

One of the VolumeType enumeration values describing the type of the volume.

Definition at line 290 of file VolumeInfo.h.

◆ SetVolumeType() [2/3]

void Aws::StorageGateway::Model::VolumeInfo::SetVolumeType ( const Aws::String value)
inline

One of the VolumeType enumeration values describing the type of the volume.

Definition at line 284 of file VolumeInfo.h.

◆ SetVolumeType() [3/3]

void Aws::StorageGateway::Model::VolumeInfo::SetVolumeType ( const char *  value)
inline

One of the VolumeType enumeration values describing the type of the volume.

Definition at line 296 of file VolumeInfo.h.

◆ VolumeARNHasBeenSet()

bool Aws::StorageGateway::Model::VolumeInfo::VolumeARNHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:

arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 56 of file VolumeInfo.h.

◆ VolumeAttachmentStatusHasBeenSet()

bool Aws::StorageGateway::Model::VolumeInfo::VolumeAttachmentStatusHasBeenSet ( ) const
inline

One of the VolumeStatus values that indicates the state of the storage volume.

Definition at line 352 of file VolumeInfo.h.

◆ VolumeIdHasBeenSet()

bool Aws::StorageGateway::Model::VolumeInfo::VolumeIdHasBeenSet ( ) const
inline

The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 127 of file VolumeInfo.h.

◆ VolumeSizeInBytesHasBeenSet()

bool Aws::StorageGateway::Model::VolumeInfo::VolumeSizeInBytesHasBeenSet ( ) const
inline

The size of the volume in bytes.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 327 of file VolumeInfo.h.

◆ VolumeTypeHasBeenSet()

bool Aws::StorageGateway::Model::VolumeInfo::VolumeTypeHasBeenSet ( ) const
inline

One of the VolumeType enumeration values describing the type of the volume.

Definition at line 278 of file VolumeInfo.h.

◆ WithGatewayARN() [1/3]

VolumeInfo& Aws::StorageGateway::Model::VolumeInfo::WithGatewayARN ( Aws::String &&  value)
inline

Definition at line 197 of file VolumeInfo.h.

◆ WithGatewayARN() [2/3]

VolumeInfo& Aws::StorageGateway::Model::VolumeInfo::WithGatewayARN ( const Aws::String value)
inline

Definition at line 194 of file VolumeInfo.h.

◆ WithGatewayARN() [3/3]

VolumeInfo& Aws::StorageGateway::Model::VolumeInfo::WithGatewayARN ( const char *  value)
inline

Definition at line 200 of file VolumeInfo.h.

◆ WithGatewayId() [1/3]

VolumeInfo& Aws::StorageGateway::Model::VolumeInfo::WithGatewayId ( Aws::String &&  value)
inline

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 257 of file VolumeInfo.h.

◆ WithGatewayId() [2/3]

VolumeInfo& Aws::StorageGateway::Model::VolumeInfo::WithGatewayId ( const Aws::String value)
inline

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 249 of file VolumeInfo.h.

◆ WithGatewayId() [3/3]

VolumeInfo& Aws::StorageGateway::Model::VolumeInfo::WithGatewayId ( const char *  value)
inline

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 265 of file VolumeInfo.h.

◆ WithVolumeARN() [1/3]

VolumeInfo& Aws::StorageGateway::Model::VolumeInfo::WithVolumeARN ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:

arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 101 of file VolumeInfo.h.

◆ WithVolumeARN() [2/3]

VolumeInfo& Aws::StorageGateway::Model::VolumeInfo::WithVolumeARN ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:

arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 92 of file VolumeInfo.h.

◆ WithVolumeARN() [3/3]

VolumeInfo& Aws::StorageGateway::Model::VolumeInfo::WithVolumeARN ( const char *  value)
inline

The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:

arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 110 of file VolumeInfo.h.

◆ WithVolumeAttachmentStatus() [1/3]

VolumeInfo& Aws::StorageGateway::Model::VolumeInfo::WithVolumeAttachmentStatus ( Aws::String &&  value)
inline

One of the VolumeStatus values that indicates the state of the storage volume.

Definition at line 382 of file VolumeInfo.h.

◆ WithVolumeAttachmentStatus() [2/3]

VolumeInfo& Aws::StorageGateway::Model::VolumeInfo::WithVolumeAttachmentStatus ( const Aws::String value)
inline

One of the VolumeStatus values that indicates the state of the storage volume.

Definition at line 376 of file VolumeInfo.h.

◆ WithVolumeAttachmentStatus() [3/3]

VolumeInfo& Aws::StorageGateway::Model::VolumeInfo::WithVolumeAttachmentStatus ( const char *  value)
inline

One of the VolumeStatus values that indicates the state of the storage volume.

Definition at line 388 of file VolumeInfo.h.

◆ WithVolumeId() [1/3]

VolumeInfo& Aws::StorageGateway::Model::VolumeInfo::WithVolumeId ( Aws::String &&  value)
inline

The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 167 of file VolumeInfo.h.

◆ WithVolumeId() [2/3]

VolumeInfo& Aws::StorageGateway::Model::VolumeInfo::WithVolumeId ( const Aws::String value)
inline

The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 159 of file VolumeInfo.h.

◆ WithVolumeId() [3/3]

VolumeInfo& Aws::StorageGateway::Model::VolumeInfo::WithVolumeId ( const char *  value)
inline

The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 175 of file VolumeInfo.h.

◆ WithVolumeSizeInBytes()

VolumeInfo& Aws::StorageGateway::Model::VolumeInfo::WithVolumeSizeInBytes ( long long  value)
inline

The size of the volume in bytes.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

Definition at line 339 of file VolumeInfo.h.

◆ WithVolumeType() [1/3]

VolumeInfo& Aws::StorageGateway::Model::VolumeInfo::WithVolumeType ( Aws::String &&  value)
inline

One of the VolumeType enumeration values describing the type of the volume.

Definition at line 308 of file VolumeInfo.h.

◆ WithVolumeType() [2/3]

VolumeInfo& Aws::StorageGateway::Model::VolumeInfo::WithVolumeType ( const Aws::String value)
inline

One of the VolumeType enumeration values describing the type of the volume.

Definition at line 302 of file VolumeInfo.h.

◆ WithVolumeType() [3/3]

VolumeInfo& Aws::StorageGateway::Model::VolumeInfo::WithVolumeType ( const char *  value)
inline

One of the VolumeType enumeration values describing the type of the volume.

Definition at line 314 of file VolumeInfo.h.


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