Class ListHyperParameterTuningJobsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListHyperParameterTuningJobsRequest.Builder,
ListHyperParameterTuningJobsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
A filter that returns only tuning jobs that were created after the specified time.final Instant
A filter that returns only tuning jobs that were created before the specified time.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Instant
A filter that returns only tuning jobs that were modified after the specified time.final Instant
A filter that returns only tuning jobs that were modified before the specified time.final Integer
The maximum number of tuning jobs to return.final String
A string in the tuning job name.final String
If the result of the previousListHyperParameterTuningJobs
request was truncated, the response includes aNextToken
.static Class
<? extends ListHyperParameterTuningJobsRequest.Builder> sortBy()
The field to sort results by.final String
The field to sort results by.final SortOrder
The sort order for results.final String
The sort order for results.A filter that returns only tuning jobs with the specified status.final String
A filter that returns only tuning jobs with the specified status.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
nextToken
If the result of the previous
ListHyperParameterTuningJobs
request was truncated, the response includes aNextToken
. To retrieve the next set of tuning jobs, use the token in the next request.- Returns:
- If the result of the previous
ListHyperParameterTuningJobs
request was truncated, the response includes aNextToken
. To retrieve the next set of tuning jobs, use the token in the next request.
-
maxResults
The maximum number of tuning jobs to return. The default value is 10.
- Returns:
- The maximum number of tuning jobs to return. The default value is 10.
-
sortBy
The field to sort results by. The default is
Name
.If the service returns an enum value that is not available in the current SDK version,
sortBy
will returnHyperParameterTuningJobSortByOptions.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortByAsString()
.- Returns:
- The field to sort results by. The default is
Name
. - See Also:
-
sortByAsString
The field to sort results by. The default is
Name
.If the service returns an enum value that is not available in the current SDK version,
sortBy
will returnHyperParameterTuningJobSortByOptions.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortByAsString()
.- Returns:
- The field to sort results by. The default is
Name
. - See Also:
-
sortOrder
The sort order for results. The default is
Ascending
.If the service returns an enum value that is not available in the current SDK version,
sortOrder
will returnSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortOrderAsString()
.- Returns:
- The sort order for results. The default is
Ascending
. - See Also:
-
sortOrderAsString
The sort order for results. The default is
Ascending
.If the service returns an enum value that is not available in the current SDK version,
sortOrder
will returnSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortOrderAsString()
.- Returns:
- The sort order for results. The default is
Ascending
. - See Also:
-
nameContains
A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.
- Returns:
- A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.
-
creationTimeAfter
A filter that returns only tuning jobs that were created after the specified time.
- Returns:
- A filter that returns only tuning jobs that were created after the specified time.
-
creationTimeBefore
A filter that returns only tuning jobs that were created before the specified time.
- Returns:
- A filter that returns only tuning jobs that were created before the specified time.
-
lastModifiedTimeAfter
A filter that returns only tuning jobs that were modified after the specified time.
- Returns:
- A filter that returns only tuning jobs that were modified after the specified time.
-
lastModifiedTimeBefore
A filter that returns only tuning jobs that were modified before the specified time.
- Returns:
- A filter that returns only tuning jobs that were modified before the specified time.
-
statusEquals
A filter that returns only tuning jobs with the specified status.
If the service returns an enum value that is not available in the current SDK version,
statusEquals
will returnHyperParameterTuningJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusEqualsAsString()
.- Returns:
- A filter that returns only tuning jobs with the specified status.
- See Also:
-
statusEqualsAsString
A filter that returns only tuning jobs with the specified status.
If the service returns an enum value that is not available in the current SDK version,
statusEquals
will returnHyperParameterTuningJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusEqualsAsString()
.- Returns:
- A filter that returns only tuning jobs with the specified status.
- See Also:
-
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 interfaceToCopyableBuilder<ListHyperParameterTuningJobsRequest.Builder,
ListHyperParameterTuningJobsRequest> - Specified by:
toBuilder
in classSageMakerRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends ListHyperParameterTuningJobsRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-