Package software.amazon.awssdk.services.bedrock.model

Class CreateModelInvocationJobRequest

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

  • Method Details

    • jobName

      public final String jobName()

      A name to give the batch inference job.

      Returns:
      A name to give the batch inference job.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.

      Returns:
      The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.

    • clientRequestToken

      public final String clientRequestToken()

      A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not 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 this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    • modelId

      public final String modelId()

      The unique identifier of the foundation model to use for the batch inference job.

      Returns:
      The unique identifier of the foundation model to use for the batch inference job.

    • inputDataConfig

      public final ModelInvocationJobInputDataConfig inputDataConfig()

      Details about the location of the input to the batch inference job.

      Returns:
      Details about the location of the input to the batch inference job.

    • outputDataConfig

      public final ModelInvocationJobOutputDataConfig outputDataConfig()

      Details about the location of the output of the batch inference job.

      Returns:
      Details about the location of the output of the batch inference job.

    • timeoutDurationInHours

      public final Integer timeoutDurationInHours()

      The number of hours after which to force the batch inference job to time out.

      Returns:
      The number of hours after which to force the batch inference job to time out.

    • 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 List<Tag> tags()

      Any tags to associate with the batch inference job. For more information, see Tagging Amazon Bedrock resources.

      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:
      Any tags to associate with the batch inference job. For more information, see Tagging Amazon Bedrock resources.

    • toBuilder

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

    • builder

      public static CreateModelInvocationJobRequest.Builder builder()

    • serializableBuilderClass

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