Class CreateRegistryRequest

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

  • Method Details

    • name

      public final String name()

      The name of the registry. The name must be unique within your account and can contain alphanumeric characters and underscores.

      Returns:
      The name of the registry. The name must be unique within your account and can contain alphanumeric characters and underscores.

    • description

      public final String description()

      A description of the registry.

      Returns:
      A description of the registry.

    • authorizerType

      public final RegistryAuthorizerType authorizerType()

      The type of authorizer to use for the registry. This controls the authorization method for the Search and Invoke APIs used by consumers, and does not affect the standard CRUDL APIs for registry and registry record management used by administrators.

      • CUSTOM_JWT - Authorize with a bearer token.

      • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

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

      Returns:
      The type of authorizer to use for the registry. This controls the authorization method for the Search and Invoke APIs used by consumers, and does not affect the standard CRUDL APIs for registry and registry record management used by administrators.

      • CUSTOM_JWT - Authorize with a bearer token.

      • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

      See Also:

    • authorizerTypeAsString

      public final String authorizerTypeAsString()

      The type of authorizer to use for the registry. This controls the authorization method for the Search and Invoke APIs used by consumers, and does not affect the standard CRUDL APIs for registry and registry record management used by administrators.

      • CUSTOM_JWT - Authorize with a bearer token.

      • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

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

      Returns:
      The type of authorizer to use for the registry. This controls the authorization method for the Search and Invoke APIs used by consumers, and does not affect the standard CRUDL APIs for registry and registry record management used by administrators.

      • CUSTOM_JWT - Authorize with a bearer token.

      • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

      See Also:

    • authorizerConfiguration

      public final AuthorizerConfiguration authorizerConfiguration()

      The authorizer configuration for the registry. Required if authorizerType is CUSTOM_JWT . For details, see the AuthorizerConfiguration data type.

      Returns:
      The authorizer configuration for the registry. Required if authorizerType is CUSTOM_JWT. For details, see the AuthorizerConfiguration data type.

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

      Returns:
      A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

    • approvalConfiguration

      public final ApprovalConfiguration approvalConfiguration()

      The approval configuration for registry records. Controls whether records require explicit approval before becoming active. See the ApprovalConfiguration data type for supported configuration options.

      Returns:
      The approval configuration for registry records. Controls whether records require explicit approval before becoming active. See the ApprovalConfiguration data type for supported configuration options.

    • toBuilder

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

    • builder

      public static CreateRegistryRequest.Builder builder()

    • serializableBuilderClass

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