Class: Aws::CodeGuruProfiler::Types::GetProfileRequest

Inherits:

Struct

• Object
• Struct
• Aws::CodeGuruProfiler::Types::GetProfileRequest

Includes:

Structure

Defined in:

lib/aws-sdk-codeguruprofiler/types.rb

Overview

The structure representing the getProfileRequest.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #accept ⇒ String

  The format of the returned profiling data.

• #end_time ⇒ Time

  The end time of the requested profile.

• #max_depth ⇒ Integer

  The maximum depth of the stacks in the code that is represented in the aggregated profile.

• #period ⇒ String

  Used with ‘startTime` or `endTime` to specify the time range for the returned aggregated profile.

• #profiling_group_name ⇒ String

  The name of the profiling group to get.

• #start_time ⇒ Time

  The start time of the profile to get.

Instance Attribute Details

#accept ⇒ String

The format of the returned profiling data. The format maps to the ‘Accept` and `Content-Type` headers of the HTTP request. You can specify one of the following: or the default .

<ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul>

Returns:

• (String)

# File 'lib/aws-sdk-codeguruprofiler/types.rb', line 865

class GetProfileRequest < Struct.new(
  :accept,
  :end_time,
  :max_depth,
  :period,
  :profiling_group_name,
  :start_time)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The end time of the requested profile. Specify 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.

If you specify ‘endTime`, then you must also specify `period` or `startTime`, but not both.

Returns:

• (Time)

# File 'lib/aws-sdk-codeguruprofiler/types.rb', line 865

class GetProfileRequest < Struct.new(
  :accept,
  :end_time,
  :max_depth,
  :period,
  :profiling_group_name,
  :start_time)
  SENSITIVE = []
  include Aws::Structure
end

#max_depth ⇒ Integer

The maximum depth of the stacks in the code that is represented in the aggregated profile. For example, if CodeGuru Profiler finds a method ‘A`, which calls method `B`, which calls method `C`, which calls method `D`, then the depth is 4. If the `maxDepth` is set to 2, then the aggregated profile contains representations of methods `A` and `B`.

Returns:

• (Integer)

# File 'lib/aws-sdk-codeguruprofiler/types.rb', line 865

class GetProfileRequest < Struct.new(
  :accept,
  :end_time,
  :max_depth,
  :period,
  :profiling_group_name,
  :start_time)
  SENSITIVE = []
  include Aws::Structure
end

#period ⇒ String

Used with ‘startTime` or `endTime` to specify the time range for the returned aggregated profile. Specify using the ISO 8601 format. For example, `P1DT1H1M1S`.

<p> To get the latest aggregated profile, specify only <code>period</code>. </p>

Returns:

• (String)

# File 'lib/aws-sdk-codeguruprofiler/types.rb', line 865

class GetProfileRequest < Struct.new(
  :accept,
  :end_time,
  :max_depth,
  :period,
  :profiling_group_name,
  :start_time)
  SENSITIVE = []
  include Aws::Structure
end

#profiling_group_name ⇒ String

The name of the profiling group to get.

Returns:

• (String)

# File 'lib/aws-sdk-codeguruprofiler/types.rb', line 865

class GetProfileRequest < Struct.new(
  :accept,
  :end_time,
  :max_depth,
  :period,
  :profiling_group_name,
  :start_time)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The start time of the profile to get. Specify 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.

<p> If you specify <code>startTime</code>, then you must also specify <code>period</code> or <code>endTime</code>, but not both. </p>

Returns:

• (Time)

# File 'lib/aws-sdk-codeguruprofiler/types.rb', line 865

class GetProfileRequest < Struct.new(
  :accept,
  :end_time,
  :max_depth,
  :period,
  :profiling_group_name,
  :start_time)
  SENSITIVE = []
  include Aws::Structure
end