Package software.amazon.awssdk.services.codeguruprofiler.model

Interface GetProfileRequest.Builder

    • Method Detail

      • accept

        GetProfileRequest.Builder accept​(String accept)

        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>
        Parameters:
        accept - 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:
        Returns a reference to this object so that method calls can be chained together.

      • endTime

        GetProfileRequest.Builder endTime​(Instant endTime)

        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.

        Parameters:
        endTime - 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:
        Returns a reference to this object so that method calls can be chained together.

      • maxDepth

        GetProfileRequest.Builder maxDepth​(Integer maxDepth)

        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.

        Parameters:
        maxDepth - 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:
        Returns a reference to this object so that method calls can be chained together.

      • period

        GetProfileRequest.Builder period​(String period)

        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>
        Parameters:
        period - 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:
        Returns a reference to this object so that method calls can be chained together.

      • profilingGroupName

        GetProfileRequest.Builder profilingGroupName​(String profilingGroupName)

        The name of the profiling group to get.

        Parameters:
        profilingGroupName - The name of the profiling group to get.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • startTime

        GetProfileRequest.Builder startTime​(Instant startTime)

        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>
        Parameters:
        startTime - 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:
        Returns a reference to this object so that method calls can be chained together.