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

Class ListTagsRequest

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.ListTagsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListTagsRequest.Builder,ListTagsRequest>

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

Specifies a list of tags to return.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListTagsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListTagsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResourceIdList()	For responses, this returns true if the service returned a value for the ResourceIdList property.
String	nextToken()	Reserved for future use.
List<String>	resourceIdList()	Specifies a list of trail, event data store, or channel ARNs whose tags will be listed.
List<SdkField<?>>	sdkFields()
static Class<? extends ListTagsRequest.Builder>	serializableBuilderClass()
ListTagsRequest.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

hasResourceIdList

public final boolean hasResourceIdList()

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

resourceIdList

public final List<String> resourceIdList()

Specifies a list of trail, event data store, or channel ARNs whose tags will be listed. The list has a limit of 20 ARNs.

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

Example event data store ARN format: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

Example channel ARN format: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

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

Returns:

Specifies a list of trail, event data store, or channel ARNs whose tags will be listed. The list has a limit of 20 ARNs.

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

Example event data store ARN format: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

Example channel ARN format: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

nextToken

public final String nextToken()

Reserved for future use.

Returns:

Reserved for future use.

toBuilder

public ListTagsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListTagsRequest.Builder,ListTagsRequest>

Specified by:

toBuilder in class CloudTrailRequest

builder

public static ListTagsRequest.Builder builder()

serializableBuilderClass

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