/// <summary>
/// Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf
/// (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource
/// Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes
/// in both your VTL and VTS.
///
///
/// <para>
/// This operation supports pagination. By default, the operation returns a maximum of
/// up to 100 tapes. You can optionally specify the <code>Limit</code> parameter in the
/// body to limit the number of tapes in the response. If the number of tapes returned
/// in the response is truncated, the response includes a <code>Marker</code> element
/// that you can use in your subsequent request to retrieve the next set of tapes.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the ListTapes service method.</param>
///
/// <returns>The response from the ListTapes service method, as returned by StorageGateway.</returns>
/// <exception cref="Amazon.StorageGateway.Model.InternalServerErrorException">
/// An internal server error has occurred during the request. For more information, see
/// the error and message fields.
/// </exception>
/// <exception cref="Amazon.StorageGateway.Model.InvalidGatewayRequestException">
/// An exception occurred because an invalid gateway request was issued to the service.
/// For more information, see the error and message fields.
/// </exception>
public ListTapesResponse ListTapes(ListTapesRequest request)
{
var marshaller = new ListTapesRequestMarshaller();
var unmarshaller = ListTapesResponseUnmarshaller.Instance;
return Invoke<ListTapesRequest,ListTapesResponse>(request, marshaller, unmarshaller);
}
/// <summary>
/// Initiates the asynchronous execution of the ListTapes operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the ListTapes operation on AmazonStorageGatewayClient.</param>
/// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param>
/// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.</param>
///
/// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTapes
/// operation.</returns>
public IAsyncResult BeginListTapes(ListTapesRequest request, AsyncCallback callback, object state)
{
var marshaller = new ListTapesRequestMarshaller();
var unmarshaller = ListTapesResponseUnmarshaller.Instance;
return BeginInvoke<ListTapesRequest>(request, marshaller, unmarshaller,
callback, state);
}
/// <summary>
/// Paginator for ListTapes operation
///</summary>
public IListTapesPaginator ListTapes(ListTapesRequest request)
{
return(new ListTapesPaginator(this.client, request));
}
private Amazon.StorageGateway.Model.ListTapesResponse CallAWSServiceOperation(IAmazonStorageGateway client, Amazon.StorageGateway.Model.ListTapesRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Storage Gateway", "ListTapes");
try
{
#if DESKTOP
return(client.ListTapes(request));
#elif CORECLR
return(client.ListTapesAsync(request).GetAwaiter().GetResult());
#else
#error "Unknown build edition"
#endif
}
catch (AmazonServiceException exc)
{
var webException = exc.InnerException as System.Net.WebException;
if (webException != null)
{
throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
}
throw;
}
}
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
var useParameterSelect = this.Select.StartsWith("^");
// create request and set iteration invariants
var request = new Amazon.StorageGateway.Model.ListTapesRequest();
if (cmdletContext.TapeARNs != null)
{
request.TapeARNs = cmdletContext.TapeARNs;
}
// Initialize loop variants and commence piping
System.String _nextToken = null;
int? _emitLimit = null;
int _retrievedSoFar = 0;
if (AutoIterationHelpers.HasValue(cmdletContext.Marker))
{
_nextToken = cmdletContext.Marker;
}
if (cmdletContext.Limit.HasValue)
{
_emitLimit = cmdletContext.Limit;
}
var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.Marker));
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
do
{
request.Marker = _nextToken;
if (_emitLimit.HasValue)
{
request.Limit = AutoIterationHelpers.ConvertEmitLimitToInt32(_emitLimit.Value);
}
CmdletOutput output;
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
if (!useParameterSelect)
{
pipelineOutput = cmdletContext.Select(response, this);
}
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
int _receivedThisCall = response.TapeInfos.Count;
_nextToken = response.Marker;
_retrievedSoFar += _receivedThisCall;
if (_emitLimit.HasValue)
{
_emitLimit -= _receivedThisCall;
}
}
catch (Exception e)
{
if (_retrievedSoFar == 0 || !_emitLimit.HasValue)
{
output = new CmdletOutput {
ErrorResponse = e
};
}
else
{
break;
}
}
ProcessOutput(output);
} while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken) && (!_emitLimit.HasValue || _emitLimit.Value >= 1));
if (useParameterSelect)
{
WriteObject(cmdletContext.Select(null, this));
}
return(null);
}
internal ListTapesPaginator(IAmazonStorageGateway client, ListTapesRequest request)
{
this._client = client;
this._request = request;
}
/// <summary>
/// Initiates the asynchronous execution of the ListTapes operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the ListTapes operation.</param>
/// <param name="cancellationToken">
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
/// </param>
/// <returns>The task object representing the asynchronous operation.</returns>
public Task<ListTapesResponse> ListTapesAsync(ListTapesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var marshaller = new ListTapesRequestMarshaller();
var unmarshaller = ListTapesResponseUnmarshaller.Instance;
return InvokeAsync<ListTapesRequest,ListTapesResponse>(request, marshaller,
unmarshaller, cancellationToken);
}