/*******************************************************************************
* Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use
* this file except in compliance with the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file.
* This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
* *****************************************************************************
*
* AWS Tools for Windows (TM) PowerShell (TM)
*
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation;
using System.Text;
using Amazon.PowerShell.Common;
using Amazon.Runtime;
using Amazon.CodeGuruProfiler;
using Amazon.CodeGuruProfiler.Model;
namespace Amazon.PowerShell.Cmdlets.CGP
{
///
/// Returns the time series of values for a requested list of frame metrics from a time
/// period.
///
[Cmdlet("Get", "CGPGetFrameMetricData")]
[OutputType("Amazon.CodeGuruProfiler.Model.BatchGetFrameMetricDataResponse")]
[AWSCmdlet("Calls the Amazon CodeGuru Profiler BatchGetFrameMetricData API operation.", Operation = new[] {"BatchGetFrameMetricData"}, SelectReturnType = typeof(Amazon.CodeGuruProfiler.Model.BatchGetFrameMetricDataResponse))]
[AWSCmdletOutput("Amazon.CodeGuruProfiler.Model.BatchGetFrameMetricDataResponse",
"This cmdlet returns an Amazon.CodeGuruProfiler.Model.BatchGetFrameMetricDataResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetCGPGetFrameMetricDataCmdlet : AmazonCodeGuruProfilerClientCmdlet, IExecutor
{
#region Parameter EndTime
///
///
/// The end time of the time period for the returned time series values. This is specified
/// using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond
/// past June 1, 2020 1:15:02 PM UTC.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.DateTime? EndTime { get; set; }
#endregion
#region Parameter FrameMetric
///
///
/// The details of the metrics that are used to request a time series of values. The
/// metric includes the name of the frame, the aggregation type to calculate the metric
/// value for the frame, and the thread states to use to get the count for the metric
/// value of the frame.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("FrameMetrics")]
public Amazon.CodeGuruProfiler.Model.FrameMetric[] FrameMetric { get; set; }
#endregion
#region Parameter Period
///
///
/// The duration of the frame metrics used to return the time series values. Specify
/// using the ISO 8601 format. The maximum period duration is one day (PT24H
/// or P1D
).
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Period { get; set; }
#endregion
#region Parameter ProfilingGroupName
///
///
/// The name of the profiling group associated with the the frame metrics used to return
/// the time series values.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
#else
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String ProfilingGroupName { get; set; }
#endregion
#region Parameter StartTime
///
///
/// The start time of the time period for the frame metrics used to return the time series
/// values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z
/// represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.DateTime? StartTime { get; set; }
#endregion
#region Parameter TargetResolution
///
///
/// The requested resolution of time steps for the returned time series of values. If
/// the requested target resolution is not available due to data not being retained we
/// provide a best effort result by falling back to the most granular available resolution
/// after the target resolution. There are 3 valid values. P1D
— 1 day PT1H
— 1 hour PT5M
— 5 minutes
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.CodeGuruProfiler.AggregationPeriod")]
public Amazon.CodeGuruProfiler.AggregationPeriod TargetResolution { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is '*'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruProfiler.Model.BatchGetFrameMetricDataResponse).
/// Specifying the name of a property of type Amazon.CodeGuruProfiler.Model.BatchGetFrameMetricDataResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "*";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the ProfilingGroupName parameter.
/// The -PassThru parameter is deprecated, use -Select '^ProfilingGroupName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ProfilingGroupName' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
if (this.PassThru.IsPresent)
{
throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select));
}
}
else if (this.PassThru.IsPresent)
{
context.Select = (response, cmdlet) => this.ProfilingGroupName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.EndTime = this.EndTime;
if (this.FrameMetric != null)
{
context.FrameMetric = new List(this.FrameMetric);
}
context.Period = this.Period;
context.ProfilingGroupName = this.ProfilingGroupName;
#if MODULAR
if (this.ProfilingGroupName == null && ParameterWasBound(nameof(this.ProfilingGroupName)))
{
WriteWarning("You are passing $null as a value for parameter ProfilingGroupName which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.StartTime = this.StartTime;
context.TargetResolution = this.TargetResolution;
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.CodeGuruProfiler.Model.BatchGetFrameMetricDataRequest();
if (cmdletContext.EndTime != null)
{
request.EndTime = cmdletContext.EndTime.Value;
}
if (cmdletContext.FrameMetric != null)
{
request.FrameMetrics = cmdletContext.FrameMetric;
}
if (cmdletContext.Period != null)
{
request.Period = cmdletContext.Period;
}
if (cmdletContext.ProfilingGroupName != null)
{
request.ProfilingGroupName = cmdletContext.ProfilingGroupName;
}
if (cmdletContext.StartTime != null)
{
request.StartTime = cmdletContext.StartTime.Value;
}
if (cmdletContext.TargetResolution != null)
{
request.TargetResolution = cmdletContext.TargetResolution;
}
CmdletOutput output;
// issue call
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
pipelineOutput = cmdletContext.Select(response, this);
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
}
catch (Exception e)
{
output = new CmdletOutput { ErrorResponse = e };
}
return output;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.CodeGuruProfiler.Model.BatchGetFrameMetricDataResponse CallAWSServiceOperation(IAmazonCodeGuruProfiler client, Amazon.CodeGuruProfiler.Model.BatchGetFrameMetricDataRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon CodeGuru Profiler", "BatchGetFrameMetricData");
try
{
#if DESKTOP
return client.BatchGetFrameMetricData(request);
#elif CORECLR
return client.BatchGetFrameMetricDataAsync(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;
}
}
#endregion
internal partial class CmdletContext : ExecutorContext
{
public System.DateTime? EndTime { get; set; }
public List FrameMetric { get; set; }
public System.String Period { get; set; }
public System.String ProfilingGroupName { get; set; }
public System.DateTime? StartTime { get; set; }
public Amazon.CodeGuruProfiler.AggregationPeriod TargetResolution { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}