public class DescribeTrailsRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Returns information about the trail.
Modifier and Type | Field and Description |
---|---|
private java.lang.Boolean |
includeShadowTrails
Specifies whether to include shadow trails in the response.
|
private SdkInternalList<java.lang.String> |
trailNameList
Specifies a list of trail names, trail ARNs, or both, of the trails to
describe.
|
NOOP
Constructor and Description |
---|
DescribeTrailsRequest() |
Modifier and Type | Method and Description |
---|---|
DescribeTrailsRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.Boolean |
getIncludeShadowTrails()
Specifies whether to include shadow trails in the response.
|
java.util.List<java.lang.String> |
getTrailNameList()
Specifies a list of trail names, trail ARNs, or both, of the trails to
describe.
|
int |
hashCode() |
java.lang.Boolean |
isIncludeShadowTrails()
Specifies whether to include shadow trails in the response.
|
void |
setIncludeShadowTrails(java.lang.Boolean includeShadowTrails)
Specifies whether to include shadow trails in the response.
|
void |
setTrailNameList(java.util.Collection<java.lang.String> trailNameList)
Specifies a list of trail names, trail ARNs, or both, of the trails to
describe.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeTrailsRequest |
withIncludeShadowTrails(java.lang.Boolean includeShadowTrails)
Specifies whether to include shadow trails in the response.
|
DescribeTrailsRequest |
withTrailNameList(java.util.Collection<java.lang.String> trailNameList)
Specifies a list of trail names, trail ARNs, or both, of the trails to
describe.
|
DescribeTrailsRequest |
withTrailNameList(java.lang.String... trailNameList)
Specifies a list of trail names, trail ARNs, or both, of the trails to
describe.
|
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
private SdkInternalList<java.lang.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.
private java.lang.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.
public java.util.List<java.lang.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.
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.
public void setTrailNameList(java.util.Collection<java.lang.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.
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.
public DescribeTrailsRequest withTrailNameList(java.lang.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.
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.
public DescribeTrailsRequest withTrailNameList(java.util.Collection<java.lang.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.
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.
public void setIncludeShadowTrails(java.lang.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.
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.public java.lang.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.
public DescribeTrailsRequest withIncludeShadowTrails(java.lang.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.
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.public java.lang.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.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public DescribeTrailsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()