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

Class DescribeTrailsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

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

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DescribeTrailsRequest.Builder,DescribeTrailsRequest>

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

Returns information about the trail.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeTrailsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static DescribeTrailsRequest.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
Boolean	includeShadowTrails()	Specifies whether to include shadow trails in the response.
static Class<? extends DescribeTrailsRequest.Builder>	serializableBuilderClass()
DescribeTrailsRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

trailNameList

public 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-1: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. To return information about a trail in another region, you must specify its trail ARN.

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-1: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. To return information about a trail in another region, you must specify its trail ARN.

includeShadowTrails

public 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. 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. The default is true.

toBuilder

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

Returns:

a builder for type T

builder

public static DescribeTrailsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object