Class CreatePolicyResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.networksecuritymanager.model.NetworkSecurityManagerResponse
software.amazon.awssdk.services.networksecuritymanager.model.CreatePolicyResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreatePolicyResponse.Builder,CreatePolicyResponse>
@Generated("software.amazon.awssdk:codegen") public final class CreatePolicyResponse extends NetworkSecurityManagerResponse implements ToCopyableBuilder<CreatePolicyResponse.Builder,CreatePolicyResponse>

  • Method Details

    • policyId

      public final String policyId()

      The service-generated id of the policy.

      Returns:
      The service-generated id of the policy.

    • policyArn

      public final String policyArn()

      The Amazon Resource Name (ARN) of the policy.

      Returns:
      The Amazon Resource Name (ARN) of the policy.

    • policyName

      public final String policyName()

      The name of the policy.

      Returns:
      The name of the policy.

    • policyDescription

      public final String policyDescription()

      A description of the policy.

      Returns:
      A description of the policy.

    • 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:

    • priority

      public final Integer priority()

      The priority of the resource. A lower number indicates a higher priority.

      Returns:
      The priority of the resource. A lower number indicates a higher priority.

    • hasAssociatedTemplateAndRuleList

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

    • associatedTemplateAndRuleList

      public final List<AssociatedTemplateOrRule> associatedTemplateAndRuleList()

      The templates and rules associated with the policy. For AWS WAF policies, this list contains 1 to 100 templates or rules, of which at most 2 can be templates. For AWS Shield Advanced policies, this list is empty.

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

      Returns:
      The templates and rules associated with the policy. For AWS WAF policies, this list contains 1 to 100 templates or rules, of which at most 2 can be templates. For AWS Shield Advanced policies, this list is empty.

    • version

      public final String version()

      The version of the resource.

      Returns:
      The version of the resource.

    • 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 PolicyFirewallType 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 PolicyFirewallType.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 PolicyFirewallType.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:

    • policyConfiguration

      public final PolicyConfiguration policyConfiguration()

      The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.

      Returns:
      The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.

    • updatedAt

      public final Instant updatedAt()

      The time when the resource was last updated.

      Returns:
      The time when the resource was last updated.

    • toBuilder

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

    • builder

      public static CreatePolicyResponse.Builder builder()

    • serializableBuilderClass

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