Class DescribeTrailsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudtrail.model.DescribeTrailsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeTrailsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Returns information about the trail.

See Also:

• Serialized Form

Field Summary

Fields inherited from class AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
DescribeTrailsRequest()

Method Summary

Modifier and Type	Method	Description
DescribeTrailsRequest	clone()	Creates a shallow clone of this request.
boolean	equals(Object obj)
Boolean	getIncludeShadowTrails()	Specifies whether to include shadow trails in the response.
List<String>	getTrailNameList()	Specifies a list of trail names, trail ARNs, or both, of the trails to describe.
int	hashCode()
Boolean	isIncludeShadowTrails()	Specifies whether to include shadow trails in the response.
void	setIncludeShadowTrails(Boolean includeShadowTrails)	Specifies whether to include shadow trails in the response.
void	setTrailNameList(Collection<String> trailNameList)	Specifies a list of trail names, trail ARNs, or both, of the trails to describe.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
DescribeTrailsRequest	withIncludeShadowTrails(Boolean includeShadowTrails)	Specifies whether to include shadow trails in the response.
DescribeTrailsRequest	withTrailNameList(String... trailNameList)	Specifies a list of trail names, trail ARNs, or both, of the trails to describe.
DescribeTrailsRequest	withTrailNameList(Collection<String> trailNameList)	Specifies a list of trail names, trail ARNs, or both, of the trails to describe.

Methods inherited from class AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DescribeTrailsRequest

public DescribeTrailsRequest()

Method Details

getTrailNameList

public List<String> getTrailNameList()

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.

setTrailNameList

public void setTrailNameList(Collection<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.

Parameters:

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.

withTrailNameList

public DescribeTrailsRequest withTrailNameList(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.

NOTE: This method appends the values to the existing list (if any). Use setTrailNameList(java.util.Collection) or withTrailNameList(java.util.Collection) if you want to override the existing values.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

withTrailNameList

public DescribeTrailsRequest withTrailNameList(Collection<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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setIncludeShadowTrails

public void setIncludeShadowTrails(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.

Parameters:

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.

getIncludeShadowTrails

public Boolean getIncludeShadowTrails()

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.

withIncludeShadowTrails

public DescribeTrailsRequest withIncludeShadowTrails(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

isIncludeShadowTrails

public Boolean isIncludeShadowTrails()

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.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

• Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeTrailsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

• Object.clone()