Package software.amazon.awssdk.services.cloudtrail.model

Class DescribeTrailsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudtrail.model.CloudTrailRequest

software.amazon.awssdk.services.cloudtrail.model.DescribeTrailsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeTrailsRequest.Builder,DescribeTrailsRequest>

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

Returns information about the trail.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeTrailsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeTrailsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTrailNameList()	For responses, this returns true if the service returned a value for the TrailNameList property.
Boolean	includeShadowTrails()	Specifies whether to include shadow trails in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeTrailsRequest.Builder>	serializableBuilderClass()
DescribeTrailsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	trailNameList()	Specifies a list of trail names, trail ARNs, or both, of the trails to describe.

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

hasTrailNameList

public final boolean hasTrailNameList()

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

trailNameList

public final List<String> trailNameList()

Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

If an empty list is specified, information for the trail in the current Region is returned.

• If an empty list is specified and IncludeShadowTrails is false, then information for all trails in the current Region is returned.

• If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current Region and any associated shadow trails in other Regions is returned.

If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current Region and current account. To return information about a trail in another Region, you must specify its trail ARN.

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

Returns:

Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

If an empty list is specified, information for the trail in the current Region is returned.

• If an empty list is specified and IncludeShadowTrails is false, then information for all trails in the current Region is returned.

• If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current Region and any associated shadow trails in other Regions is returned.

If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current Region and current account. To return information about a trail in another Region, you must specify its trail ARN.

includeShadowTrails

public final Boolean includeShadowTrails()

Specifies whether to include shadow trails in the response. A shadow trail is the replication in a Region of a trail that was created in a different Region, or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account and Region replication trails will not be returned. The default is true.

Returns:

Specifies whether to include shadow trails in the response. A shadow trail is the replication in a Region of a trail that was created in a different Region, or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account and Region replication trails will not be returned. The default is true.

toBuilder

public DescribeTrailsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeTrailsRequest.Builder,DescribeTrailsRequest>

Specified by:

toBuilder in class CloudTrailRequest

builder

public static DescribeTrailsRequest.Builder builder()

serializableBuilderClass

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