Class ListStudioLifecycleConfigsRequest

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.ListStudioLifecycleConfigsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListStudioLifecycleConfigsRequest.Builder,ListStudioLifecycleConfigsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListStudioLifecycleConfigsRequest extends SageMakerRequest implements ToCopyableBuilder<ListStudioLifecycleConfigsRequest.Builder,ListStudioLifecycleConfigsRequest>

  • Method Details

    • maxResults

      public final Integer maxResults()

      The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

      Returns:
      The total number of items to return in the response. If the total number of items available is more than the value specified, a NextToken is provided in the response. To resume pagination, provide the NextToken value in the as part of a subsequent call. The default value is 10.

    • nextToken

      public final String nextToken()

      If the previous call to ListStudioLifecycleConfigs didn't return the full set of Lifecycle Configurations, the call returns a token for getting the next set of Lifecycle Configurations.

      Returns:
      If the previous call to ListStudioLifecycleConfigs didn't return the full set of Lifecycle Configurations, the call returns a token for getting the next set of Lifecycle Configurations.

    • nameContains

      public final String nameContains()

      A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose name contains the specified string.

      Returns:
      A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose name contains the specified string.

    • appTypeEquals

      public final StudioLifecycleConfigAppType appTypeEquals()

      A parameter to search for the App Type to which the Lifecycle Configuration is attached.

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

      Returns:
      A parameter to search for the App Type to which the Lifecycle Configuration is attached.
      See Also:

    • appTypeEqualsAsString

      public final String appTypeEqualsAsString()

      A parameter to search for the App Type to which the Lifecycle Configuration is attached.

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

      Returns:
      A parameter to search for the App Type to which the Lifecycle Configuration is attached.
      See Also:

    • creationTimeBefore

      public final Instant creationTimeBefore()

      A filter that returns only Lifecycle Configurations created on or before the specified time.

      Returns:
      A filter that returns only Lifecycle Configurations created on or before the specified time.

    • creationTimeAfter

      public final Instant creationTimeAfter()

      A filter that returns only Lifecycle Configurations created on or after the specified time.

      Returns:
      A filter that returns only Lifecycle Configurations created on or after the specified time.

    • modifiedTimeBefore

      public final Instant modifiedTimeBefore()

      A filter that returns only Lifecycle Configurations modified before the specified time.

      Returns:
      A filter that returns only Lifecycle Configurations modified before the specified time.

    • modifiedTimeAfter

      public final Instant modifiedTimeAfter()

      A filter that returns only Lifecycle Configurations modified after the specified time.

      Returns:
      A filter that returns only Lifecycle Configurations modified after the specified time.

    • sortBy

      public final StudioLifecycleConfigSortKey sortBy()

      The property used to sort results. The default value is CreationTime.

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

      Returns:
      The property used to sort results. The default value is CreationTime.
      See Also:

    • sortByAsString

      public final String sortByAsString()

      The property used to sort results. The default value is CreationTime.

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

      Returns:
      The property used to sort results. The default value is CreationTime.
      See Also:

    • sortOrder

      public final SortOrder sortOrder()

      The sort order. The default value is Descending.

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

      Returns:
      The sort order. The default value is Descending.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

      The sort order. The default value is Descending.

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

      Returns:
      The sort order. The default value is Descending.
      See Also:

    • toBuilder

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

    • builder

      public static ListStudioLifecycleConfigsRequest.Builder builder()

    • serializableBuilderClass

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