Class CreateTemplateResponse

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateTemplateResponse.Builder,CreateTemplateResponse>

@Generated("software.amazon.awssdk:codegen") public final class CreateTemplateResponse extends NetworkSecurityManagerResponse implements ToCopyableBuilder<CreateTemplateResponse.Builder,CreateTemplateResponse>
  • Method Details

    • templateId

      public final String templateId()

      The service-generated id of the template.

      Returns:
      The service-generated id of the template.
    • templateArn

      public final String templateArn()

      The Amazon Resource Name (ARN) of the template.

      Returns:
      The Amazon Resource Name (ARN) of the template.
    • templateName

      public final String templateName()

      The name of the template.

      Returns:
      The name of the template.
    • templateDescription

      public final String templateDescription()

      A description of the template.

      Returns:
      A description of the template.
    • status

      public final EntityStatus status()

      The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).

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

      Returns:
      The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
      See Also:
    • statusAsString

      public final String statusAsString()

      The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).

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

      Returns:
      The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
      See Also:
    • version

      public final String version()

      The version of the resource.

      Returns:
      The version of the resource.
    • hasAssociatedRuleList

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

      public final List<AssociatedRule> associatedRuleList()

      The rules associated with the 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 hasAssociatedRuleList() method.

      Returns:
      The rules associated with the template.
    • updateToken

      public final String updateToken()

      A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.

      Returns:
      A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
    • isSnapshot

      public final Boolean isSnapshot()

      Specifies whether the resource is a snapshot of a published version.

      Returns:
      Specifies whether the resource is a snapshot of a published version.
    • hasPublishedVersion

      public final Boolean hasPublishedVersion()

      Specifies whether a published version of the resource exists.

      Returns:
      Specifies whether a published version of the resource exists.
    • firewallType

      public final TemplateFirewallType firewallType()

      The firewall type associated with the resource.

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

      Returns:
      The firewall type associated with the resource.
      See Also:
    • firewallTypeAsString

      public final String firewallTypeAsString()

      The firewall type associated with the resource.

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

      Returns:
      The firewall type associated with the resource.
      See Also:
    • updatedAt

      public final Instant updatedAt()

      The time when the resource was last updated.

      Returns:
      The time when the resource was last updated.
    • toBuilder

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

      public static CreateTemplateResponse.Builder builder()
    • serializableBuilderClass

      public static Class<? extends CreateTemplateResponse.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.
    • sdkFieldNameToField

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