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(value="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 and Description
static interface	DescribeDomainsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeDomainsRequest.Builder	builder()
List<String>	domainNames() The names of the domains you want to include in the response.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDomainsRequest.Builder>	serializableBuilderClass()
DescribeDomainsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

domainNames

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

Returns:

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

toBuilder

public DescribeDomainsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDomainsRequest.Builder,DescribeDomainsRequest>

Specified by:

toBuilder in class CloudSearchRequest

Returns:

a builder for type T

builder

public static DescribeDomainsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeDomainsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.