Class GetModelInvocationJobResponse

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

  • Method Details

    • jobArn

      public final String jobArn()

      The Amazon Resource Name (ARN) of the batch inference job.

      Returns:
      The Amazon Resource Name (ARN) of the batch inference job.

    • jobName

      public final String jobName()

      The name of the batch inference job.

      Returns:
      The name of the batch inference job.

    • modelId

      public final String modelId()

      The unique identifier of the foundation model used for model inference.

      Returns:
      The unique identifier of the foundation model used for model 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.

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

    • status

      public final ModelInvocationJobStatus status()

      The status of the batch inference job.

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

      Returns:
      The status of the batch inference job.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the batch inference job.

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

      Returns:
      The status of the batch inference job.
      See Also:

    • message

      public final String message()

      If the batch inference job failed, this field contains a message describing why the job failed.

      Returns:
      If the batch inference job failed, this field contains a message describing why the job failed.

    • submitTime

      public final Instant submitTime()

      The time at which the batch inference job was submitted.

      Returns:
      The time at which the batch inference job was submitted.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The time at which the batch inference job was last modified.

      Returns:
      The time at which the batch inference job was last modified.

    • endTime

      public final Instant endTime()

      The time at which the batch inference job ended.

      Returns:
      The time at which the batch inference job ended.

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

    • vpcConfig

      public final VpcConfig vpcConfig()

      The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.

      Returns:
      The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.

    • timeoutDurationInHours

      public final Integer timeoutDurationInHours()

      The number of hours after which batch inference job was set to time out.

      Returns:
      The number of hours after which batch inference job was set to time out.

    • jobExpirationTime

      public final Instant jobExpirationTime()

      The time at which the batch inference job times or timed out.

      Returns:
      The time at which the batch inference job times or timed out.

    • toBuilder

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

    • builder

      public static GetModelInvocationJobResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.