Class CreateMlflowTrackingServerRequest
- 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.CreateMlflowTrackingServerRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateMlflowTrackingServerRequest.Builder,CreateMlflowTrackingServerRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateMlflowTrackingServerRequest extends SageMakerRequest implements ToCopyableBuilder<CreateMlflowTrackingServerRequest.Builder,CreateMlflowTrackingServerRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CreateMlflowTrackingServerRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
artifactStoreUri()
The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact store.Boolean
automaticModelRegistration()
Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry.static CreateMlflowTrackingServerRequest.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.String
mlflowVersion()
The version of MLflow that the tracking server uses.String
roleArn()
The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses to access the artifact store in Amazon S3.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends CreateMlflowTrackingServerRequest.Builder>
serializableBuilderClass()
List<Tag>
tags()
Tags consisting of key-value pairs used to manage metadata for the tracking server.CreateMlflowTrackingServerRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
trackingServerName()
A unique string identifying the tracking server name.TrackingServerSize
trackingServerSize()
The size of the tracking server you want to create.String
trackingServerSizeAsString()
The size of the tracking server you want to create.String
weeklyMaintenanceWindowStart()
The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
trackingServerName
public final String trackingServerName()
A unique string identifying the tracking server name. This string is part of the tracking server ARN.
- Returns:
- A unique string identifying the tracking server name. This string is part of the tracking server ARN.
-
artifactStoreUri
public final String artifactStoreUri()
The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact store.
- Returns:
- The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact store.
-
trackingServerSize
public final TrackingServerSize trackingServerSize()
The size of the tracking server you want to create. You can choose between
"Small"
,"Medium"
, and"Large"
. The default MLflow Tracking Server configuration size is"Small"
. You can choose a size depending on the projected use of the tracking server such as the volume of data logged, number of users, and frequency of use.We recommend using a small tracking server for teams of up to 25 users, a medium tracking server for teams of up to 50 users, and a large tracking server for teams of up to 100 users.
If the service returns an enum value that is not available in the current SDK version,
trackingServerSize
will returnTrackingServerSize.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtrackingServerSizeAsString()
.- Returns:
- The size of the tracking server you want to create. You can choose between
"Small"
,"Medium"
, and"Large"
. The default MLflow Tracking Server configuration size is"Small"
. You can choose a size depending on the projected use of the tracking server such as the volume of data logged, number of users, and frequency of use.We recommend using a small tracking server for teams of up to 25 users, a medium tracking server for teams of up to 50 users, and a large tracking server for teams of up to 100 users.
- See Also:
TrackingServerSize
-
trackingServerSizeAsString
public final String trackingServerSizeAsString()
The size of the tracking server you want to create. You can choose between
"Small"
,"Medium"
, and"Large"
. The default MLflow Tracking Server configuration size is"Small"
. You can choose a size depending on the projected use of the tracking server such as the volume of data logged, number of users, and frequency of use.We recommend using a small tracking server for teams of up to 25 users, a medium tracking server for teams of up to 50 users, and a large tracking server for teams of up to 100 users.
If the service returns an enum value that is not available in the current SDK version,
trackingServerSize
will returnTrackingServerSize.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtrackingServerSizeAsString()
.- Returns:
- The size of the tracking server you want to create. You can choose between
"Small"
,"Medium"
, and"Large"
. The default MLflow Tracking Server configuration size is"Small"
. You can choose a size depending on the projected use of the tracking server such as the volume of data logged, number of users, and frequency of use.We recommend using a small tracking server for teams of up to 25 users, a medium tracking server for teams of up to 50 users, and a large tracking server for teams of up to 100 users.
- See Also:
TrackingServerSize
-
mlflowVersion
public final String mlflowVersion()
The version of MLflow that the tracking server uses. To see which MLflow versions are available to use, see How it works.
- Returns:
- The version of MLflow that the tracking server uses. To see which MLflow versions are available to use, see How it works.
-
roleArn
public final String roleArn()
The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses to access the artifact store in Amazon S3. The role should have
AmazonS3FullAccess
permissions. For more information on IAM permissions for tracking server creation, see Set up IAM permissions for MLflow.- Returns:
- The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses to
access the artifact store in Amazon S3. The role should have
AmazonS3FullAccess
permissions. For more information on IAM permissions for tracking server creation, see Set up IAM permissions for MLflow.
-
automaticModelRegistration
public final Boolean automaticModelRegistration()
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
True
. To disable automatic model registration, set this value toFalse
. If not specified,AutomaticModelRegistration
defaults toFalse
.- 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
True
. To disable automatic model registration, set this value toFalse
. If not specified,AutomaticModelRegistration
defaults toFalse
.
-
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.
-
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 theisEmpty()
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 tracking server.
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 tracking server.
-
toBuilder
public CreateMlflowTrackingServerRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateMlflowTrackingServerRequest.Builder,CreateMlflowTrackingServerRequest>
- Specified by:
toBuilder
in classSageMakerRequest
-
builder
public static CreateMlflowTrackingServerRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateMlflowTrackingServerRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-