Class InstrumentationConfigurationStatusReport

java.lang.Object

software.amazon.awssdk.services.applicationsignals.model.InstrumentationConfigurationStatusReport

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InstrumentationConfigurationStatusReport.Builder,InstrumentationConfigurationStatusReport>

@Generated("software.amazon.awssdk:codegen")
public final class InstrumentationConfigurationStatusReport
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InstrumentationConfigurationStatusReport.Builder,InstrumentationConfigurationStatusReport>

The status of a single instrumentation configuration reported by an SDK instance.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InstrumentationConfigurationStatusReport.Builder

Method Summary

Modifier and Type	Method	Description
static InstrumentationConfigurationStatusReport.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final InstrumentationErrorCause	errorCause()	The error cause when the status is ERROR, such as the file or method not being found.
final String	errorCauseAsString()	The error cause when the status is ERROR, such as the file or method not being found.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final InstrumentationType	instrumentationType()	The type of instrumentation configuration being reported.
final String	instrumentationTypeAsString()	The type of instrumentation configuration being reported.
final String	locationHash()	The stable hash of the instrumentation location that identifies the configuration being reported.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends InstrumentationConfigurationStatusReport.Builder>	serializableBuilderClass()
final DynamicInstrumentationSignalType	signalType()	The telemetry signal type for this instrumentation configuration.
final String	signalTypeAsString()	The telemetry signal type for this instrumentation configuration.
final InstrumentationConfigurationStatus	status()	The status of the instrumentation configuration: READY, ERROR, ACTIVE, or DISABLED.
final String	statusAsString()	The status of the instrumentation configuration: READY, ERROR, ACTIVE, or DISABLED.
final Instant	time()	The timestamp when the status event occurred.
InstrumentationConfigurationStatusReport.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

instrumentationType

public final InstrumentationType instrumentationType()

The type of instrumentation configuration being reported.

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 configuration being reported.

See Also:

• InstrumentationType

instrumentationTypeAsString

public final String instrumentationTypeAsString()

The type of instrumentation configuration being reported.

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 configuration being reported.

See Also:

• InstrumentationType

signalType

public final DynamicInstrumentationSignalType signalType()

The telemetry signal type for this 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:

The telemetry signal type for this instrumentation configuration.

See Also:

• DynamicInstrumentationSignalType

signalTypeAsString

public final String signalTypeAsString()

The telemetry signal type for this 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:

The telemetry signal type for this instrumentation configuration.

See Also:

• DynamicInstrumentationSignalType

locationHash

public final String locationHash()

The stable hash of the instrumentation location that identifies the configuration being reported.

Returns:

The stable hash of the instrumentation location that identifies the configuration being reported.

status

public final InstrumentationConfigurationStatus status()

The status of the instrumentation configuration: READY, ERROR, ACTIVE, or DISABLED.

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 status of the instrumentation configuration: READY, ERROR, ACTIVE, or DISABLED.

See Also:

• InstrumentationConfigurationStatus

statusAsString

public final String statusAsString()

The status of the instrumentation configuration: READY, ERROR, ACTIVE, or DISABLED.

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 status of the instrumentation configuration: READY, ERROR, ACTIVE, or DISABLED.

See Also:

• InstrumentationConfigurationStatus

time

public final Instant time()

The timestamp when the status event occurred.

Returns:

The timestamp when the status event occurred.

errorCause

public final InstrumentationErrorCause errorCause()

The error cause when the status is ERROR, such as the file or method not being found.

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

Returns:

The error cause when the status is ERROR, such as the file or method not being found.

See Also:

• InstrumentationErrorCause

errorCauseAsString

public final String errorCauseAsString()

The error cause when the status is ERROR, such as the file or method not being found.

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

Returns:

The error cause when the status is ERROR, such as the file or method not being found.

See Also:

• InstrumentationErrorCause

toBuilder

public InstrumentationConfigurationStatusReport.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<InstrumentationConfigurationStatusReport.Builder,InstrumentationConfigurationStatusReport>

Returns:

a builder for type T

builder

public static InstrumentationConfigurationStatusReport.Builder builder()

serializableBuilderClass

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