Class GetInstrumentationConfigurationStatusRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.applicationsignals.model.ApplicationSignalsRequest
software.amazon.awssdk.services.applicationsignals.model.GetInstrumentationConfigurationStatusRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetInstrumentationConfigurationStatusRequest.Builder,GetInstrumentationConfigurationStatusRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetInstrumentationConfigurationStatusRequest extends ApplicationSignalsRequest implements ToCopyableBuilder<GetInstrumentationConfigurationStatusRequest.Builder,GetInstrumentationConfigurationStatusRequest>

  • Method Details

    • instrumentationType

      public final InstrumentationType instrumentationType()

      Type of instrumentation configuration (BREAKPOINT or PROBE). Required to identify the configuration to retrieve.

      If the service returns an enum value that is not available in the current SDK version, instrumentationType will return InstrumentationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instrumentationTypeAsString().

      Returns:
      Type of instrumentation configuration (BREAKPOINT or PROBE). Required to identify the configuration to retrieve.
      See Also:

    • instrumentationTypeAsString

      public final String instrumentationTypeAsString()

      Type of instrumentation configuration (BREAKPOINT or PROBE). Required to identify the configuration to retrieve.

      If the service returns an enum value that is not available in the current SDK version, instrumentationType will return InstrumentationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instrumentationTypeAsString().

      Returns:
      Type of instrumentation configuration (BREAKPOINT or PROBE). Required to identify the configuration to retrieve.
      See Also:

    • service

      public final String service()

      Service name for the instrumentation configuration.

      Returns:
      Service name for the instrumentation configuration.

    • environment

      public final String environment()

      Environment name for the instrumentation configuration.

      Returns:
      Environment name for the instrumentation configuration.

    • signalType

      public final DynamicInstrumentationSignalType signalType()

      Signal type for the instrumentation configuration.

      If the service returns an enum value that is not available in the current SDK version, signalType will return DynamicInstrumentationSignalType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from signalTypeAsString().

      Returns:
      Signal type for the instrumentation configuration.
      See Also:

    • signalTypeAsString

      public final String signalTypeAsString()

      Signal type for the instrumentation configuration.

      If the service returns an enum value that is not available in the current SDK version, signalType will return DynamicInstrumentationSignalType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from signalTypeAsString().

      Returns:
      Signal type for the instrumentation configuration.
      See Also:

    • locationIdentifier

      public final LocationIdentifier locationIdentifier()

      Location identifier - either full code location or a pre-computed hash.

      Returns:
      Location identifier - either full code location or a pre-computed hash.

    • status

      public final InstrumentationConfigurationStatus status()

      The single status to query for. If omitted, only ACTIVE status events are returned.

      If the service returns an enum value that is not available in the current SDK version, status will return InstrumentationConfigurationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The single status to query for. If omitted, only ACTIVE status events are returned.
      See Also:

    • statusAsString

      public final String statusAsString()

      The single status to query for. If omitted, only ACTIVE status events are returned.

      If the service returns an enum value that is not available in the current SDK version, status will return InstrumentationConfigurationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The single status to query for. If omitted, only ACTIVE status events are returned.
      See Also:

    • startTime

      public final Instant startTime()

      The start of the time range to retrieve status events for. StartTime and EndTime must both be provided together or both be omitted. When both are omitted, the time range defaults to the last hour.

      Returns:
      The start of the time range to retrieve status events for. StartTime and EndTime must both be provided together or both be omitted. When both are omitted, the time range defaults to the last hour.

    • endTime

      public final Instant endTime()

      The end of the time range to retrieve status events for. StartTime and EndTime must both be provided together or both be omitted. When both are omitted, the time range defaults to the last hour.

      Returns:
      The end of the time range to retrieve status events for. StartTime and EndTime must both be provided together or both be omitted. When both are omitted, the time range defaults to the last hour.

    • maxResults

      public final Integer maxResults()

      The maximum number of status events to return in one call. The default is 60.

      Returns:
      The maximum number of status events to return in one call. The default is 60.

    • nextToken

      public final String nextToken()

      Use the token returned by a previous call to retrieve the next page of status events.

      Returns:
      Use the token returned by a previous call to retrieve the next page of status events.

    • toBuilder

      public GetInstrumentationConfigurationStatusRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetInstrumentationConfigurationStatusRequest.Builder,GetInstrumentationConfigurationStatusRequest>
      Specified by:
      toBuilder in class ApplicationSignalsRequest
      Returns:
      a builder for type T

    • builder

      public static GetInstrumentationConfigurationStatusRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetInstrumentationConfigurationStatusRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.