Class CreateMlflowAppRequest

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

  • Method Details

    • name

      public final String name()

      A string identifying the MLflow app name. This string is not part of the tracking server ARN.

      Returns:
      A string identifying the MLflow app name. This string is not part of the tracking server ARN.

    • artifactStoreUri

      public final String artifactStoreUri()

      The S3 URI for a general purpose bucket to use as the MLflow App artifact store.

      Returns:
      The S3 URI for a general purpose bucket to use as the MLflow App artifact store.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the artifact store in Amazon S3. The role should have the AmazonS3FullAccess permission.

      Returns:
      The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the artifact store in Amazon S3. The role should have the AmazonS3FullAccess permission.

    • modelRegistrationMode

      public final ModelRegistrationMode modelRegistrationMode()

      Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to AutoModelRegistrationEnabled. To disable automatic model registration, set this value to AutoModelRegistrationDisabled. If not specified, AutomaticModelRegistration defaults to AutoModelRegistrationDisabled.

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

      Returns:
      Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to AutoModelRegistrationEnabled. To disable automatic model registration, set this value to AutoModelRegistrationDisabled. If not specified, AutomaticModelRegistration defaults to AutoModelRegistrationDisabled.
      See Also:

    • modelRegistrationModeAsString

      public final String modelRegistrationModeAsString()

      Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to AutoModelRegistrationEnabled. To disable automatic model registration, set this value to AutoModelRegistrationDisabled. If not specified, AutomaticModelRegistration defaults to AutoModelRegistrationDisabled.

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

      Returns:
      Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to AutoModelRegistrationEnabled. To disable automatic model registration, set this value to AutoModelRegistrationDisabled. If not specified, AutomaticModelRegistration defaults to AutoModelRegistrationDisabled.
      See Also:

    • weeklyMaintenanceWindowStart

      public final String weeklyMaintenanceWindowStart()

      The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.

      Returns:
      The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.

    • accountDefaultStatus

      public final AccountDefaultStatus accountDefaultStatus()

      Indicates whether this MLflow app is the default for the entire account.

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

      Returns:
      Indicates whether this MLflow app is the default for the entire account.
      See Also:

    • accountDefaultStatusAsString

      public final String accountDefaultStatusAsString()

      Indicates whether this MLflow app is the default for the entire account.

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

      Returns:
      Indicates whether this MLflow app is the default for the entire account.
      See Also:

    • hasDefaultDomainIdList

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

    • defaultDomainIdList

      public final List<String> defaultDomainIdList()

      List of SageMaker domain IDs for which this MLflow App is used as the default.

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

      Returns:
      List of SageMaker domain IDs for which this MLflow App is used as the default.

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

      Tags consisting of key-value pairs used to manage metadata for the MLflow App.

      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:
      Tags consisting of key-value pairs used to manage metadata for the MLflow App.

    • toBuilder

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

    • builder

      public static CreateMlflowAppRequest.Builder builder()

    • serializableBuilderClass

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