com.aliyun.oss.model

## 类 ListLiveChannelsRequest

- java.lang.Object
- - com.aliyun.oss.model.WebServiceRequest
  - - com.aliyun.oss.model.GenericRequest
    - - com.aliyun.oss.model.LiveChannelGenericRequest
      - - com.aliyun.oss.model.ListLiveChannelsRequest

-     public class ListLiveChannelsRequest
      extends LiveChannelGenericRequest

  This is the request class is used to list Live Channels under a bucket.

- - ### 字段概要

    - ### 从类继承的字段 com.aliyun.oss.model.WebServiceRequest

      `NOOP`

  - ### 构造器概要

    构造器
    构造器和说明
    `ListLiveChannelsRequest(String bucketName)`
    `ListLiveChannelsRequest(String bucketName, String prefix, String marker)`
    `ListLiveChannelsRequest(String bucketName, String prefix, String marker, int maxKeys)` Constructor.

  - ### 方法概要

    方法
    限定符和类型 | 方法和说明
    --- | ---
    `String` | `getMarker()` Gets the marker filter---returned Live Channels must be greater than this marker in lexicographical order.
    `Integer` | `getMaxKeys()` Gets max number of live channel.
    `String` | `getPrefix()` Gets the prefix filter---the returned Live Channels must start with this prefix.
    `void` | `setMarker(String marker)` Sets the marker filter---returned Live Channels must be greater than this marker in lexicographical order.
    `void` | `setMaxKeys(int maxKeys)` Sets max number of live channel.
    `void` | `setPrefix(String prefix)` Sets the prefix filter---the returned Live Channels must start with this prefix.
    `ListLiveChannelsRequest` | `withMarker(String marker)` Sets the marker filter.
    `ListLiveChannelsRequest` | `withMaxKeys(Integer maxKeys)` Sets the max number of Live Channels and returns the current ListLiveChannelsRequest instance(this).
    `ListLiveChannelsRequest` | `withPrefix(String prefix)` Sets the prefix and returns the current ListLiveChannelsRequest instance (this).

    - ### 从类继承的方法 com.aliyun.oss.model.LiveChannelGenericRequest

      `getLiveChannelName, setLiveChannelName`

    - ### 从类继承的方法 com.aliyun.oss.model.GenericRequest

      `getBucketName, getKey, getRequestPayer, getVersionId, setBucketName, setKey, setRequestPayer, setVersionId, withBucketName, withKey, withRequestPayer, withVersionId`

    - ### 从类继承的方法 com.aliyun.oss.model.WebServiceRequest

      `addAdditionalHeaderName, addHeader, addParameter, getAdditionalHeaderNames, getHeaders, getParameters, getProgressListener, isLogEnabled, setAdditionalHeaderNames, setHeaders, setLogEnabled, setParameters, setProgressListener, withProgressListener`

    - ### 从类继承的方法 java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### 构造器详细资料

    - #### ListLiveChannelsRequest

          public ListLiveChannelsRequest(String bucketName,
                                 String prefix,
                                 String marker,
                                 int maxKeys)

      Constructor.
      参数:
        `bucketName` - Bucket name.
        `prefix` - Prefix filter---returned Live Channels must start with this prefix.
        `marker` - Marker filter----returned Live Channels must be greater than this marker in lexicographical order.
        `maxKeys` - Max Live Channels to return, By default it's 100.

    - #### ListLiveChannelsRequest

          public ListLiveChannelsRequest(String bucketName)

    - #### ListLiveChannelsRequest

          public ListLiveChannelsRequest(String bucketName,
                                 String prefix,
                                 String marker)

  - ### 方法详细资料

    - #### getPrefix

          public String getPrefix()

      Gets the prefix filter---the returned Live Channels must start with this prefix.
      返回:
        The prefix filter.

    - #### setPrefix

          public void setPrefix(String prefix)

      Sets the prefix filter---the returned Live Channels must start with this prefix.
      参数:
        `prefix` - The prefix filter.

    - #### getMarker

          public String getMarker()

      Gets the marker filter---returned Live Channels must be greater than this marker in lexicographical order.
      返回:
        The marker filter.

    - #### setMarker

          public void setMarker(String marker)

      Sets the marker filter---returned Live Channels must be greater than this marker in lexicographical order.
      参数:
        `marker` - The marker filter.

    - #### getMaxKeys

          public Integer getMaxKeys()

      Gets max number of live channel. By default it's 100.
      返回:
        The max number of live channel.

    - #### setMaxKeys

          public void setMaxKeys(int maxKeys)

      Sets max number of live channel. By default it's 100.
      参数:
        `maxKeys` - The max number of live channel.

    - #### withPrefix

          public ListLiveChannelsRequest withPrefix(String prefix)

      Sets the prefix and returns the current ListLiveChannelsRequest instance (this).
      参数:
        `prefix` - The prefix filter.

    - #### withMaxKeys

          public ListLiveChannelsRequest withMaxKeys(Integer maxKeys)

      Sets the max number of Live Channels and returns the current ListLiveChannelsRequest instance(this).
      参数:
        `maxKeys` - The max number of Live Channels, by default is 100 and max value is also 100.

    - #### withMarker

          public ListLiveChannelsRequest withMarker(String marker)

      Sets the marker filter.
      参数:
        `marker` - The marker filter.

Copyright © 2020. All Rights Reserved.