software.amazon.awssdk.services.xray.model

Class GetSamplingTargetsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.xray.model.XRayResponse

software.amazon.awssdk.services.xray.model.GetSamplingTargetsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetSamplingTargetsResponse.Builder,GetSamplingTargetsResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetSamplingTargetsResponse
extends XRayResponse
implements ToCopyableBuilder<GetSamplingTargetsResponse.Builder,GetSamplingTargetsResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetSamplingTargetsResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetSamplingTargetsResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSamplingTargetDocuments() For responses, this returns true if the service returned a value for the SamplingTargetDocuments property.
boolean	hasUnprocessedStatistics() For responses, this returns true if the service returned a value for the UnprocessedStatistics property.
Instant	lastRuleModification() The last time a user changed the sampling rule configuration.
List<SamplingTargetDocument>	samplingTargetDocuments() Updated rules that the service should use to sample requests.
List<SdkField<?>>	sdkFields()
static Class<? extends GetSamplingTargetsResponse.Builder>	serializableBuilderClass()
GetSamplingTargetsResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<UnprocessedStatistics>	unprocessedStatistics() Information about SamplingStatisticsDocument that X-Ray could not process.

Methods inherited from class software.amazon.awssdk.services.xray.model.XRayResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hasSamplingTargetDocuments

public final boolean hasSamplingTargetDocuments()

For responses, this returns true if the service returned a value for the SamplingTargetDocuments 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.

samplingTargetDocuments

public final List<SamplingTargetDocument> samplingTargetDocuments()

Updated rules that the service should use to sample requests.

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 hasSamplingTargetDocuments() method.

Returns:

Updated rules that the service should use to sample requests.

lastRuleModification

public final Instant lastRuleModification()

The last time a user changed the sampling rule configuration. If the sampling rule configuration changed since the service last retrieved it, the service should call GetSamplingRules to get the latest version.

Returns:

The last time a user changed the sampling rule configuration. If the sampling rule configuration changed since the service last retrieved it, the service should call GetSamplingRules to get the latest version.

hasUnprocessedStatistics

public final boolean hasUnprocessedStatistics()

For responses, this returns true if the service returned a value for the UnprocessedStatistics 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.

unprocessedStatistics

public final List<UnprocessedStatistics> unprocessedStatistics()

Information about SamplingStatisticsDocument that X-Ray could not process.

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 hasUnprocessedStatistics() method.

Returns:

Information about SamplingStatisticsDocument that X-Ray could not process.

toBuilder

public GetSamplingTargetsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetSamplingTargetsResponse.Builder,GetSamplingTargetsResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetSamplingTargetsResponse.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo