Class ListWorkspacesRequest

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

Represents the input of a ListWorkspaces operation.

  • Method Details

    • alias

      public final String alias()

      If this is included, it filters the results to only the workspaces with names that start with the value that you specify here.

      Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.

      Returns:
      If this is included, it filters the results to only the workspaces with names that start with the value that you specify here.

      Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.

    • maxResults

      public final Integer maxResults()

      The maximum number of workspaces to return per request. The default is 100.

      Returns:
      The maximum number of workspaces to return per request. The default is 100.

    • nextToken

      public final String nextToken()

      The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call.

      For example, if your initial request has maxResults of 10, and there are 12 workspaces to return, then your initial request will return 10 and a nextToken. Using the next token in a subsequent call will return the remaining 2 workspaces.

      Returns:
      The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call.

      For example, if your initial request has maxResults of 10, and there are 12 workspaces to return, then your initial request will return 10 and a nextToken. Using the next token in a subsequent call will return the remaining 2 workspaces.

    • toBuilder

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

    • builder

      public static ListWorkspacesRequest.Builder builder()

    • serializableBuilderClass

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