Class ServiceDependent
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ServiceDependent.Builder,
ServiceDependent>
This structure contains information about a service dependent that was discovered by Application Signals. A dependent is an entity that invoked the specified service during the provided time range. Dependents include other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic ServiceDependent.Builder
builder()
This is a string-to-string map.final String
If the dependent invoker was a service that invoked it from an operation, the name of that dependent operation is displayed here.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the DependentKeyAttributes property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the MetricReferences property.final List
<MetricReference> An array of structures that each contain information about one metric associated with this service dependent that was discovered by Application Signals.final String
If the invoked entity is an operation on an entity, the name of that dependent operation is displayed here.static Class
<? extends ServiceDependent.Builder> 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
operationName
If the invoked entity is an operation on an entity, the name of that dependent operation is displayed here.
- Returns:
- If the invoked entity is an operation on an entity, the name of that dependent operation is displayed here.
-
hasDependentKeyAttributes
public final boolean hasDependentKeyAttributes()For responses, this returns true if the service returned a value for the DependentKeyAttributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
dependentKeyAttributes
This is a string-to-string map. It can include the following fields.
-
Type
designates the type of object this is. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
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
hasDependentKeyAttributes()
method.- Returns:
- This is a string-to-string map. It can include the following fields.
-
Type
designates the type of object this is. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
-
-
-
dependentOperationName
If the dependent invoker was a service that invoked it from an operation, the name of that dependent operation is displayed here.
- Returns:
- If the dependent invoker was a service that invoked it from an operation, the name of that dependent operation is displayed here.
-
hasMetricReferences
public final boolean hasMetricReferences()For responses, this returns true if the service returned a value for the MetricReferences property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
metricReferences
An array of structures that each contain information about one metric associated with this service dependent that was discovered by Application Signals.
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
hasMetricReferences()
method.- Returns:
- An array of structures that each contain information about one metric associated with this service dependent that was discovered by Application Signals.
-
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 interfaceToCopyableBuilder<ServiceDependent.Builder,
ServiceDependent> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-