/// <summary> /// Initiates the asynchronous execution of the DescribeCacheClusters operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DescribeCacheClusters 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<DescribeCacheClustersResponse> DescribeCacheClustersAsync(DescribeCacheClustersRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)) { var marshaller = new DescribeCacheClustersRequestMarshaller(); var unmarshaller = DescribeCacheClustersResponseUnmarshaller.Instance; return InvokeAsync<DescribeCacheClustersRequest,DescribeCacheClustersResponse>(request, marshaller, unmarshaller, cancellationToken); }
/// <summary> /// Initiates the asynchronous execution of the DescribeCacheClusters operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DescribeCacheClusters operation on AmazonElastiCacheClient.</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 EndDescribeCacheClusters /// operation.</returns> public IAsyncResult BeginDescribeCacheClusters(DescribeCacheClustersRequest request, AsyncCallback callback, object state) { var marshaller = new DescribeCacheClustersRequestMarshaller(); var unmarshaller = DescribeCacheClustersResponseUnmarshaller.Instance; return BeginInvoke<DescribeCacheClustersRequest>(request, marshaller, unmarshaller, callback, state); }
/// <summary> /// The <i>DescribeCacheClusters</i> operation returns information about all provisioned /// cache clusters if no cache cluster identifier is specified, or about a specific cache /// cluster if a cache cluster identifier is supplied. /// /// /// <para> /// By default, abbreviated information about the cache clusters(s) will be returned. /// You can use the optional <i>ShowDetails</i> flag to retrieve detailed information /// about the cache nodes associated with the cache clusters. These details include the /// DNS address and port for the cache node endpoint. /// </para> /// /// <para> /// If the cluster is in the CREATING state, only cluster level information will be displayed /// until all of the nodes are successfully provisioned. /// </para> /// /// <para> /// If the cluster is in the DELETING state, only cluster level information will be displayed. /// </para> /// /// <para> /// If cache nodes are currently being added to the cache cluster, node endpoint information /// and creation time for the additional nodes will not be displayed until they are completely /// provisioned. When the cache cluster state is <i>available</i>, the cluster is ready /// for use. /// </para> /// /// <para> /// If cache nodes are currently being removed from the cache cluster, no endpoint information /// for the removed nodes is displayed. /// </para> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DescribeCacheClusters service method.</param> /// /// <returns>The response from the DescribeCacheClusters service method, as returned by ElastiCache.</returns> /// <exception cref="Amazon.ElastiCache.Model.CacheClusterNotFoundException"> /// The requested cache cluster ID does not refer to an existing cache cluster. /// </exception> /// <exception cref="Amazon.ElastiCache.Model.InvalidParameterCombinationException"> /// Two or more incompatible parameters were specified. /// </exception> /// <exception cref="Amazon.ElastiCache.Model.InvalidParameterValueException"> /// The value for a parameter is invalid. /// </exception> public DescribeCacheClustersResponse DescribeCacheClusters(DescribeCacheClustersRequest request) { var marshaller = new DescribeCacheClustersRequestMarshaller(); var unmarshaller = DescribeCacheClustersResponseUnmarshaller.Instance; return Invoke<DescribeCacheClustersRequest,DescribeCacheClustersResponse>(request, marshaller, unmarshaller); }
/// <summary> /// Initiates the asynchronous execution of the DescribeCacheClusters operation. /// <seealso cref="Amazon.ElastiCache.IAmazonElastiCache.DescribeCacheClusters"/> /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DescribeCacheClusters 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<DescribeCacheClustersResponse> DescribeCacheClustersAsync(DescribeCacheClustersRequest request, CancellationToken cancellationToken = default(CancellationToken)) { var marshaller = new DescribeCacheClustersRequestMarshaller(); var unmarshaller = DescribeCacheClustersResponseUnmarshaller.GetInstance(); return Invoke<IRequest, DescribeCacheClustersRequest, DescribeCacheClustersResponse>(request, marshaller, unmarshaller, signer, cancellationToken); }
/// <summary> /// Paginator for DescribeCacheClusters operation ///</summary> public IDescribeCacheClustersPaginator DescribeCacheClusters(DescribeCacheClustersRequest request) { return(new DescribeCacheClustersPaginator(this.client, request)); }
IAsyncResult invokeDescribeCacheClusters(DescribeCacheClustersRequest describeCacheClustersRequest, AsyncCallback callback, object state, bool synchronized) { IRequest irequest = new DescribeCacheClustersRequestMarshaller().Marshall(describeCacheClustersRequest); var unmarshaller = DescribeCacheClustersResponseUnmarshaller.GetInstance(); AsyncResult result = new AsyncResult(irequest, callback, state, synchronized, signer, unmarshaller); Invoke(result); return result; }
/// <summary> /// <para>The <i>DescribeCacheClusters</i> operation returns information about all provisioned cache clusters if no cache cluster identifier is /// specified, or about a specific cache cluster if a cache cluster identifier is supplied.</para> <para>By default, abbreviated information /// about the cache clusters(s) will be returned. You can use the optional <i>ShowDetails</i> flag to retrieve detailed information about the /// cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint.</para> <para>If /// the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully /// provisioned.</para> <para>If the cluster is in the DELETING state, only cluster level information will be displayed.</para> <para>If cache /// nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be /// displayed until they are completely provisioned. When the cache cluster state is <i>available</i> , the cluster is ready for use.</para> /// <para>If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.</para> /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the DescribeCacheClusters service method on /// AmazonElastiCache.</param> /// /// <returns>The response from the DescribeCacheClusters service method, as returned by AmazonElastiCache.</returns> /// /// <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException" /> /// <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException" /> /// <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException" /> public DescribeCacheClustersResponse DescribeCacheClusters(DescribeCacheClustersRequest request) { var task = DescribeCacheClustersAsync(request); try { return task.Result; } catch(AggregateException e) { ExceptionDispatchInfo.Capture(e.InnerException).Throw(); return null; } }
/// <summary> /// <para>The <i>DescribeCacheClusters</i> operation returns information about all provisioned cache clusters if no cache cluster identifier is /// specified, or about a specific cache cluster if a cache cluster identifier is supplied.</para> <para>By default, abbreviated information /// about the cache clusters(s) will be returned. You can use the optional <i>ShowDetails</i> flag to retrieve detailed information about the /// cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint.</para> <para>If /// the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully /// provisioned.</para> <para>If the cluster is in the DELETING state, only cluster level information will be displayed.</para> <para>If cache /// nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be /// displayed until they are completely provisioned. When the cache cluster state is <i>available</i> , the cluster is ready for use.</para> /// <para>If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.</para> /// </summary> /// /// <param name="describeCacheClustersRequest">Container for the necessary parameters to execute the DescribeCacheClusters service method on /// AmazonElastiCache.</param> /// /// <returns>The response from the DescribeCacheClusters service method, as returned by AmazonElastiCache.</returns> /// /// <exception cref="InvalidParameterValueException"/> /// <exception cref="CacheClusterNotFoundException"/> /// <exception cref="InvalidParameterCombinationException"/> public DescribeCacheClustersResponse DescribeCacheClusters(DescribeCacheClustersRequest describeCacheClustersRequest) { IAsyncResult asyncResult = invokeDescribeCacheClusters(describeCacheClustersRequest, null, null, true); return EndDescribeCacheClusters(asyncResult); }
/// <summary> /// Initiates the asynchronous execution of the DescribeCacheClusters operation. /// <seealso cref="Amazon.ElastiCache.IAmazonElastiCache.DescribeCacheClusters"/> /// </summary> /// /// <param name="describeCacheClustersRequest">Container for the necessary parameters to execute the DescribeCacheClusters operation on /// AmazonElastiCache.</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 /// EndDescribeCacheClusters operation.</returns> public IAsyncResult BeginDescribeCacheClusters(DescribeCacheClustersRequest describeCacheClustersRequest, AsyncCallback callback, object state) { return invokeDescribeCacheClusters(describeCacheClustersRequest, callback, state, false); }
/// <summary> /// <para>The <i>DescribeCacheClusters</i> operation returns information about all provisioned cache clusters if no cache cluster identifier is /// specified, or about a specific cache cluster if a cache cluster identifier is supplied.</para> <para>By default, abbreviated information /// about the cache clusters(s) will be returned. You can use the optional <i>ShowDetails</i> flag to retrieve detailed information about the /// cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint.</para> <para>If /// the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully /// provisioned.</para> <para>If the cluster is in the DELETING state, only cluster level information will be displayed.</para> <para>If cache /// nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be /// displayed until they are completely provisioned. When the cache cluster state is <i>available</i> , the cluster is ready for use.</para> /// <para>If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.</para> /// </summary> /// /// <param name="describeCacheClustersRequest">Container for the necessary parameters to execute the DescribeCacheClusters service method on /// AmazonElastiCache.</param> /// /// <returns>The response from the DescribeCacheClusters service method, as returned by AmazonElastiCache.</returns> /// /// <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException" /> /// <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException" /> /// <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException" /> /// <param name="cancellationToken"> /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// </param> public async Task<DescribeCacheClustersResponse> DescribeCacheClustersAsync(DescribeCacheClustersRequest describeCacheClustersRequest, CancellationToken cancellationToken = default(CancellationToken)) { var marshaller = new DescribeCacheClustersRequestMarshaller(); var unmarshaller = DescribeCacheClustersResponseUnmarshaller.GetInstance(); var response = await Invoke<IRequest, DescribeCacheClustersRequest, DescribeCacheClustersResponse>(describeCacheClustersRequest, marshaller, unmarshaller, signer, cancellationToken) .ConfigureAwait(continueOnCapturedContext: false); return response; }
internal DescribeCacheClustersPaginator(IAmazonElastiCache client, DescribeCacheClustersRequest request) { this._client = client; this._request = request; }
internal DescribeCacheClustersResponse DescribeCacheClusters(DescribeCacheClustersRequest request) { var task = DescribeCacheClustersAsync(request); try { return task.Result; } catch(AggregateException e) { throw e.InnerException; } }
private Amazon.ElastiCache.Model.DescribeCacheClustersResponse CallAWSServiceOperation(IAmazonElastiCache client, Amazon.ElastiCache.Model.DescribeCacheClustersRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon ElastiCache", "DescribeCacheClusters"); try { #if DESKTOP return(client.DescribeCacheClusters(request)); #elif CORECLR return(client.DescribeCacheClustersAsync(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("^") || this.PassThru.IsPresent; // create request and set iteration invariants var request = new Amazon.ElastiCache.Model.DescribeCacheClustersRequest(); if (cmdletContext.CacheClusterId != null) { request.CacheClusterId = cmdletContext.CacheClusterId; } if (cmdletContext.ShowCacheClustersNotInReplicationGroup != null) { request.ShowCacheClustersNotInReplicationGroups = cmdletContext.ShowCacheClustersNotInReplicationGroup.Value; } if (cmdletContext.ShowCacheNodeInfo != null) { request.ShowCacheNodeInfo = cmdletContext.ShowCacheNodeInfo.Value; } // 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 (AutoIterationHelpers.HasValue(cmdletContext.MaxRecord)) { _emitLimit = cmdletContext.MaxRecord; } var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.Marker)); var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); do { request.Marker = _nextToken; if (_emitLimit.HasValue) { request.MaxRecords = 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.CacheClusters.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); }
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.ElastiCache.Model.DescribeCacheClustersRequest(); if (cmdletContext.CacheClusterId != null) { request.CacheClusterId = cmdletContext.CacheClusterId; } if (cmdletContext.MaxRecord != null) { request.MaxRecords = AutoIterationHelpers.ConvertEmitLimitToServiceTypeInt32(cmdletContext.MaxRecord.Value); } if (cmdletContext.ShowCacheClustersNotInReplicationGroup != null) { request.ShowCacheClustersNotInReplicationGroups = cmdletContext.ShowCacheClustersNotInReplicationGroup.Value; } if (cmdletContext.ShowCacheNodeInfo != null) { request.ShowCacheNodeInfo = cmdletContext.ShowCacheNodeInfo.Value; } // 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 information about all provisioned Cache Clusters if no Cache Cluster identifier is specified, or about a specific Cache /// Cluster if a Cache Cluster identifier is supplied. </para> <para> Cluster information will be returned by default. An optional /// <i>ShowDetails</i> flag can be used to retrieve detailed information about the Cache Nodes associated with the Cache Cluster. Details /// include the DNS address and port for the Cache Node endpoint. </para> <para> If the cluster is in the CREATING state, only cluster level /// information will be displayed until all of the nodes are successfully provisioned. </para> <para> If the cluster is in the DELETING state, /// only cluster level information will be displayed. </para> <para> While adding Cache Nodes, node endpoint information and creation time for /// the additional nodes will not be displayed until they are completely provisioned. The cluster lifecycle tells the customer when new nodes /// are AVAILABLE. </para> <para> While removing existing Cache Nodes from an cluster, endpoint information for the removed nodes will not be /// displayed. </para> <para>DescribeCacheClusters supports pagination.</para> /// </summary> /// /// <param name="describeCacheClustersRequest">Container for the necessary parameters to execute the DescribeCacheClusters service method on /// AmazonElastiCache.</param> /// /// <returns>The response from the DescribeCacheClusters service method, as returned by AmazonElastiCache.</returns> /// /// <exception cref="InvalidParameterValueException"/> /// <exception cref="CacheClusterNotFoundException"/> /// <exception cref="InvalidParameterCombinationException"/> public DescribeCacheClustersResponse DescribeCacheClusters(DescribeCacheClustersRequest describeCacheClustersRequest) { IRequest<DescribeCacheClustersRequest> request = new DescribeCacheClustersRequestMarshaller().Marshall(describeCacheClustersRequest); DescribeCacheClustersResponse response = Invoke<DescribeCacheClustersRequest, DescribeCacheClustersResponse> (request, this.signer, DescribeCacheClustersResponseUnmarshaller.GetInstance()); return response; }