Package software.amazon.awssdk.services.iot.model

Interface DescribeDomainConfigurationResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeDomainConfigurationResponse.Builder,DescribeDomainConfigurationResponse>, IotResponse.Builder, SdkBuilder<DescribeDomainConfigurationResponse.Builder,DescribeDomainConfigurationResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeDomainConfigurationResponse

public static interface DescribeDomainConfigurationResponse.Builder
extends IotResponse.Builder, SdkPojo, CopyableBuilder<DescribeDomainConfigurationResponse.Builder,DescribeDomainConfigurationResponse>

Method Summary

Modifier and Type	Method	Description
DescribeDomainConfigurationResponse.Builder	applicationProtocol(String applicationProtocol)	An enumerated string that specifies the application-layer protocol.
DescribeDomainConfigurationResponse.Builder	applicationProtocol(ApplicationProtocol applicationProtocol)	An enumerated string that specifies the application-layer protocol.
DescribeDomainConfigurationResponse.Builder	authenticationType(String authenticationType)	An enumerated string that specifies the authentication type.
DescribeDomainConfigurationResponse.Builder	authenticationType(AuthenticationType authenticationType)	An enumerated string that specifies the authentication type.
default DescribeDomainConfigurationResponse.Builder	authorizerConfig(Consumer<AuthorizerConfig.Builder> authorizerConfig)	An object that specifies the authorization service for a domain.
DescribeDomainConfigurationResponse.Builder	authorizerConfig(AuthorizerConfig authorizerConfig)	An object that specifies the authorization service for a domain.
default DescribeDomainConfigurationResponse.Builder	clientCertificateConfig(Consumer<ClientCertificateConfig.Builder> clientCertificateConfig)	An object that specifies the client certificate configuration for a domain.
DescribeDomainConfigurationResponse.Builder	clientCertificateConfig(ClientCertificateConfig clientCertificateConfig)	An object that specifies the client certificate configuration for a domain.
DescribeDomainConfigurationResponse.Builder	domainConfigurationArn(String domainConfigurationArn)	The ARN of the domain configuration.
DescribeDomainConfigurationResponse.Builder	domainConfigurationName(String domainConfigurationName)	The name of the domain configuration.
DescribeDomainConfigurationResponse.Builder	domainConfigurationStatus(String domainConfigurationStatus)	A Boolean value that specifies the current state of the domain configuration.
DescribeDomainConfigurationResponse.Builder	domainConfigurationStatus(DomainConfigurationStatus domainConfigurationStatus)	A Boolean value that specifies the current state of the domain configuration.
DescribeDomainConfigurationResponse.Builder	domainName(String domainName)	The name of the domain.
DescribeDomainConfigurationResponse.Builder	domainType(String domainType)	The type of the domain.
DescribeDomainConfigurationResponse.Builder	domainType(DomainType domainType)	The type of the domain.
DescribeDomainConfigurationResponse.Builder	lastStatusChangeDate(Instant lastStatusChangeDate)	The date and time the domain configuration's status was last changed.
default DescribeDomainConfigurationResponse.Builder	serverCertificateConfig(Consumer<ServerCertificateConfig.Builder> serverCertificateConfig)	The server certificate configuration.
DescribeDomainConfigurationResponse.Builder	serverCertificateConfig(ServerCertificateConfig serverCertificateConfig)	The server certificate configuration.
DescribeDomainConfigurationResponse.Builder	serverCertificates(Collection<ServerCertificateSummary> serverCertificates)	A list containing summary information about the server certificate included in the domain configuration.
DescribeDomainConfigurationResponse.Builder	serverCertificates(Consumer<ServerCertificateSummary.Builder>... serverCertificates)	A list containing summary information about the server certificate included in the domain configuration.
DescribeDomainConfigurationResponse.Builder	serverCertificates(ServerCertificateSummary... serverCertificates)	A list containing summary information about the server certificate included in the domain configuration.
DescribeDomainConfigurationResponse.Builder	serviceType(String serviceType)	The type of service delivered by the endpoint.
DescribeDomainConfigurationResponse.Builder	serviceType(ServiceType serviceType)	The type of service delivered by the endpoint.
default DescribeDomainConfigurationResponse.Builder	tlsConfig(Consumer<TlsConfig.Builder> tlsConfig)	An object that specifies the TLS configuration for a domain.
DescribeDomainConfigurationResponse.Builder	tlsConfig(TlsConfig tlsConfig)	An object that specifies the TLS configuration for a domain.

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

copy

Methods inherited from interface software.amazon.awssdk.services.iot.model.IotResponse.Builder

build, responseMetadata, responseMetadata

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

domainConfigurationName

DescribeDomainConfigurationResponse.Builder domainConfigurationName(String domainConfigurationName)

The name of the domain configuration.

Parameters:

domainConfigurationName - The name of the domain configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

domainConfigurationArn

DescribeDomainConfigurationResponse.Builder domainConfigurationArn(String domainConfigurationArn)

The ARN of the domain configuration.

Parameters:

domainConfigurationArn - The ARN of the domain configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

domainName

DescribeDomainConfigurationResponse.Builder domainName(String domainName)

The name of the domain.

Parameters:

domainName - The name of the domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

serverCertificates

DescribeDomainConfigurationResponse.Builder serverCertificates(Collection<ServerCertificateSummary> serverCertificates)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

serverCertificates

DescribeDomainConfigurationResponse.Builder serverCertificates(ServerCertificateSummary... serverCertificates)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

serverCertificates

DescribeDomainConfigurationResponse.Builder serverCertificates(Consumer<ServerCertificateSummary.Builder>... serverCertificates)

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

This is a convenience method that creates an instance of the ServerCertificateSummary.Builder avoiding the need to create one manually via ServerCertificateSummary.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #serverCertificates(List).

Parameters:

serverCertificates - a consumer that will call methods on ServerCertificateSummary.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#serverCertificates(java.util.Collection)

authorizerConfig

DescribeDomainConfigurationResponse.Builder authorizerConfig(AuthorizerConfig authorizerConfig)

An object that specifies the authorization service for a domain.

Parameters:

authorizerConfig - An object that specifies the authorization service for a domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

authorizerConfig

default DescribeDomainConfigurationResponse.Builder authorizerConfig(Consumer<AuthorizerConfig.Builder> authorizerConfig)

An object that specifies the authorization service for a domain.

This is a convenience method that creates an instance of the AuthorizerConfig.Builder avoiding the need to create one manually via AuthorizerConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to authorizerConfig(AuthorizerConfig).

Parameters:

authorizerConfig - a consumer that will call methods on AuthorizerConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

authorizerConfig(AuthorizerConfig)

domainConfigurationStatus

DescribeDomainConfigurationResponse.Builder domainConfigurationStatus(String domainConfigurationStatus)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DomainConfigurationStatus, DomainConfigurationStatus

domainConfigurationStatus

DescribeDomainConfigurationResponse.Builder domainConfigurationStatus(DomainConfigurationStatus domainConfigurationStatus)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DomainConfigurationStatus, DomainConfigurationStatus

serviceType

DescribeDomainConfigurationResponse.Builder serviceType(String serviceType)

The type of service delivered by the endpoint.

Parameters:

serviceType - The type of service delivered by the endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServiceType, ServiceType

serviceType

DescribeDomainConfigurationResponse.Builder serviceType(ServiceType serviceType)

The type of service delivered by the endpoint.

Parameters:

serviceType - The type of service delivered by the endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServiceType, ServiceType

domainType

DescribeDomainConfigurationResponse.Builder domainType(String domainType)

The type of the domain.

Parameters:

domainType - The type of the domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DomainType, DomainType

domainType

DescribeDomainConfigurationResponse.Builder domainType(DomainType domainType)

The type of the domain.

Parameters:

domainType - The type of the domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DomainType, DomainType

lastStatusChangeDate

DescribeDomainConfigurationResponse.Builder lastStatusChangeDate(Instant lastStatusChangeDate)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tlsConfig

DescribeDomainConfigurationResponse.Builder tlsConfig(TlsConfig tlsConfig)

An object that specifies the TLS configuration for a domain.

Parameters:

tlsConfig - An object that specifies the TLS configuration for a domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

tlsConfig

default DescribeDomainConfigurationResponse.Builder tlsConfig(Consumer<TlsConfig.Builder> tlsConfig)

An object that specifies the TLS configuration for a domain.

This is a convenience method that creates an instance of the TlsConfig.Builder avoiding the need to create one manually via TlsConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tlsConfig(TlsConfig).

Parameters:

tlsConfig - a consumer that will call methods on TlsConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

tlsConfig(TlsConfig)

serverCertificateConfig

DescribeDomainConfigurationResponse.Builder serverCertificateConfig(ServerCertificateConfig serverCertificateConfig)

The server certificate configuration.

Parameters:

serverCertificateConfig - The server certificate configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

serverCertificateConfig

default DescribeDomainConfigurationResponse.Builder serverCertificateConfig(Consumer<ServerCertificateConfig.Builder> serverCertificateConfig)

The server certificate configuration.

This is a convenience method that creates an instance of the ServerCertificateConfig.Builder avoiding the need to create one manually via ServerCertificateConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to serverCertificateConfig(ServerCertificateConfig).

Parameters:

serverCertificateConfig - a consumer that will call methods on ServerCertificateConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

serverCertificateConfig(ServerCertificateConfig)

authenticationType

DescribeDomainConfigurationResponse.Builder authenticationType(String authenticationType)

An enumerated string that specifies the authentication type.

• CUSTOM_AUTH_X509 - Use custom authentication and authorization with additional details from the X.509 client certificate.

• CUSTOM_AUTH - Use custom authentication and authorization. For more information, see Custom authentication and authorization.

• AWS_X509 - Use X.509 client certificates without custom authentication and authorization. For more information, see X.509 client certificates.

• AWS_SIGV4 - Use Amazon Web Services Signature Version 4. For more information, see IAM users, groups, and roles.

• DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see Device communication protocols.

Parameters:

authenticationType - An enumerated string that specifies the authentication type.

• CUSTOM_AUTH_X509 - Use custom authentication and authorization with additional details from the X.509 client certificate.

• CUSTOM_AUTH - Use custom authentication and authorization. For more information, see Custom authentication and authorization.

• AWS_X509 - Use X.509 client certificates without custom authentication and authorization. For more information, see X.509 client certificates.

• AWS_SIGV4 - Use Amazon Web Services Signature Version 4. For more information, see IAM users, groups, and roles.

• DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see Device communication protocols.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthenticationType, AuthenticationType

authenticationType

DescribeDomainConfigurationResponse.Builder authenticationType(AuthenticationType authenticationType)

An enumerated string that specifies the authentication type.

• CUSTOM_AUTH_X509 - Use custom authentication and authorization with additional details from the X.509 client certificate.

• CUSTOM_AUTH - Use custom authentication and authorization. For more information, see Custom authentication and authorization.

• AWS_X509 - Use X.509 client certificates without custom authentication and authorization. For more information, see X.509 client certificates.

• AWS_SIGV4 - Use Amazon Web Services Signature Version 4. For more information, see IAM users, groups, and roles.

• DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see Device communication protocols.

Parameters:

authenticationType - An enumerated string that specifies the authentication type.

• CUSTOM_AUTH_X509 - Use custom authentication and authorization with additional details from the X.509 client certificate.

• CUSTOM_AUTH - Use custom authentication and authorization. For more information, see Custom authentication and authorization.

• AWS_X509 - Use X.509 client certificates without custom authentication and authorization. For more information, see X.509 client certificates.

• AWS_SIGV4 - Use Amazon Web Services Signature Version 4. For more information, see IAM users, groups, and roles.

• DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see Device communication protocols.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthenticationType, AuthenticationType

applicationProtocol

DescribeDomainConfigurationResponse.Builder applicationProtocol(String applicationProtocol)

An enumerated string that specifies the application-layer protocol.

• SECURE_MQTT - MQTT over TLS.

• MQTT_WSS - MQTT over WebSocket.

• HTTPS - HTTP over TLS.

• DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. For more information, see Device communication protocols.

Parameters:

applicationProtocol - An enumerated string that specifies the application-layer protocol.

• SECURE_MQTT - MQTT over TLS.

• MQTT_WSS - MQTT over WebSocket.

• HTTPS - HTTP over TLS.

• DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. For more information, see Device communication protocols.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ApplicationProtocol, ApplicationProtocol

applicationProtocol

DescribeDomainConfigurationResponse.Builder applicationProtocol(ApplicationProtocol applicationProtocol)

An enumerated string that specifies the application-layer protocol.

• SECURE_MQTT - MQTT over TLS.

• MQTT_WSS - MQTT over WebSocket.

• HTTPS - HTTP over TLS.

• DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. For more information, see Device communication protocols.

Parameters:

applicationProtocol - An enumerated string that specifies the application-layer protocol.

• SECURE_MQTT - MQTT over TLS.

• MQTT_WSS - MQTT over WebSocket.

• HTTPS - HTTP over TLS.

• DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. For more information, see Device communication protocols.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ApplicationProtocol, ApplicationProtocol

clientCertificateConfig

DescribeDomainConfigurationResponse.Builder clientCertificateConfig(ClientCertificateConfig clientCertificateConfig)

An object that specifies the client certificate configuration for a domain.

Parameters:

clientCertificateConfig - An object that specifies the client certificate configuration for a domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientCertificateConfig

default DescribeDomainConfigurationResponse.Builder clientCertificateConfig(Consumer<ClientCertificateConfig.Builder> clientCertificateConfig)

An object that specifies the client certificate configuration for a domain.

This is a convenience method that creates an instance of the ClientCertificateConfig.Builder avoiding the need to create one manually via ClientCertificateConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to clientCertificateConfig(ClientCertificateConfig).

Parameters:

clientCertificateConfig - a consumer that will call methods on ClientCertificateConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

clientCertificateConfig(ClientCertificateConfig)