Class CreateTemplateRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.connectcases.model.ConnectCasesRequest
software.amazon.awssdk.services.connectcases.model.CreateTemplateRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateTemplateRequest.Builder,CreateTemplateRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateTemplateRequest extends ConnectCasesRequest implements ToCopyableBuilder<CreateTemplateRequest.Builder,CreateTemplateRequest>

  • Method Details

    • domainId

      public final String domainId()

      The unique identifier of the Cases domain.

      Returns:
      The unique identifier of the Cases domain.

    • name

      public final String name()

      A name for the template. It must be unique per domain.

      Returns:
      A name for the template. It must be unique per domain.

    • description

      public final String description()

      A brief description of the template.

      Returns:
      A brief description of the template.

    • layoutConfiguration

      public final LayoutConfiguration layoutConfiguration()

      Configuration of layouts associated to the template.

      Returns:
      Configuration of layouts associated to the template.

    • hasRequiredFields

      public final boolean hasRequiredFields()
      For responses, this returns true if the service returned a value for the RequiredFields 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.

    • requiredFields

      public final List<RequiredField> requiredFields()

      A list of fields that must contain a value for a case to be successfully created with this template.

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

      Returns:
      A list of fields that must contain a value for a case to be successfully created with this template.

    • status

      public final TemplateStatus status()

      The status of the template.

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

      Returns:
      The status of the template.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the template.

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

      Returns:
      The status of the template.
      See Also:

    • hasRules

      public final boolean hasRules()
      For responses, this returns true if the service returned a value for the Rules 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.

    • rules

      public final List<TemplateRule> rules()

      A list of case rules (also known as case field conditions) on a template.

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

      Returns:
      A list of case rules (also known as case field conditions) on a template.

    • toBuilder

      public CreateTemplateRequest.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<CreateTemplateRequest.Builder,CreateTemplateRequest>
      Specified by:
      toBuilder in class ConnectCasesRequest
      Returns:
      a builder for type T

    • builder

      public static CreateTemplateRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateTemplateRequest.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)
      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: 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 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.