Package software.amazon.awssdk.services.directory.model

Class DescribeEventTopicsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.directory.model.DirectoryRequest

software.amazon.awssdk.services.directory.model.DescribeEventTopicsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeEventTopicsRequest.Builder,DescribeEventTopicsRequest>

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

Describes event topics.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeEventTopicsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeEventTopicsRequest.Builder	builder()
String	directoryId()	The Directory ID for which to get the list of associated Amazon SNS topics.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTopicNames()	For responses, this returns true if the service returned a value for the TopicNames property.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeEventTopicsRequest.Builder>	serializableBuilderClass()
DescribeEventTopicsRequest.Builder	toBuilder()
List<String>	topicNames()	A list of Amazon SNS topic names for which to obtain the information.
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

directoryId

public final String directoryId()

The Directory ID for which to get the list of associated Amazon SNS topics. If this member is null, associations for all Directory IDs are returned.

Returns:

The Directory ID for which to get the list of associated Amazon SNS topics. If this member is null, associations for all Directory IDs are returned.

hasTopicNames

public final boolean hasTopicNames()

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

topicNames

public final List<String> topicNames()

A list of Amazon SNS topic names for which to obtain the information. If this member is null, all associations for the specified Directory ID are returned.

An empty list results in an InvalidParameterException being thrown.

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

Returns:

A list of Amazon SNS topic names for which to obtain the information. If this member is null, all associations for the specified Directory ID are returned.

An empty list results in an InvalidParameterException being thrown.

toBuilder

public DescribeEventTopicsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeEventTopicsRequest.Builder,DescribeEventTopicsRequest>

Specified by:

toBuilder in class DirectoryRequest

builder

public static DescribeEventTopicsRequest.Builder builder()

serializableBuilderClass

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