Package software.amazon.awssdk.services.cloudsearch.model

Class DescribeDomainsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudsearch.model.CloudSearchRequest

software.amazon.awssdk.services.cloudsearch.model.DescribeDomainsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDomainsRequest.Builder,DescribeDomainsRequest>

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

Container for the parameters to the DescribeDomains operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeDomainsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeDomainsRequest.Builder	builder()
List<String>	domainNames()	The names of the domains you want to include in the response.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDomainNames()	For responses, this returns true if the service returned a value for the DomainNames property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDomainsRequest.Builder>	serializableBuilderClass()
DescribeDomainsRequest.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

hasDomainNames

public final boolean hasDomainNames()

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

domainNames

public final List<String> domainNames()

The names of the domains you want to include in the response.

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

Returns:

The names of the domains you want to include in the response.

toBuilder

public DescribeDomainsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDomainsRequest.Builder,DescribeDomainsRequest>

Specified by:

toBuilder in class CloudSearchRequest

builder

public static DescribeDomainsRequest.Builder builder()

serializableBuilderClass

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