Class ListProjectsRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListProjectsRequest.Builder,ListProjectsRequest>

@Generated("software.amazon.awssdk:codegen") public final class ListProjectsRequest extends BedrockRequest implements ToCopyableBuilder<ListProjectsRequest.Builder,ListProjectsRequest>

The page size, continuation token, and optional lifecycle status filter for listing projects.

  • Method Details

    • nextToken

      public final String nextToken()

      Continuation token from a previous ListProjects response.

      Returns:
      Continuation token from a previous ListProjects response.
    • maxResults

      public final Integer maxResults()

      The maximum number of projects to return in one response, from 1 to 100. The default is 20.

      Returns:
      The maximum number of projects to return in one response, from 1 to 100. The default is 20.
    • statusFilter

      public final ProjectStatus statusFilter()

      Returns only the projects in this lifecycle status. When absent, no status filtering is applied and every project is returned. New lifecycle states extend the ProjectStatus enum, and with it this filter, compatibly.

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

      Returns:
      Returns only the projects in this lifecycle status. When absent, no status filtering is applied and every project is returned. New lifecycle states extend the ProjectStatus enum, and with it this filter, compatibly.
      See Also:
    • statusFilterAsString

      public final String statusFilterAsString()

      Returns only the projects in this lifecycle status. When absent, no status filtering is applied and every project is returned. New lifecycle states extend the ProjectStatus enum, and with it this filter, compatibly.

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

      Returns:
      Returns only the projects in this lifecycle status. When absent, no status filtering is applied and every project is returned. New lifecycle states extend the ProjectStatus enum, and with it this filter, compatibly.
      See Also:
    • toBuilder

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

      public static ListProjectsRequest.Builder builder()
    • serializableBuilderClass

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