software.amazon.awssdk.services.inspector.model

Class AgentFilter

java.lang.Object

software.amazon.awssdk.services.inspector.model.AgentFilter

All Implemented Interfaces:

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

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

Contains information about an Amazon Inspector agent. This data type is used as a request parameter in the ListAssessmentRunAgents action.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AgentFilter.Builder

Method Summary

Modifier and Type	Method and Description
List<AgentHealthCode>	agentHealthCodes() The detailed health state of the agent.
List<String>	agentHealthCodesAsStrings() The detailed health state of the agent.
List<AgentHealth>	agentHealths() The current health state of the agent.
List<String>	agentHealthsAsStrings() The current health state of the agent.
static AgentFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAgentHealthCodes() For responses, this returns true if the service returned a value for the AgentHealthCodes property.
boolean	hasAgentHealths() For responses, this returns true if the service returned a value for the AgentHealths property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends AgentFilter.Builder>	serializableBuilderClass()
AgentFilter.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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 Detail

agentHealths

public final List<AgentHealth> agentHealths()

The current health state of the agent. Values can be set to HEALTHY or UNHEALTHY.

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

Returns:

The current health state of the agent. Values can be set to HEALTHY or UNHEALTHY.

hasAgentHealths

public final boolean hasAgentHealths()

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

agentHealthsAsStrings

public final List<String> agentHealthsAsStrings()

The current health state of the agent. Values can be set to HEALTHY or UNHEALTHY.

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

Returns:

The current health state of the agent. Values can be set to HEALTHY or UNHEALTHY.

agentHealthCodes

public final List<AgentHealthCode> agentHealthCodes()

The detailed health state of the agent. Values can be set to IDLE, RUNNING, SHUTDOWN, UNHEALTHY, THROTTLED, and UNKNOWN.

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

Returns:

The detailed health state of the agent. Values can be set to IDLE, RUNNING, SHUTDOWN, UNHEALTHY, THROTTLED, and UNKNOWN.

hasAgentHealthCodes

public final boolean hasAgentHealthCodes()

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

agentHealthCodesAsStrings

public final List<String> agentHealthCodesAsStrings()

The detailed health state of the agent. Values can be set to IDLE, RUNNING, SHUTDOWN, UNHEALTHY, THROTTLED, and UNKNOWN.

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

Returns:

The detailed health state of the agent. Values can be set to IDLE, RUNNING, SHUTDOWN, UNHEALTHY, THROTTLED, and UNKNOWN.

toBuilder

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

Returns:

a builder for type T

builder

public static AgentFilter.Builder builder()

serializableBuilderClass

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