Class ApiGatewayToolOverride

java.lang.Object
software.amazon.awssdk.services.bedrockagentcorecontrol.model.ApiGatewayToolOverride
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ApiGatewayToolOverride.Builder,ApiGatewayToolOverride>
@Generated("software.amazon.awssdk:codegen") public final class ApiGatewayToolOverride extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ApiGatewayToolOverride.Builder,ApiGatewayToolOverride>

Settings to override configurations for a tool.

See Also:

  • Method Details

    • name

      public final String name()

      The name of tool. Identifies the tool in the Model Context Protocol.

      Returns:
      The name of tool. Identifies the tool in the Model Context Protocol.

    • description

      public final String description()

      The description of the tool. Provides information about the purpose and usage of the tool. If not provided, uses the description from the API's OpenAPI specification.

      Returns:
      The description of the tool. Provides information about the purpose and usage of the tool. If not provided, uses the description from the API's OpenAPI specification.

    • path

      public final String path()

      Resource path in the REST API (e.g., /pets). Must explicitly match an existing path in the REST API.

      Returns:
      Resource path in the REST API (e.g., /pets). Must explicitly match an existing path in the REST API.

    • method

      public final RestApiMethod method()

      The HTTP method to expose for the specified path.

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

      Returns:
      The HTTP method to expose for the specified path.
      See Also:

    • methodAsString

      public final String methodAsString()

      The HTTP method to expose for the specified path.

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

      Returns:
      The HTTP method to expose for the specified path.
      See Also:

    • toBuilder

      public ApiGatewayToolOverride.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<ApiGatewayToolOverride.Builder,ApiGatewayToolOverride>
      Returns:
      a builder for type T

    • builder

      public static ApiGatewayToolOverride.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ApiGatewayToolOverride.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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