Class ListVmEntitlementsRequest

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

  • Method Details

    • nextToken

      public final String nextToken()

      A unique pagination token for each page. If nextToken is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

      Returns:
      A unique pagination token for each page. If nextToken is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.

      Returns:
      The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.

    • environmentId

      public final String environmentId()

      A unique ID for the environment.

      Returns:
      A unique ID for the environment.

    • connectorId

      public final String connectorId()

      A unique ID for the connector.

      Returns:
      A unique ID for the connector.

    • entitlementType

      public final EntitlementType entitlementType()

      The type of entitlement to list.

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

      Returns:
      The type of entitlement to list.
      See Also:

    • entitlementTypeAsString

      public final String entitlementTypeAsString()

      The type of entitlement to list.

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

      Returns:
      The type of entitlement to list.
      See Also:

    • toBuilder

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

    • builder

      public static ListVmEntitlementsRequest.Builder builder()

    • serializableBuilderClass

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