Package software.amazon.awssdk.services.swf.model

Class RegisterDomainRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.swf.model.SwfRequest

software.amazon.awssdk.services.swf.model.RegisterDomainRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RegisterDomainRequest.Builder,RegisterDomainRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RegisterDomainRequest.Builder

Method Summary

Modifier and Type	Method	Description
static RegisterDomainRequest.Builder	builder()
String	description()	A text description of the domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	name()	Name of the domain to register.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RegisterDomainRequest.Builder>	serializableBuilderClass()
List<ResourceTag>	tags()	Tags to be added when registering a domain.
RegisterDomainRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	workflowExecutionRetentionPeriodInDays()	The duration (in days) that records and histories of workflow executions on the domain should be kept by the service.

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

name

public final String name()

Name of the domain to register. The name must be unique in the region that the domain is registered in.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -Ÿ). Also, it must not be the literal string arn.

Returns:

Name of the domain to register. The name must be unique in the region that the domain is registered in.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters ( - | -Ÿ). Also, it must not be the literal string arn.

description

public final String description()

A text description of the domain.

Returns:

A text description of the domain.

workflowExecutionRetentionPeriodInDays

public final String workflowExecutionRetentionPeriodInDays()

The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution isn't available in the results of visibility calls.

If you pass the value NONE or 0 (zero), then the workflow execution history isn't retained. As soon as the workflow execution completes, the execution record and its history are deleted.

The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.

Returns:

The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution isn't available in the results of visibility calls.

If you pass the value NONE or 0 (zero), then the workflow execution history isn't retained. As soon as the workflow execution completes, the execution record and its history are deleted.

The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.

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

tags

public final List<ResourceTag> tags()

Tags to be added when registering a domain.

Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

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:

Tags to be added when registering a domain.

Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

toBuilder

public RegisterDomainRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RegisterDomainRequest.Builder,RegisterDomainRequest>

Specified by:

toBuilder in class SwfRequest

builder

public static RegisterDomainRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo