Package software.amazon.awssdk.services.securityhub.model

Class GetInsightsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.securityhub.model.SecurityHubRequest

software.amazon.awssdk.services.securityhub.model.GetInsightsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetInsightsRequest.Builder,GetInsightsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GetInsightsRequest
extends SecurityHubRequest
implements ToCopyableBuilder<GetInsightsRequest.Builder,GetInsightsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetInsightsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetInsightsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInsightArns()	For responses, this returns true if the service returned a value for the InsightArns property.
List<String>	insightArns()	The ARNs of the insights to describe.
Integer	maxResults()	The maximum number of items to return in the response.
String	nextToken()	The token that is required for pagination.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetInsightsRequest.Builder>	serializableBuilderClass()
GetInsightsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

hasInsightArns

public final boolean hasInsightArns()

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

insightArns

public final List<String> insightArns()

The ARNs of the insights to describe. If you don't provide any insight ARNs, then GetInsights returns all of your custom insights. It does not return any managed insights.

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

Returns:

The ARNs of the insights to describe. If you don't provide any insight ARNs, then GetInsights returns all of your custom insights. It does not return any managed insights.

nextToken

public final String nextToken()

The token that is required for pagination. On your first call to the GetInsights operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

Returns:

The token that is required for pagination. On your first call to the GetInsights operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

maxResults

public final Integer maxResults()

The maximum number of items to return in the response.

Returns:

The maximum number of items to return in the response.

toBuilder

public GetInsightsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetInsightsRequest.Builder,GetInsightsRequest>

Specified by:

toBuilder in class SecurityHubRequest

builder

public static GetInsightsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo