Package software.amazon.awssdk.services.sagemaker.model

Interface DescribeCompilationJobResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeCompilationJobResponse.Builder,DescribeCompilationJobResponse>, SageMakerResponse.Builder, SdkBuilder<DescribeCompilationJobResponse.Builder,DescribeCompilationJobResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeCompilationJobResponse
public static interface DescribeCompilationJobResponse.Builder extends SageMakerResponse.Builder, SdkPojo, CopyableBuilder<DescribeCompilationJobResponse.Builder,DescribeCompilationJobResponse>

  • Method Details

    • compilationJobName

      DescribeCompilationJobResponse.Builder compilationJobName(String compilationJobName)

      The name of the model compilation job.

      Parameters:
      compilationJobName - The name of the model compilation job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • compilationJobArn

      DescribeCompilationJobResponse.Builder compilationJobArn(String compilationJobArn)

      The Amazon Resource Name (ARN) of the model compilation job.

      Parameters:
      compilationJobArn - The Amazon Resource Name (ARN) of the model compilation job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • compilationJobStatus

      DescribeCompilationJobResponse.Builder compilationJobStatus(String compilationJobStatus)

      The status of the model compilation job.

      Parameters:
      compilationJobStatus - The status of the model compilation job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • compilationJobStatus

      DescribeCompilationJobResponse.Builder compilationJobStatus(CompilationJobStatus compilationJobStatus)

      The status of the model compilation job.

      Parameters:
      compilationJobStatus - The status of the model compilation job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • compilationStartTime

      DescribeCompilationJobResponse.Builder compilationStartTime(Instant compilationStartTime)

      The time when the model compilation job started the CompilationJob instances.

      You are billed for the time between this timestamp and the timestamp in the CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container.

      Parameters:
      compilationStartTime - The time when the model compilation job started the CompilationJob instances.

      You are billed for the time between this timestamp and the timestamp in the CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • compilationEndTime

      DescribeCompilationJobResponse.Builder compilationEndTime(Instant compilationEndTime)

      The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.

      Parameters:
      compilationEndTime - The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stoppingCondition

      DescribeCompilationJobResponse.Builder stoppingCondition(StoppingCondition stoppingCondition)

      Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

      Parameters:
      stoppingCondition - Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stoppingCondition

      default DescribeCompilationJobResponse.Builder stoppingCondition(Consumer<StoppingCondition.Builder> stoppingCondition)

      Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

      This is a convenience method that creates an instance of the StoppingCondition.Builder avoiding the need to create one manually via StoppingCondition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to stoppingCondition(StoppingCondition).

      Parameters:
      stoppingCondition - a consumer that will call methods on StoppingCondition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • inferenceImage

      DescribeCompilationJobResponse.Builder inferenceImage(String inferenceImage)

      The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.

      Parameters:
      inferenceImage - The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelPackageVersionArn

      DescribeCompilationJobResponse.Builder modelPackageVersionArn(String modelPackageVersionArn)

      The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.

      Parameters:
      modelPackageVersionArn - The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationTime

      DescribeCompilationJobResponse.Builder creationTime(Instant creationTime)

      The time that the model compilation job was created.

      Parameters:
      creationTime - The time that the model compilation job was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastModifiedTime

      DescribeCompilationJobResponse.Builder lastModifiedTime(Instant lastModifiedTime)

      The time that the status of the model compilation job was last modified.

      Parameters:
      lastModifiedTime - The time that the status of the model compilation job was last modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failureReason

      DescribeCompilationJobResponse.Builder failureReason(String failureReason)

      If a model compilation job failed, the reason it failed.

      Parameters:
      failureReason - If a model compilation job failed, the reason it failed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelArtifacts

      DescribeCompilationJobResponse.Builder modelArtifacts(ModelArtifacts modelArtifacts)

      Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.

      Parameters:
      modelArtifacts - Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelArtifacts

      default DescribeCompilationJobResponse.Builder modelArtifacts(Consumer<ModelArtifacts.Builder> modelArtifacts)

      Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.

      This is a convenience method that creates an instance of the ModelArtifacts.Builder avoiding the need to create one manually via ModelArtifacts.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to modelArtifacts(ModelArtifacts).

      Parameters:
      modelArtifacts - a consumer that will call methods on ModelArtifacts.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • modelDigests

      DescribeCompilationJobResponse.Builder modelDigests(ModelDigests modelDigests)

      Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.

      Parameters:
      modelDigests - Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelDigests

      default DescribeCompilationJobResponse.Builder modelDigests(Consumer<ModelDigests.Builder> modelDigests)

      Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.

      This is a convenience method that creates an instance of the ModelDigests.Builder avoiding the need to create one manually via ModelDigests.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to modelDigests(ModelDigests).

      Parameters:
      modelDigests - a consumer that will call methods on ModelDigests.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • roleArn

      DescribeCompilationJobResponse.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputConfig

      DescribeCompilationJobResponse.Builder inputConfig(InputConfig inputConfig)

      Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

      Parameters:
      inputConfig - Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputConfig

      default DescribeCompilationJobResponse.Builder inputConfig(Consumer<InputConfig.Builder> inputConfig)

      Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

      This is a convenience method that creates an instance of the InputConfig.Builder avoiding the need to create one manually via InputConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputConfig(InputConfig).

      Parameters:
      inputConfig - a consumer that will call methods on InputConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • outputConfig

      DescribeCompilationJobResponse.Builder outputConfig(OutputConfig outputConfig)

      Information about the output location for the compiled model and the target device that the model runs on.

      Parameters:
      outputConfig - Information about the output location for the compiled model and the target device that the model runs on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputConfig

      default DescribeCompilationJobResponse.Builder outputConfig(Consumer<OutputConfig.Builder> outputConfig)

      Information about the output location for the compiled model and the target device that the model runs on.

      This is a convenience method that creates an instance of the OutputConfig.Builder avoiding the need to create one manually via OutputConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputConfig(OutputConfig).

      Parameters:
      outputConfig - a consumer that will call methods on OutputConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vpcConfig

      DescribeCompilationJobResponse.Builder vpcConfig(NeoVpcConfig vpcConfig)

      A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

      Parameters:
      vpcConfig - A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfig

      default DescribeCompilationJobResponse.Builder vpcConfig(Consumer<NeoVpcConfig.Builder> vpcConfig)

      A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

      This is a convenience method that creates an instance of the NeoVpcConfig.Builder avoiding the need to create one manually via NeoVpcConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfig(NeoVpcConfig).

      Parameters:
      vpcConfig - a consumer that will call methods on NeoVpcConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • derivedInformation

      DescribeCompilationJobResponse.Builder derivedInformation(DerivedInformation derivedInformation)

      Information that SageMaker Neo automatically derived about the model.

      Parameters:
      derivedInformation - Information that SageMaker Neo automatically derived about the model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • derivedInformation

      default DescribeCompilationJobResponse.Builder derivedInformation(Consumer<DerivedInformation.Builder> derivedInformation)

      Information that SageMaker Neo automatically derived about the model.

      This is a convenience method that creates an instance of the DerivedInformation.Builder avoiding the need to create one manually via DerivedInformation.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to derivedInformation(DerivedInformation).

      Parameters:
      derivedInformation - a consumer that will call methods on DerivedInformation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: