Class CreateDomainConfigurationRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.iot.model.IotRequest
-
- software.amazon.awssdk.services.iot.model.CreateDomainConfigurationRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateDomainConfigurationRequest.Builder,CreateDomainConfigurationRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDomainConfigurationRequest extends IotRequest implements ToCopyableBuilder<CreateDomainConfigurationRequest.Builder,CreateDomainConfigurationRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CreateDomainConfigurationRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AuthorizerConfig
authorizerConfig()
An object that specifies the authorization service for a domain.static CreateDomainConfigurationRequest.Builder
builder()
String
domainConfigurationName()
The name of the domain configuration.String
domainName()
The name of the domain.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasServerCertificateArns()
For responses, this returns true if the service returned a value for the ServerCertificateArns property.boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.List<SdkField<?>>
sdkFields()
static Class<? extends CreateDomainConfigurationRequest.Builder>
serializableBuilderClass()
List<String>
serverCertificateArns()
The ARNs of the certificates that IoT passes to the device during the TLS handshake.ServiceType
serviceType()
The type of service delivered by the endpoint.String
serviceTypeAsString()
The type of service delivered by the endpoint.List<Tag>
tags()
Metadata which can be used to manage the domain configuration.TlsConfig
tlsConfig()
An object that specifies the TLS configuration for a domain.CreateDomainConfigurationRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
validationCertificateArn()
The certificate used to validate the server certificate and prove domain name ownership.-
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
-
domainConfigurationName
public final String domainConfigurationName()
The name of the domain configuration. This value must be unique to a region.
- Returns:
- The name of the domain configuration. This value must be unique to a region.
-
domainName
public final String domainName()
The name of the domain.
- Returns:
- The name of the domain.
-
hasServerCertificateArns
public final boolean hasServerCertificateArns()
For responses, this returns true if the service returned a value for the ServerCertificateArns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
serverCertificateArns
public final List<String> serverCertificateArns()
The ARNs of the certificates that IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for Amazon Web Services-managed domains.
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
hasServerCertificateArns()
method.- Returns:
- The ARNs of the certificates that IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for Amazon Web Services-managed domains.
-
validationCertificateArn
public final String validationCertificateArn()
The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. This value is not required for Amazon Web Services-managed domains.
- Returns:
- The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. This value is not required for Amazon Web Services-managed domains.
-
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.
-
serviceType
public final ServiceType serviceType()
The type of service delivered by the endpoint.
Amazon Web Services IoT Core currently supports only the
DATA
service type.If the service returns an enum value that is not available in the current SDK version,
serviceType
will returnServiceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromserviceTypeAsString()
.- Returns:
- The type of service delivered by the endpoint.
Amazon Web Services IoT Core currently supports only the
DATA
service type. - See Also:
ServiceType
-
serviceTypeAsString
public final String serviceTypeAsString()
The type of service delivered by the endpoint.
Amazon Web Services IoT Core currently supports only the
DATA
service type.If the service returns an enum value that is not available in the current SDK version,
serviceType
will returnServiceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromserviceTypeAsString()
.- Returns:
- The type of service delivered by the endpoint.
Amazon Web Services IoT Core currently supports only the
DATA
service type. - See Also:
ServiceType
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
tags
public final List<Tag> tags()
Metadata which can be used to manage the domain configuration.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
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
hasTags()
method.- Returns:
- Metadata which can be used to manage the domain configuration.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
-
tlsConfig
public final TlsConfig tlsConfig()
An object that specifies the TLS configuration for a domain.
- Returns:
- An object that specifies the TLS configuration for a domain.
-
toBuilder
public CreateDomainConfigurationRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateDomainConfigurationRequest.Builder,CreateDomainConfigurationRequest>
- Specified by:
toBuilder
in classIotRequest
-
builder
public static CreateDomainConfigurationRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateDomainConfigurationRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-