Class CreateInstrumentationConfigurationResponse

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

  • Method Details

    • instrumentationType

      public final InstrumentationType instrumentationType()

      The type of instrumentation that was created, echoed from the request.

      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:
      The type of instrumentation that was created, echoed from the request.
      See Also:

    • instrumentationTypeAsString

      public final String instrumentationTypeAsString()

      The type of instrumentation that was created, echoed from the request.

      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:
      The type of instrumentation that was created, echoed from the request.
      See Also:

    • service

      public final String service()

      The service name for the instrumentation configuration, echoed from the request.

      Returns:
      The service name for the instrumentation configuration, echoed from the request.

    • environment

      public final String environment()

      The environment for the instrumentation configuration, echoed from the request.

      Returns:
      The environment for the instrumentation configuration, echoed from the request.

    • signalType

      public final DynamicInstrumentationSignalType signalType()

      The telemetry signal type for the instrumentation configuration, echoed from the request.

      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 for the instrumentation configuration, echoed from the request.
      See Also:

    • signalTypeAsString

      public final String signalTypeAsString()

      The telemetry signal type for the instrumentation configuration, echoed from the request.

      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 for the instrumentation configuration, echoed from the request.
      See Also:

    • location

      public final Location location()

      The location where instrumentation is applied, echoed from the request.

      Returns:
      The location where instrumentation is applied, echoed from the request.

    • locationHash

      public final String locationHash()

      A stable hash computed from the location that uniquely identifies this instrumentation point within the service, environment, and signal type.

      Returns:
      A stable hash computed from the location that uniquely identifies this instrumentation point within the service, environment, and signal type.

    • description

      public final String description()

      The optional description that was stored with the instrumentation configuration.

      Returns:
      The optional description that was stored with the instrumentation configuration.

    • expiresAt

      public final Instant expiresAt()

      The timestamp after which this configuration is no longer served to clients. Present only for BREAKPOINT configurations; PROBE configurations do not expire.

      Returns:
      The timestamp after which this configuration is no longer served to clients. Present only for BREAKPOINT configurations; PROBE configurations do not expire.

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

      The attribute filters returned with the configuration so SDKs can perform client-side targeting.

      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:
      The attribute filters returned with the configuration so SDKs can perform client-side targeting.

    • captureConfiguration

      public final CaptureConfiguration captureConfiguration()

      The capture settings that were stored for this instrumentation configuration.

      Returns:
      The capture settings that were stored for this instrumentation configuration.

    • createdAt

      public final Instant createdAt()

      The server-generated creation timestamp for this instrumentation configuration.

      Returns:
      The server-generated creation timestamp for this instrumentation configuration.

    • arn

      public final String arn()

      ARN for the created instrumentation configuration

      Returns:
      ARN for the created instrumentation configuration

    • toBuilder

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

    • builder

      public static CreateInstrumentationConfigurationResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.