Class CodeLocation

java.lang.Object
software.amazon.awssdk.services.applicationsignals.model.CodeLocation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CodeLocation.Builder,CodeLocation>
@Generated("software.amazon.awssdk:codegen") public final class CodeLocation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CodeLocation.Builder,CodeLocation>

Identifies a code location to instrument, including the programming language, code unit, class, method, file path, and optional line number.

See Also:

  • Method Details

    • language

      public final ProgrammingLanguage language()

      The programming language for this instrumentation point, such as Java, Python, or JavaScript.

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

      Returns:
      The programming language for this instrumentation point, such as Java, Python, or JavaScript.
      See Also:

    • languageAsString

      public final String languageAsString()

      The programming language for this instrumentation point, such as Java, Python, or JavaScript.

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

      Returns:
      The programming language for this instrumentation point, such as Java, Python, or JavaScript.
      See Also:

    • codeUnit

      public final String codeUnit()

      The package, module, or namespace that contains the target code, for example com.amazon.payment or payment_service.

      Returns:
      The package, module, or namespace that contains the target code, for example com.amazon.payment or payment_service.

    • className

      public final String className()

      The class or type name that contains the method. This is required for Java and optional for Python module-level functions.

      Returns:
      The class or type name that contains the method. This is required for Java and optional for Python module-level functions.

    • methodName

      public final String methodName()

      The method or function name to instrument, such as validateCreditCard or __init__.

      Returns:
      The method or function name to instrument, such as validateCreditCard or __init__.

    • filePath

      public final String filePath()

      The source file path relative to the project or source root, such as src/payment/PaymentProcessor.java or src/payment/PaymentProcessor.py.

      Returns:
      The source file path relative to the project or source root, such as src/payment/PaymentProcessor.java or src/payment/PaymentProcessor.py.

    • lineNumber

      public final Integer lineNumber()

      The line number to instrument. Provide this to disambiguate overloaded methods and to target a specific line when needed.

      Returns:
      The line number to instrument. Provide this to disambiguate overloaded methods and to target a specific line when needed.

    • toBuilder

      public CodeLocation.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<CodeLocation.Builder,CodeLocation>
      Returns:
      a builder for type T

    • builder

      public static CodeLocation.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.