Class ListStreamUrlsRequest

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

  • Method Details

    • status

      public final StreamUrlStatus status()

      Filters the list to stream URLs with the specified status.

      • ACTIVE: The stream URL is valid and can start stream sessions.

      • EXPIRED: The stream URL has passed its expiration time and can no longer start stream sessions.

      • REVOKED: The stream URL was revoked and can no longer start stream sessions.

      • LIMIT_REACHED: The stream URL has been used the maximum number of times and can no longer start stream sessions.

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

      Returns:
      Filters the list to stream URLs with the specified status.

      • ACTIVE: The stream URL is valid and can start stream sessions.

      • EXPIRED: The stream URL has passed its expiration time and can no longer start stream sessions.

      • REVOKED: The stream URL was revoked and can no longer start stream sessions.

      • LIMIT_REACHED: The stream URL has been used the maximum number of times and can no longer start stream sessions.

      See Also:

    • statusAsString

      public final String statusAsString()

      Filters the list to stream URLs with the specified status.

      • ACTIVE: The stream URL is valid and can start stream sessions.

      • EXPIRED: The stream URL has passed its expiration time and can no longer start stream sessions.

      • REVOKED: The stream URL was revoked and can no longer start stream sessions.

      • LIMIT_REACHED: The stream URL has been used the maximum number of times and can no longer start stream sessions.

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

      Returns:
      Filters the list to stream URLs with the specified status.

      • ACTIVE: The stream URL is valid and can start stream sessions.

      • EXPIRED: The stream URL has passed its expiration time and can no longer start stream sessions.

      • REVOKED: The stream URL was revoked and can no longer start stream sessions.

      • LIMIT_REACHED: The stream URL has been used the maximum number of times and can no longer start stream sessions.

      See Also:

    • streamGroupIdentifier

      public final String streamGroupIdentifier()

      Filters the list to stream URLs that belong to the specified stream group.

      This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.

      Returns:
      Filters the list to stream URLs that belong to the specified stream group.

      This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.

    • nextToken

      public final String nextToken()

      The token that marks the start of the next set of results. Use this token when you retrieve results as sequential pages. To get the first page of results, omit a token value. To get the remaining pages, provide the token returned with the previous result set.

      Returns:
      The token that marks the start of the next set of results. Use this token when you retrieve results as sequential pages. To get the first page of results, omit a token value. To get the remaining pages, provide the token returned with the previous result set.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return per page. Valid values are 1-100. The default is 25.

      Returns:
      The maximum number of results to return per page. Valid values are 1-100. The default is 25.

    • toBuilder

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

    • builder

      public static ListStreamUrlsRequest.Builder builder()

    • serializableBuilderClass

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