Class CreateInstrumentationConfigurationRequest

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

  • Method Details

    • instrumentationType

      public final InstrumentationType instrumentationType()

      Type of instrumentation: BREAKPOINT (temporary) or PROBE (permanent)

      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: BREAKPOINT (temporary) or PROBE (permanent)
      See Also:

    • instrumentationTypeAsString

      public final String instrumentationTypeAsString()

      Type of instrumentation: BREAKPOINT (temporary) or PROBE (permanent)

      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: BREAKPOINT (temporary) or PROBE (permanent)
      See Also:

    • service

      public final String service()

      The name of the service to instrument. This should match the service.name resource attribute reported by the application.

      Returns:
      The name of the service to instrument. This should match the service.name resource attribute reported by the application.

    • environment

      public final String environment()

      The environment that the service is running in, such as eks:cluster-prod/namespace or ec2:production.

      Returns:
      The environment that the service is running in, such as eks:cluster-prod/namespace or ec2:production.

    • signalType

      public final DynamicInstrumentationSignalType signalType()

      The telemetry signal type to emit for this instrumentation. The supported value is SNAPSHOT.

      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:
      The telemetry signal type to emit for this instrumentation. The supported value is SNAPSHOT.
      See Also:

    • signalTypeAsString

      public final String signalTypeAsString()

      The telemetry signal type to emit for this instrumentation. The supported value is SNAPSHOT.

      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:
      The telemetry signal type to emit for this instrumentation. The supported value is SNAPSHOT.
      See Also:

    • location

      public final Location location()

      The location where instrumentation should be applied. Specify a CodeLocation for code-level instrumentation.

      Returns:
      The location where instrumentation should be applied. Specify a CodeLocation for code-level instrumentation.

    • description

      public final String description()

      An optional short description (up to 50 characters) that explains the purpose of this instrumentation.

      Returns:
      An optional short description (up to 50 characters) that explains the purpose of this instrumentation.

    • expiresAt

      public final Instant expiresAt()

      For BREAKPOINT: optional, defaults to 24 hours, must be between 5 min and 24 hours. For PROBE: not supported. PROBE configurations are permanent and persist until explicitly deleted.

      Returns:
      For BREAKPOINT: optional, defaults to 24 hours, must be between 5 min and 24 hours. For PROBE: not supported. PROBE configurations are permanent and persist until explicitly deleted.

    • hasAttributeFilters

      public final boolean hasAttributeFilters()
      For responses, this returns true if the service returned a value for the AttributeFilters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • attributeFilters

      public final List<Map<String,String>> attributeFilters()

      Client-side filters that target specific instances. Each object in the array is AND-matched on its keys, and multiple objects are OR-matched to decide where to apply the instrumentation.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributeFilters() method.

      Returns:
      Client-side filters that target specific instances. Each object in the array is AND-matched on its keys, and multiple objects are OR-matched to decide where to apply the instrumentation.

    • captureConfiguration

      public final CaptureConfiguration captureConfiguration()

      Specifies what to capture when the instrumentation point is hit. Specify CodeCapture for code-level capture settings.

      Returns:
      Specifies what to capture when the instrumentation point is hit. Specify CodeCapture for code-level capture settings.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      An optional list of key-value pairs to associate with the instrumentation configuration. Tags can help you organize and categorize your resources.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      An optional list of key-value pairs to associate with the instrumentation configuration. Tags can help you organize and categorize your resources.

    • toBuilder

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

    • builder

      public static CreateInstrumentationConfigurationRequest.Builder builder()

    • serializableBuilderClass

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