com.aliyun.oss.model

Class 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.

Field Summary

Fields inherited from class com.aliyun.oss.model.WebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListLiveChannelsRequest(String bucketName)
ListLiveChannelsRequest(String bucketName, String prefix, String marker)
ListLiveChannelsRequest(String bucketName, String prefix, String marker, int maxKeys) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
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).

Methods inherited from class com.aliyun.oss.model.LiveChannelGenericRequest

getLiveChannelName, setLiveChannelName

Methods inherited from class com.aliyun.oss.model.GenericRequest

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

Methods inherited from class com.aliyun.oss.model.WebServiceRequest

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ListLiveChannelsRequest

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

Constructor.

Parameters:

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)

Method Detail

getPrefix

public String getPrefix()

Gets the prefix filter---the returned Live Channels must start with this prefix.

Returns:

The prefix filter.

setPrefix

public void setPrefix(String prefix)

Sets the prefix filter---the returned Live Channels must start with this prefix.

Parameters:

prefix - The prefix filter.

getMarker

public String getMarker()

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

Returns:

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.

Parameters:

marker - The marker filter.

getMaxKeys

public Integer getMaxKeys()

Gets max number of live channel. By default it's 100.

Returns:

The max number of live channel.

setMaxKeys

public void setMaxKeys(int maxKeys)

Sets max number of live channel. By default it's 100.

Parameters:

maxKeys - The max number of live channel.

withPrefix

public ListLiveChannelsRequest withPrefix(String prefix)

Sets the prefix and returns the current ListLiveChannelsRequest instance (this).

Parameters:

prefix - The prefix filter.

withMaxKeys

public ListLiveChannelsRequest withMaxKeys(Integer maxKeys)

Sets the max number of Live Channels and returns the current ListLiveChannelsRequest instance(this).

Parameters:

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.

Parameters:

marker - The marker filter.