Class StartTrainedModelInferenceJobRequest

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

  • Method Details

    • membershipIdentifier

      public final String membershipIdentifier()

      The membership ID of the membership that contains the trained model inference job.

      Returns:
      The membership ID of the membership that contains the trained model inference job.

    • name

      public final String name()

      The name of the trained model inference job.

      Returns:
      The name of the trained model inference job.

    • trainedModelArn

      public final String trainedModelArn()

      The Amazon Resource Name (ARN) of the trained model that is used for this trained model inference job.

      Returns:
      The Amazon Resource Name (ARN) of the trained model that is used for this trained model inference job.

    • trainedModelVersionIdentifier

      public final String trainedModelVersionIdentifier()

      The version identifier of the trained model to use for inference. This specifies which version of the trained model should be used to generate predictions on the input data.

      Returns:
      The version identifier of the trained model to use for inference. This specifies which version of the trained model should be used to generate predictions on the input data.

    • configuredModelAlgorithmAssociationArn

      public final String configuredModelAlgorithmAssociationArn()

      The Amazon Resource Name (ARN) of the configured model algorithm association that is used for this trained model inference job.

      Returns:
      The Amazon Resource Name (ARN) of the configured model algorithm association that is used for this trained model inference job.

    • resourceConfig

      public final InferenceResourceConfig resourceConfig()

      Defines the resource configuration for the trained model inference job.

      Returns:
      Defines the resource configuration for the trained model inference job.

    • outputConfiguration

      public final InferenceOutputConfiguration outputConfiguration()

      Defines the output configuration information for the trained model inference job.

      Returns:
      Defines the output configuration information for the trained model inference job.

    • dataSource

      public final ModelInferenceDataSource dataSource()

      Defines the data source that is used for the trained model inference job.

      Returns:
      Defines the data source that is used for the trained model inference job.

    • description

      public final String description()

      The description of the trained model inference job.

      Returns:
      The description of the trained model inference job.

    • containerExecutionParameters

      public final InferenceContainerExecutionParameters containerExecutionParameters()

      The execution parameters for the container.

      Returns:
      The execution parameters for the container.

    • hasEnvironment

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

    • environment

      public final Map<String,String> environment()

      The environment variables to set in the Docker container.

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

      Returns:
      The environment variables to set in the Docker container.

    • kmsKeyArn

      public final String kmsKeyArn()

      The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the ML inference job and associated data.

      Returns:
      The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the ML inference job and associated data.

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

      The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50.

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8.

      • Maximum value length - 256 Unicode characters in UTF-8.

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

      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:
      The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50.

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8.

      • Maximum value length - 256 Unicode characters in UTF-8.

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

    • toBuilder

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

    • builder

      public static StartTrainedModelInferenceJobRequest.Builder builder()

    • serializableBuilderClass

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