Class StartPolicyGenerationRequest

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

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

    • policyEngineId

      public final String policyEngineId()

      The identifier of the policy engine that provides the context for policy generation. This engine's schema and tool context are used to ensure generated policies are valid and applicable.

      Returns:
      The identifier of the policy engine that provides the context for policy generation. This engine's schema and tool context are used to ensure generated policies are valid and applicable.
    • resource

      public final Resource resource()

      The resource information that provides context for policy generation. This helps the AI understand the target resources and generate appropriate access control rules.

      Returns:
      The resource information that provides context for policy generation. This helps the AI understand the target resources and generate appropriate access control rules.
    • content

      public final Content content()

      The natural language description of the desired policy behavior. This content is processed by AI to generate corresponding Cedar policy statements that match the described intent.

      Returns:
      The natural language description of the desired policy behavior. This content is processed by AI to generate corresponding Cedar policy statements that match the described intent.
    • name

      public final String name()

      A customer-assigned name for the policy generation request. This helps track and identify generation operations, especially when running multiple generations simultaneously.

      Returns:
      A customer-assigned name for the policy generation request. This helps track and identify generation operations, especially when running multiple generations simultaneously.
    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier to ensure the idempotency of the request. The AWS SDK automatically generates this token, so you don't need to provide it in most cases. If you retry a request with the same client token, the service returns the same response without starting a duplicate generation.

      Returns:
      A unique, case-sensitive identifier to ensure the idempotency of the request. The AWS SDK automatically generates this token, so you don't need to provide it in most cases. If you retry a request with the same client token, the service returns the same response without starting a duplicate generation.
    • 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<StartPolicyGenerationRequest.Builder,StartPolicyGenerationRequest>
      Specified by:
      toBuilder in class BedrockAgentCoreControlRequest
      Returns:
      a builder for type T
    • builder

      public static StartPolicyGenerationRequest.Builder builder()
    • serializableBuilderClass

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