Vault (AWS Resource APIs for Java Parent POM 0.0.3 API)

```
public interface Vault
```
The Vault resource. Each Vault object is uniquely identified by these identifier(s):
- Name
- AccountId

Method Summary

Methods
Modifier and Type	Method and Description
`CreateVaultResult`	`create()` The convenient method form for the `Create` action.
`CreateVaultResult`	`create(CreateVaultRequest request)` Performs the `Create` action.
`CreateVaultResult`	`create(CreateVaultRequest request, ResultCapture<CreateVaultResult> extractor)` Performs the `Create` action and use a ResultCapture to retrieve the low-level client response.
`CreateVaultResult`	`create(ResultCapture<CreateVaultResult> extractor)` The convenient method form for the `Create` action.
`void`	`delete()` The convenient method form for the `Delete` action.
`void`	`delete(DeleteVaultRequest request)` Performs the `Delete` action.
`void`	`delete(DeleteVaultRequest request, ResultCapture<Void> extractor)` Performs the `Delete` action and use a ResultCapture to retrieve the low-level client response.
`void`	`delete(ResultCapture<Void> extractor)` The convenient method form for the `Delete` action.
`Account`	`getAccount()` Retrieves the `Account` resource referenced by this resource.
`String`	`getAccountId()` Gets the value of the AccountId identifier.
`Archive`	`getArchive(String id)` Gets a subresource.
`JobCollection`	`getCompletedJobs()` Retrieves the CompletedJobs collection referenced by this resource.
`JobCollection`	`getCompletedJobs(ListJobsRequest request)` Retrieves the CompletedJobs collection referenced by this resource.
`String`	`getCreationDate()` Gets the value of the CreationDate attribute.
`JobCollection`	`getFailedJobs()` Retrieves the FailedJobs collection referenced by this resource.
`JobCollection`	`getFailedJobs(ListJobsRequest request)` Retrieves the FailedJobs collection referenced by this resource.
`Job`	`getJob(String id)` Gets a subresource.
`JobCollection`	`getJobs()` Retrieves the Jobs collection referenced by this resource.
`JobCollection`	`getJobs(ListJobsRequest request)` Retrieves the Jobs collection referenced by this resource.
`JobCollection`	`getJobsInProgress()` Retrieves the JobsInProgress collection referenced by this resource.
`JobCollection`	`getJobsInProgress(ListJobsRequest request)` Retrieves the JobsInProgress collection referenced by this resource.
`String`	`getLastInventoryDate()` Gets the value of the LastInventoryDate attribute.
`MultipartUploadCollection`	`getMultipartUplaods()` Retrieves the MultipartUplaods collection referenced by this resource.
`MultipartUploadCollection`	`getMultipartUplaods(ListMultipartUploadsRequest request)` Retrieves the MultipartUplaods collection referenced by this resource.
`MultipartUpload`	`getMultipartUpload(String id)` Gets a subresource.
`String`	`getName()` Gets the value of the Name identifier.
`Notification`	`getNotification()` Gets a subresource.
`Long`	`getNumberOfArchives()` Gets the value of the NumberOfArchives attribute.
`Long`	`getSizeInBytes()` Gets the value of the SizeInBytes attribute.
`JobCollection`	`getSucceededJobs()` Retrieves the SucceededJobs collection referenced by this resource.
`JobCollection`	`getSucceededJobs(ListJobsRequest request)` Retrieves the SucceededJobs collection referenced by this resource.
`String`	`getVaultARN()` Gets the value of the VaultARN attribute.
`Job`	`initiateInventoryRetrieval()` The convenient method form for the `InitiateInventoryRetrieval` action.
`Job`	`initiateInventoryRetrieval(InitiateJobRequest request)` Performs the `InitiateInventoryRetrieval` action.
`Job`	`initiateInventoryRetrieval(InitiateJobRequest request, ResultCapture<InitiateJobResult> extractor)` Performs the `InitiateInventoryRetrieval` action and use a ResultCapture to retrieve the low-level client response.
`Job`	`initiateInventoryRetrieval(ResultCapture<InitiateJobResult> extractor)` The convenient method form for the `InitiateInventoryRetrieval` action.
`MultipartUpload`	`initiateMultipartUpload(InitiateMultipartUploadRequest request)` Performs the `InitiateMultipartUpload` action.
`MultipartUpload`	`initiateMultipartUpload(InitiateMultipartUploadRequest request, ResultCapture<InitiateMultipartUploadResult> extractor)` Performs the `InitiateMultipartUpload` action and use a ResultCapture to retrieve the low-level client response.
`MultipartUpload`	`initiateMultipartUpload(String partSize, String archiveDescription)` The convenient method form for the `InitiateMultipartUpload` action.
`MultipartUpload`	`initiateMultipartUpload(String partSize, String archiveDescription, ResultCapture<InitiateMultipartUploadResult> extractor)` The convenient method form for the `InitiateMultipartUpload` action.
`boolean`	`isLoaded()` Returns true if this resource's attributes have been loaded.
`boolean`	`load()` Makes a call to the service to load this resource's attributes if they are not loaded yet.
`boolean`	`load(DescribeVaultRequest request)` Makes a call to the service to load this resource's attributes if they are not loaded yet.
`boolean`	`load(DescribeVaultRequest request, ResultCapture<DescribeVaultResult> extractor)` Makes a call to the service to load this resource's attributes if they are not loaded yet, and use a ResultCapture to retrieve the low-level client response The following request parameters will be populated from the data of this `Vault` resource, and any conflicting parameter value set in the request will be overridden: `VaultName` - mapped from the `Name` identifier.
`Archive`	`uploadArchive(String checksum, InputStream body, String archiveDescription)` The convenient method form for the `UploadArchive` action.
`Archive`	`uploadArchive(String checksum, InputStream body, String archiveDescription, ResultCapture<UploadArchiveResult> extractor)` The convenient method form for the `UploadArchive` action.
`Archive`	`uploadArchive(UploadArchiveRequest request)` Performs the `UploadArchive` action.
`Archive`	`uploadArchive(UploadArchiveRequest request, ResultCapture<UploadArchiveResult> extractor)` Performs the `UploadArchive` action and use a ResultCapture to retrieve the low-level client response.

- Method Detail
  - isLoaded
```
boolean isLoaded()
```
    Returns true if this resource's attributes have been loaded. If this method returns false, calls to attribute getter methods on this instance will make an implicit call to load() to retrieve the value.
  - load
```
boolean load()
```
    Makes a call to the service to load this resource's attributes if they are not loaded yet.
    
    Returns:
    Returns true if the resource is not yet loaded when this method was invoked, which indicates that a service call has been made to retrieve the attributes.
    See Also:
    load(DescribeVaultRequest)
  - load
```
boolean load(DescribeVaultRequest request)
```
    Makes a call to the service to load this resource's attributes if they are not loaded yet. The following request parameters will be populated from the data of this Vault resource, and any conflicting parameter value set in the request will be overridden:
    - VaultName - mapped from the Name identifier.
    - AccountId - mapped from the AccountId identifier.
    Returns:
    Returns true if the resource is not yet loaded when this method was invoked, which indicates that a service call has been made to retrieve the attributes.
    See Also:
    DescribeVaultRequest
  - load
```
boolean load(DescribeVaultRequest request,
           ResultCapture<DescribeVaultResult> extractor)
```
    Makes a call to the service to load this resource's attributes if they are not loaded yet, and use a ResultCapture to retrieve the low-level client response The following request parameters will be populated from the data of this Vault resource, and any conflicting parameter value set in the request will be overridden:
    - VaultName - mapped from the Name identifier.
    - AccountId - mapped from the AccountId identifier.
    Returns:
    Returns true if the resource is not yet loaded when this method was invoked, which indicates that a service call has been made to retrieve the attributes.
    See Also:
    DescribeVaultRequest
  - getName
```
String getName()
```
    Gets the value of the Name identifier. This method always directly returns the identifier and never involves a service call.
  - getAccountId
```
String getAccountId()
```
    Gets the value of the AccountId identifier. This method always directly returns the identifier and never involves a service call.
  - getLastInventoryDate
```
String getLastInventoryDate()
```
    Gets the value of the LastInventoryDate attribute. If this resource is not yet loaded, a call to load() is made to retrieve the value of the attribute.
  - getNumberOfArchives
```
Long getNumberOfArchives()
```
    Gets the value of the NumberOfArchives attribute. If this resource is not yet loaded, a call to load() is made to retrieve the value of the attribute.
  - getVaultARN
```
String getVaultARN()
```
    Gets the value of the VaultARN attribute. If this resource is not yet loaded, a call to load() is made to retrieve the value of the attribute.
  - getCreationDate
```
String getCreationDate()
```
    Gets the value of the CreationDate attribute. If this resource is not yet loaded, a call to load() is made to retrieve the value of the attribute.
  - getSizeInBytes
```
Long getSizeInBytes()
```
    Gets the value of the SizeInBytes attribute. If this resource is not yet loaded, a call to load() is made to retrieve the value of the attribute.
  - getAccount
```
Account getAccount()
```
    Retrieves the Account resource referenced by this resource.
  - getJob
```
Job getJob(String id)
```
    Gets a subresource.
  - getArchive
```
Archive getArchive(String id)
```
    Gets a subresource.
  - getMultipartUpload
```
MultipartUpload getMultipartUpload(String id)
```
    Gets a subresource.
  - getNotification
```
Notification getNotification()
```
    Gets a subresource.
  - getJobsInProgress
```
JobCollection getJobsInProgress()
```
    Retrieves the JobsInProgress collection referenced by this resource.
  - getJobsInProgress
```
JobCollection getJobsInProgress(ListJobsRequest request)
```
    Retrieves the JobsInProgress collection referenced by this resource.
  - getJobs
```
JobCollection getJobs()
```
    Retrieves the Jobs collection referenced by this resource.
  - getJobs
```
JobCollection getJobs(ListJobsRequest request)
```
    Retrieves the Jobs collection referenced by this resource.
  - getSucceededJobs
```
JobCollection getSucceededJobs()
```
    Retrieves the SucceededJobs collection referenced by this resource.
  - getSucceededJobs
```
JobCollection getSucceededJobs(ListJobsRequest request)
```
    Retrieves the SucceededJobs collection referenced by this resource.
  - getCompletedJobs
```
JobCollection getCompletedJobs()
```
    Retrieves the CompletedJobs collection referenced by this resource.
  - getCompletedJobs
```
JobCollection getCompletedJobs(ListJobsRequest request)
```
    Retrieves the CompletedJobs collection referenced by this resource.
  - getFailedJobs
```
JobCollection getFailedJobs()
```
    Retrieves the FailedJobs collection referenced by this resource.
  - getFailedJobs
```
JobCollection getFailedJobs(ListJobsRequest request)
```
    Retrieves the FailedJobs collection referenced by this resource.
  - getMultipartUplaods
```
MultipartUploadCollection getMultipartUplaods()
```
    Retrieves the MultipartUplaods collection referenced by this resource.
  - getMultipartUplaods
```
MultipartUploadCollection getMultipartUplaods(ListMultipartUploadsRequest request)
```
    Retrieves the MultipartUplaods collection referenced by this resource.
  - initiateInventoryRetrieval
```
Job initiateInventoryRetrieval(InitiateJobRequest request)
```
    Performs the InitiateInventoryRetrieval action.
    The following request parameters will be populated from the data of this Vault resource, and any conflicting parameter value set in the request will be overridden:
    - VaultName - mapped from the Name identifier.
    - AccountId - mapped from the AccountId identifier.
    - JobParameters.Type - constant value inventory-retrieval.
    Returns:
    The Job resource object associated with the result of this action.
    See Also:
    InitiateJobRequest
  - initiateInventoryRetrieval
```
Job initiateInventoryRetrieval(InitiateJobRequest request,
                             ResultCapture<InitiateJobResult> extractor)
```
    Performs the InitiateInventoryRetrieval action and use a ResultCapture to retrieve the low-level client response.
    The following request parameters will be populated from the data of this Vault resource, and any conflicting parameter value set in the request will be overridden:
    - VaultName - mapped from the Name identifier.
    - AccountId - mapped from the AccountId identifier.
    - JobParameters.Type - constant value inventory-retrieval.
    Returns:
    The Job resource object associated with the result of this action.
    See Also:
    InitiateJobRequest
  - initiateInventoryRetrieval
```
Job initiateInventoryRetrieval()
```
    The convenient method form for the InitiateInventoryRetrieval action.
    
    See Also:
    initiateInventoryRetrieval(InitiateJobRequest)
  - initiateInventoryRetrieval
```
Job initiateInventoryRetrieval(ResultCapture<InitiateJobResult> extractor)
```
    The convenient method form for the InitiateInventoryRetrieval action.
    
    See Also:
    initiateInventoryRetrieval(InitiateJobRequest, ResultCapture)
  - uploadArchive
```
Archive uploadArchive(UploadArchiveRequest request)
```
    Performs the UploadArchive action.
    The following request parameters will be populated from the data of this Vault resource, and any conflicting parameter value set in the request will be overridden:
    - VaultName - mapped from the Name identifier.
    - AccountId - mapped from the AccountId identifier.
    Returns:
    The Archive resource object associated with the result of this action.
    See Also:
    UploadArchiveRequest
  - uploadArchive
```
Archive uploadArchive(UploadArchiveRequest request,
                    ResultCapture<UploadArchiveResult> extractor)
```
    Performs the UploadArchive action and use a ResultCapture to retrieve the low-level client response.
    The following request parameters will be populated from the data of this Vault resource, and any conflicting parameter value set in the request will be overridden:
    - VaultName - mapped from the Name identifier.
    - AccountId - mapped from the AccountId identifier.
    Returns:
    The Archive resource object associated with the result of this action.
    See Also:
    UploadArchiveRequest
  - uploadArchive
```
Archive uploadArchive(String checksum,
                    InputStream body,
                    String archiveDescription)
```
    The convenient method form for the UploadArchive action.
    
    See Also:
    uploadArchive(UploadArchiveRequest)
  - uploadArchive
```
Archive uploadArchive(String checksum,
                    InputStream body,
                    String archiveDescription,
                    ResultCapture<UploadArchiveResult> extractor)
```
    The convenient method form for the UploadArchive action.
    
    See Also:
    uploadArchive(UploadArchiveRequest, ResultCapture)
  - create
```
CreateVaultResult create(CreateVaultRequest request)
```
    Performs the Create action.
    The following request parameters will be populated from the data of this Vault resource, and any conflicting parameter value set in the request will be overridden:
    - VaultName - mapped from the Name identifier.
    - AccountId - mapped from the AccountId identifier.
    Returns:
    The response of the low-level client operation associated with this resource action.
    See Also:
    CreateVaultRequest
  - create
```
CreateVaultResult create(CreateVaultRequest request,
                       ResultCapture<CreateVaultResult> extractor)
```
    Performs the Create action and use a ResultCapture to retrieve the low-level client response.
    The following request parameters will be populated from the data of this Vault resource, and any conflicting parameter value set in the request will be overridden:
    - VaultName - mapped from the Name identifier.
    - AccountId - mapped from the AccountId identifier.
    Returns:
    The response of the low-level client operation associated with this resource action.
    See Also:
    CreateVaultRequest
  - create
```
CreateVaultResult create()
```
    The convenient method form for the Create action.
    
    See Also:
    create(CreateVaultRequest)
  - create
```
CreateVaultResult create(ResultCapture<CreateVaultResult> extractor)
```
    The convenient method form for the Create action.
    
    See Also:
    create(CreateVaultRequest, ResultCapture)
  - initiateMultipartUpload
```
MultipartUpload initiateMultipartUpload(InitiateMultipartUploadRequest request)
```
    Performs the InitiateMultipartUpload action.
    The following request parameters will be populated from the data of this Vault resource, and any conflicting parameter value set in the request will be overridden:
    - VaultName - mapped from the Name identifier.
    - AccountId - mapped from the AccountId identifier.
    Returns:
    The MultipartUpload resource object associated with the result of this action.
    See Also:
    InitiateMultipartUploadRequest
  - initiateMultipartUpload
```
MultipartUpload initiateMultipartUpload(InitiateMultipartUploadRequest request,
                                      ResultCapture<InitiateMultipartUploadResult> extractor)
```
    Performs the InitiateMultipartUpload action and use a ResultCapture to retrieve the low-level client response.
    The following request parameters will be populated from the data of this Vault resource, and any conflicting parameter value set in the request will be overridden:
    - VaultName - mapped from the Name identifier.
    - AccountId - mapped from the AccountId identifier.
    Returns:
    The MultipartUpload resource object associated with the result of this action.
    See Also:
    InitiateMultipartUploadRequest
  - initiateMultipartUpload
```
MultipartUpload initiateMultipartUpload(String partSize,
                                      String archiveDescription)
```
    The convenient method form for the InitiateMultipartUpload action.
    
    See Also:
    initiateMultipartUpload(InitiateMultipartUploadRequest)
  - initiateMultipartUpload
```
MultipartUpload initiateMultipartUpload(String partSize,
                                      String archiveDescription,
                                      ResultCapture<InitiateMultipartUploadResult> extractor)
```
    The convenient method form for the InitiateMultipartUpload action.
    
    See Also:
    initiateMultipartUpload(InitiateMultipartUploadRequest, ResultCapture)
  - delete
```
void delete(DeleteVaultRequest request)
```
    Performs the Delete action.
    The following request parameters will be populated from the data of this Vault resource, and any conflicting parameter value set in the request will be overridden:
    - VaultName - mapped from the Name identifier.
    - AccountId - mapped from the AccountId identifier.
    See Also:
    DeleteVaultRequest
  - delete
```
void delete(DeleteVaultRequest request,
          ResultCapture<Void> extractor)
```
    Performs the Delete action and use a ResultCapture to retrieve the low-level client response.
    The following request parameters will be populated from the data of this Vault resource, and any conflicting parameter value set in the request will be overridden:
    - VaultName - mapped from the Name identifier.
    - AccountId - mapped from the AccountId identifier.
    See Also:
    DeleteVaultRequest
  - delete
```
void delete()
```
    The convenient method form for the Delete action.
    
    See Also:
    delete(DeleteVaultRequest)
  - delete
```
void delete(ResultCapture<Void> extractor)
```
    The convenient method form for the Delete action.
    
    See Also:
    delete(DeleteVaultRequest, ResultCapture)

Interface Vault

Method Summary

Method Detail

isLoaded

load

load

load

getName

getAccountId

getLastInventoryDate

getNumberOfArchives

getVaultARN

getCreationDate

getSizeInBytes

getAccount

getJob

getArchive

getMultipartUpload

getNotification

getJobsInProgress

getJobsInProgress

getJobs

getJobs

getSucceededJobs

getSucceededJobs

getCompletedJobs

getCompletedJobs

getFailedJobs

getFailedJobs

getMultipartUplaods

getMultipartUplaods

initiateInventoryRetrieval

initiateInventoryRetrieval

initiateInventoryRetrieval

initiateInventoryRetrieval

uploadArchive

uploadArchive

uploadArchive

uploadArchive

create

create

create

create

initiateMultipartUpload

initiateMultipartUpload

initiateMultipartUpload

initiateMultipartUpload

delete

delete

delete

delete