Class ListInstrumentationConfigurationsRequest

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.ListInstrumentationConfigurationsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListInstrumentationConfigurationsRequest.Builder,ListInstrumentationConfigurationsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListInstrumentationConfigurationsRequest extends ApplicationSignalsRequest implements ToCopyableBuilder<ListInstrumentationConfigurationsRequest.Builder,ListInstrumentationConfigurationsRequest>

  • Method Details

    • service

      public final String service()

      The name of the service to retrieve instrumentation configurations for.

      Returns:
      The name of the service to retrieve instrumentation configurations for.

    • environment

      public final String environment()

      The environment that the service is running in.

      Returns:
      The environment that the service is running in.

    • instrumentationType

      public final InstrumentationType instrumentationType()

      Type of instrumentation configuration (BREAKPOINT or PROBE). Required to determine which backing store to query.

      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 determine which backing store to query.
      See Also:

    • instrumentationTypeAsString

      public final String instrumentationTypeAsString()

      Type of instrumentation configuration (BREAKPOINT or PROBE). Required to determine which backing store to query.

      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 determine which backing store to query.
      See Also:

    • syncedAt

      public final Instant syncedAt()

      The timestamp from the last successful sync. When provided, the response returns Changed as false if nothing is new since this time, or returns the latest configurations when changes exist.

      Returns:
      The timestamp from the last successful sync. When provided, the response returns Changed as false if nothing is new since this time, or returns the latest configurations when changes exist.

    • maxResults

      public final Integer maxResults()

      The maximum number of configurations to return in one call. The default is 50 and the maximum is 100.

      Returns:
      The maximum number of configurations to return in one call. The default is 50 and the maximum is 100.

    • nextToken

      public final String nextToken()

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

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

    • toBuilder

      public ListInstrumentationConfigurationsRequest.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<ListInstrumentationConfigurationsRequest.Builder,ListInstrumentationConfigurationsRequest>
      Specified by:
      toBuilder in class ApplicationSignalsRequest
      Returns:
      a builder for type T

    • builder

      public static ListInstrumentationConfigurationsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListInstrumentationConfigurationsRequest.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.