com.amazonaws.services.kinesisvideo.model

Class GetDataEndpointRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesisvideo.model.GetDataEndpointRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class GetDataEndpointRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the GetMedia or GetMediaForFragmentList operations) or write to it (using the PutMedia operation).

The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint.

In the request, specify the stream either by StreamName or StreamARN.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetDataEndpointRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAPIName() The name of the API action for which to get an endpoint.
java.lang.String	getStreamARN() The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for.
java.lang.String	getStreamName() The name of the stream that you want to get the endpoint for.
int	hashCode()
void	setAPIName(APIName aPIName) The name of the API action for which to get an endpoint.
void	setAPIName(java.lang.String aPIName) The name of the API action for which to get an endpoint.
void	setStreamARN(java.lang.String streamARN) The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for.
void	setStreamName(java.lang.String streamName) The name of the stream that you want to get the endpoint for.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
GetDataEndpointRequest	withAPIName(APIName aPIName) The name of the API action for which to get an endpoint.
GetDataEndpointRequest	withAPIName(java.lang.String aPIName) The name of the API action for which to get an endpoint.
GetDataEndpointRequest	withStreamARN(java.lang.String streamARN) The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for.
GetDataEndpointRequest	withStreamName(java.lang.String streamName) The name of the stream that you want to get the endpoint for.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetDataEndpointRequest

public GetDataEndpointRequest()

Method Detail

getStreamName

public java.lang.String getStreamName()

The name of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamARN in the request.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Returns:

The name of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamARN in the request.

setStreamName

public void setStreamName(java.lang.String streamName)

The name of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamARN in the request.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Parameters:

streamName -

The name of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamARN in the request.

withStreamName

public GetDataEndpointRequest withStreamName(java.lang.String streamName)

The name of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamARN in the request.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Parameters:

streamName -

The name of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamARN in the request.

Returns:

A reference to this updated object so that method calls can be chained together.

getStreamARN

public java.lang.String getStreamARN()

The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamName in the request.

Constraints:
Length: 1 - 1024
Pattern: arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

Returns:

The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamName in the request.

setStreamARN

public void setStreamARN(java.lang.String streamARN)

The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamName in the request.

Constraints:
Length: 1 - 1024
Pattern: arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

Parameters:

streamARN -

The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamName in the request.

withStreamARN

public GetDataEndpointRequest withStreamARN(java.lang.String streamARN)

The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamName in the request.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 1024
Pattern: arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

Parameters:

streamARN -

The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamName in the request.

Returns:

A reference to this updated object so that method calls can be chained together.

getAPIName

public java.lang.String getAPIName()

The name of the API action for which to get an endpoint.

Constraints:
Allowed Values: PUT_MEDIA, GET_MEDIA, LIST_FRAGMENTS, GET_MEDIA_FOR_FRAGMENT_LIST, GET_HLS_STREAMING_SESSION_URL, GET_DASH_STREAMING_SESSION_URL

Returns:

The name of the API action for which to get an endpoint.

See Also:

APIName

setAPIName

public void setAPIName(java.lang.String aPIName)

The name of the API action for which to get an endpoint.

Constraints:
Allowed Values: PUT_MEDIA, GET_MEDIA, LIST_FRAGMENTS, GET_MEDIA_FOR_FRAGMENT_LIST, GET_HLS_STREAMING_SESSION_URL, GET_DASH_STREAMING_SESSION_URL

Parameters:

aPIName -

The name of the API action for which to get an endpoint.

See Also:

APIName

withAPIName

public GetDataEndpointRequest withAPIName(java.lang.String aPIName)

The name of the API action for which to get an endpoint.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: PUT_MEDIA, GET_MEDIA, LIST_FRAGMENTS, GET_MEDIA_FOR_FRAGMENT_LIST, GET_HLS_STREAMING_SESSION_URL, GET_DASH_STREAMING_SESSION_URL

Parameters:

aPIName -

The name of the API action for which to get an endpoint.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

APIName

setAPIName

public void setAPIName(APIName aPIName)

The name of the API action for which to get an endpoint.

Constraints:
Allowed Values: PUT_MEDIA, GET_MEDIA, LIST_FRAGMENTS, GET_MEDIA_FOR_FRAGMENT_LIST, GET_HLS_STREAMING_SESSION_URL, GET_DASH_STREAMING_SESSION_URL

Parameters:

aPIName -

The name of the API action for which to get an endpoint.

See Also:

APIName

withAPIName

public GetDataEndpointRequest withAPIName(APIName aPIName)

The name of the API action for which to get an endpoint.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: PUT_MEDIA, GET_MEDIA, LIST_FRAGMENTS, GET_MEDIA_FOR_FRAGMENT_LIST, GET_HLS_STREAMING_SESSION_URL, GET_DASH_STREAMING_SESSION_URL

Parameters:

aPIName -

The name of the API action for which to get an endpoint.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

APIName

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object