/// <summary>
/// Returns a description of specified virtual tapes in the virtual tape shelf (VTS).
///
///
/// <para>
/// If a specific <code>TapeARN</code> is not specified, AWS Storage Gateway returns a
/// description of all virtual tapes found in the VTS associated with your account.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DescribeTapeArchives service method.</param>
///
/// <returns>The response from the DescribeTapeArchives 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 DescribeTapeArchivesResponse DescribeTapeArchives(DescribeTapeArchivesRequest request)
{
var marshaller = new DescribeTapeArchivesRequestMarshaller();
var unmarshaller = DescribeTapeArchivesResponseUnmarshaller.Instance;
return Invoke<DescribeTapeArchivesRequest,DescribeTapeArchivesResponse>(request, marshaller, unmarshaller);
}
/// <summary>
/// Initiates the asynchronous execution of the DescribeTapeArchives operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the DescribeTapeArchives 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 EndDescribeTapeArchives
/// operation.</returns>
public IAsyncResult BeginDescribeTapeArchives(DescribeTapeArchivesRequest request, AsyncCallback callback, object state)
{
var marshaller = new DescribeTapeArchivesRequestMarshaller();
var unmarshaller = DescribeTapeArchivesResponseUnmarshaller.Instance;
return BeginInvoke<DescribeTapeArchivesRequest>(request, marshaller, unmarshaller,
callback, state);
}
/// <summary>
/// <para>Returns a description of specified virtual tapes in the virtual tape shelf (VTS). </para> <para>If a specific <c>TapeARN</c> is not
/// specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.</para>
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the DescribeTapeArchives service method on
/// AmazonStorageGateway.</param>
///
/// <returns>The response from the DescribeTapeArchives service method, as returned by AmazonStorageGateway.</returns>
///
/// <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException" />
/// <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException" />
public DescribeTapeArchivesResponse DescribeTapeArchives(DescribeTapeArchivesRequest request)
{
var task = DescribeTapeArchivesAsync(request);
try
{
return task.Result;
}
catch(AggregateException e)
{
ExceptionDispatchInfo.Capture(e.InnerException).Throw();
return null;
}
}
/// <summary>
/// Initiates the asynchronous execution of the DescribeTapeArchives operation.
/// <seealso cref="Amazon.StorageGateway.IAmazonStorageGateway.DescribeTapeArchives"/>
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the DescribeTapeArchives 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<DescribeTapeArchivesResponse> DescribeTapeArchivesAsync(DescribeTapeArchivesRequest request, CancellationToken cancellationToken = default(CancellationToken))
{
var marshaller = new DescribeTapeArchivesRequestMarshaller();
var unmarshaller = DescribeTapeArchivesResponseUnmarshaller.GetInstance();
return Invoke<IRequest, DescribeTapeArchivesRequest, DescribeTapeArchivesResponse>(request, marshaller, unmarshaller, signer, cancellationToken);
}
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent;
// create request and set iteration invariants
var request = new Amazon.StorageGateway.Model.DescribeTapeArchivesRequest();
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.TapeArchives.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);
}
private Amazon.StorageGateway.Model.DescribeTapeArchivesResponse CallAWSServiceOperation(IAmazonStorageGateway client, Amazon.StorageGateway.Model.DescribeTapeArchivesRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Storage Gateway", "DescribeTapeArchives");
try
{
#if DESKTOP
return(client.DescribeTapeArchives(request));
#elif CORECLR
return(client.DescribeTapeArchivesAsync(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;
}
}
IAsyncResult invokeDescribeTapeArchives(DescribeTapeArchivesRequest describeTapeArchivesRequest, AsyncCallback callback, object state, bool synchronized)
{
IRequest irequest = new DescribeTapeArchivesRequestMarshaller().Marshall(describeTapeArchivesRequest);
var unmarshaller = DescribeTapeArchivesResponseUnmarshaller.GetInstance();
AsyncResult result = new AsyncResult(irequest, callback, state, synchronized, signer, unmarshaller);
Invoke(result);
return result;
}
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent;
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
// create request and set iteration invariants
var request = new Amazon.StorageGateway.Model.DescribeTapeArchivesRequest();
if (cmdletContext.Limit != null)
{
request.Limit = AutoIterationHelpers.ConvertEmitLimitToServiceTypeInt32(cmdletContext.Limit.Value);
}
if (cmdletContext.TapeARNs != null)
{
request.TapeARNs = cmdletContext.TapeARNs;
}
// Initialize loop variant and commence piping
var _nextToken = cmdletContext.Marker;
var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.Marker));
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
do
{
request.Marker = _nextToken;
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
};
_nextToken = response.Marker;
}
catch (Exception e)
{
output = new CmdletOutput {
ErrorResponse = e
};
}
ProcessOutput(output);
} while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken));
if (useParameterSelect)
{
WriteObject(cmdletContext.Select(null, this));
}
return(null);
}
/// <summary>
/// <para>Returns a description of specified virtual tapes in the virtual tape shelf (VTS). </para> <para>If a specific <c>TapeARN</c> is not
/// specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.</para>
/// </summary>
///
/// <param name="describeTapeArchivesRequest">Container for the necessary parameters to execute the DescribeTapeArchives service method on
/// AmazonStorageGateway.</param>
///
/// <returns>The response from the DescribeTapeArchives service method, as returned by AmazonStorageGateway.</returns>
///
/// <exception cref="InternalServerErrorException"/>
/// <exception cref="InvalidGatewayRequestException"/>
public DescribeTapeArchivesResponse DescribeTapeArchives(DescribeTapeArchivesRequest describeTapeArchivesRequest)
{
IAsyncResult asyncResult = invokeDescribeTapeArchives(describeTapeArchivesRequest, null, null, true);
return EndDescribeTapeArchives(asyncResult);
}
/// <summary>
/// Initiates the asynchronous execution of the DescribeTapeArchives operation.
/// <seealso cref="Amazon.StorageGateway.IAmazonStorageGateway.DescribeTapeArchives"/>
/// </summary>
///
/// <param name="describeTapeArchivesRequest">Container for the necessary parameters to execute the DescribeTapeArchives operation on
/// AmazonStorageGateway.</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
/// EndDescribeTapeArchives operation.</returns>
public IAsyncResult BeginDescribeTapeArchives(DescribeTapeArchivesRequest describeTapeArchivesRequest, AsyncCallback callback, object state)
{
return invokeDescribeTapeArchives(describeTapeArchivesRequest, callback, state, false);
}
/// <summary>
/// Initiates the asynchronous execution of the DescribeTapeArchives operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the DescribeTapeArchives 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<DescribeTapeArchivesResponse> DescribeTapeArchivesAsync(DescribeTapeArchivesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var marshaller = new DescribeTapeArchivesRequestMarshaller();
var unmarshaller = DescribeTapeArchivesResponseUnmarshaller.Instance;
return InvokeAsync<DescribeTapeArchivesRequest,DescribeTapeArchivesResponse>(request, marshaller,
unmarshaller, cancellationToken);
}
/// <summary>
/// Paginator for DescribeTapeArchives operation
///</summary>
public IDescribeTapeArchivesPaginator DescribeTapeArchives(DescribeTapeArchivesRequest request)
{
return(new DescribeTapeArchivesPaginator(this.client, request));
}
internal DescribeTapeArchivesPaginator(IAmazonStorageGateway client, DescribeTapeArchivesRequest request)
{
this._client = client;
this._request = request;
}
/// <summary>
/// <para>Returns a description of specified virtual tapes in the virtual tape shelf (VTS). </para> <para>If a specific <c>TapeARN</c> is not
/// specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.</para>
/// </summary>
///
/// <param name="describeTapeArchivesRequest">Container for the necessary parameters to execute the DescribeTapeArchives service method on
/// AmazonStorageGateway.</param>
///
/// <returns>The response from the DescribeTapeArchives service method, as returned by AmazonStorageGateway.</returns>
///
/// <exception cref="T:Amazon.StorageGateway.Model.InternalServerErrorException" />
/// <exception cref="T:Amazon.StorageGateway.Model.InvalidGatewayRequestException" />
/// <param name="cancellationToken">
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
/// </param>
public async Task<DescribeTapeArchivesResponse> DescribeTapeArchivesAsync(DescribeTapeArchivesRequest describeTapeArchivesRequest, CancellationToken cancellationToken = default(CancellationToken))
{
var marshaller = new DescribeTapeArchivesRequestMarshaller();
var unmarshaller = DescribeTapeArchivesResponseUnmarshaller.GetInstance();
var response = await Invoke<IRequest, DescribeTapeArchivesRequest, DescribeTapeArchivesResponse>(describeTapeArchivesRequest, marshaller, unmarshaller, signer, cancellationToken)
.ConfigureAwait(continueOnCapturedContext: false);
return response;
}
internal DescribeTapeArchivesResponse DescribeTapeArchives(DescribeTapeArchivesRequest request)
{
var task = DescribeTapeArchivesAsync(request);
try
{
return task.Result;
}
catch(AggregateException e)
{
throw e.InnerException;
}
}
