Class CreateConfigurationBundleRequest

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.CreateConfigurationBundleRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateConfigurationBundleRequest.Builder,CreateConfigurationBundleRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateConfigurationBundleRequest extends BedrockAgentCoreControlRequest implements ToCopyableBuilder<CreateConfigurationBundleRequest.Builder,CreateConfigurationBundleRequest>

  • Method Details

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

    • bundleName

      public final String bundleName()

      The name for the configuration bundle. Names must be unique within your account.

      Returns:
      The name for the configuration bundle. Names must be unique within your account.

    • description

      public final String description()

      The description for the configuration bundle.

      Returns:
      The description for the configuration bundle.

    • hasComponents

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

    • components

      public final Map<String,ComponentConfiguration> components()

      A map of component identifiers to their configurations. Each component represents a configurable element within the bundle.

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

      Returns:
      A map of component identifiers to their configurations. Each component represents a configurable element within the bundle.

    • branchName

      public final String branchName()

      The branch name for version tracking. Defaults to mainline if not specified.

      Returns:
      The branch name for version tracking. Defaults to mainline if not specified.

    • commitMessage

      public final String commitMessage()

      A commit message describing the initial version of the configuration bundle.

      Returns:
      A commit message describing the initial version of the configuration bundle.

    • createdBy

      public final VersionCreatedBySource createdBy()

      The source that created this version, including the source name and optional ARN.

      Returns:
      The source that created this version, including the source name and optional ARN.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      A map of tag keys and values to assign to the configuration bundle. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

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

      Returns:
      A map of tag keys and values to assign to the configuration bundle. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

    • toBuilder

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

    • builder

      public static CreateConfigurationBundleRequest.Builder builder()

    • serializableBuilderClass

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