software.amazon.awssdk.services.iot.model

Class DescribeDomainConfigurationResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iot.model.IotResponse

software.amazon.awssdk.services.iot.model.DescribeDomainConfigurationResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDomainConfigurationResponse.Builder,DescribeDomainConfigurationResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeDomainConfigurationResponse
extends IotResponse
implements ToCopyableBuilder<DescribeDomainConfigurationResponse.Builder,DescribeDomainConfigurationResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeDomainConfigurationResponse.Builder

Method Summary

Modifier and Type	Method and Description
AuthorizerConfig	authorizerConfig() An object that specifies the authorization service for a domain.
static DescribeDomainConfigurationResponse.Builder	builder()
String	domainConfigurationArn() The ARN of the domain configuration.
String	domainConfigurationName() The name of the domain configuration.
DomainConfigurationStatus	domainConfigurationStatus() A Boolean value that specifies the current state of the domain configuration.
String	domainConfigurationStatusAsString() A Boolean value that specifies the current state of the domain configuration.
String	domainName() The name of the domain.
DomainType	domainType() The type of the domain.
String	domainTypeAsString() The type of the domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
boolean	hasServerCertificates() For responses, this returns true if the service returned a value for the ServerCertificates property.
Instant	lastStatusChangeDate() The date and time the domain configuration's status was last changed.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDomainConfigurationResponse.Builder>	serializableBuilderClass()
List<ServerCertificateSummary>	serverCertificates() A list containing summary information about the server certificate included in the domain configuration.
ServiceType	serviceType() The type of service delivered by the endpoint.
String	serviceTypeAsString() The type of service delivered by the endpoint.
DescribeDomainConfigurationResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.iot.model.IotResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

domainConfigurationName

public final String domainConfigurationName()

The name of the domain configuration.

Returns:

The name of the domain configuration.

domainConfigurationArn

public final String domainConfigurationArn()

The ARN of the domain configuration.

Returns:

The ARN of the domain configuration.

domainName

public final String domainName()

The name of the domain.

Returns:

The name of the domain.

hasServerCertificates

public final boolean hasServerCertificates()

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

serverCertificates

public final List<ServerCertificateSummary> serverCertificates()

A list containing summary information about the server certificate included in the domain configuration.

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

Returns:

A list containing summary information about the server certificate included in the domain configuration.

authorizerConfig

public final AuthorizerConfig authorizerConfig()

An object that specifies the authorization service for a domain.

Returns:

An object that specifies the authorization service for a domain.

domainConfigurationStatus

public final DomainConfigurationStatus domainConfigurationStatus()

A Boolean value that specifies the current state of the domain configuration.

If the service returns an enum value that is not available in the current SDK version, domainConfigurationStatus will return DomainConfigurationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainConfigurationStatusAsString().

Returns:

A Boolean value that specifies the current state of the domain configuration.

See Also:

DomainConfigurationStatus

domainConfigurationStatusAsString

public final String domainConfigurationStatusAsString()

A Boolean value that specifies the current state of the domain configuration.

If the service returns an enum value that is not available in the current SDK version, domainConfigurationStatus will return DomainConfigurationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainConfigurationStatusAsString().

Returns:

A Boolean value that specifies the current state of the domain configuration.

See Also:

DomainConfigurationStatus

serviceType

public final ServiceType serviceType()

The type of service delivered by the endpoint.

If the service returns an enum value that is not available in the current SDK version, serviceType will return ServiceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serviceTypeAsString().

Returns:

The type of service delivered by the endpoint.

See Also:

ServiceType

serviceTypeAsString

public final String serviceTypeAsString()

The type of service delivered by the endpoint.

If the service returns an enum value that is not available in the current SDK version, serviceType will return ServiceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serviceTypeAsString().

Returns:

The type of service delivered by the endpoint.

See Also:

ServiceType

domainType

public final DomainType domainType()

The type of the domain.

If the service returns an enum value that is not available in the current SDK version, domainType will return DomainType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainTypeAsString().

Returns:

The type of the domain.

See Also:

DomainType

domainTypeAsString

public final String domainTypeAsString()

The type of the domain.

If the service returns an enum value that is not available in the current SDK version, domainType will return DomainType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainTypeAsString().

Returns:

The type of the domain.

See Also:

DomainType

lastStatusChangeDate

public final Instant lastStatusChangeDate()

The date and time the domain configuration's status was last changed.

Returns:

The date and time the domain configuration's status was last changed.

toBuilder

public DescribeDomainConfigurationResponse.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<DescribeDomainConfigurationResponse.Builder,DescribeDomainConfigurationResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeDomainConfigurationResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

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