com.amazonaws.services.ivsrealtime.model

Class StartCompositionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ivsrealtime.model.StartCompositionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartCompositionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartCompositionRequest()

Method Summary

Modifier and Type	Method and Description
StartCompositionRequest	addTagsEntry(String key, String value) Add a single Tags entry
StartCompositionRequest	clearTagsEntries() Removes all the entries added into Tags.
StartCompositionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<DestinationConfiguration>	getDestinations() Array of destination configuration.
String	getIdempotencyToken() Idempotency token.
LayoutConfiguration	getLayout() Layout object to configure composition parameters.
String	getStageArn() ARN of the stage to be used for compositing.
Map<String,String>	getTags() Tags attached to the resource.
int	hashCode()
void	setDestinations(Collection<DestinationConfiguration> destinations) Array of destination configuration.
void	setIdempotencyToken(String idempotencyToken) Idempotency token.
void	setLayout(LayoutConfiguration layout) Layout object to configure composition parameters.
void	setStageArn(String stageArn) ARN of the stage to be used for compositing.
void	setTags(Map<String,String> tags) Tags attached to the resource.
String	toString() Returns a string representation of this object.
StartCompositionRequest	withDestinations(Collection<DestinationConfiguration> destinations) Array of destination configuration.
StartCompositionRequest	withDestinations(DestinationConfiguration... destinations) Array of destination configuration.
StartCompositionRequest	withIdempotencyToken(String idempotencyToken) Idempotency token.
StartCompositionRequest	withLayout(LayoutConfiguration layout) Layout object to configure composition parameters.
StartCompositionRequest	withStageArn(String stageArn) ARN of the stage to be used for compositing.
StartCompositionRequest	withTags(Map<String,String> tags) Tags attached to the resource.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartCompositionRequest

public StartCompositionRequest()

Method Detail

getDestinations

public List<DestinationConfiguration> getDestinations()

Array of destination configuration.

Returns:

Array of destination configuration.

setDestinations

public void setDestinations(Collection<DestinationConfiguration> destinations)

Array of destination configuration.

Parameters:

destinations - Array of destination configuration.

withDestinations

public StartCompositionRequest withDestinations(DestinationConfiguration... destinations)

Array of destination configuration.

NOTE: This method appends the values to the existing list (if any). Use setDestinations(java.util.Collection) or withDestinations(java.util.Collection) if you want to override the existing values.

Parameters:

destinations - Array of destination configuration.

Returns:

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

withDestinations

public StartCompositionRequest withDestinations(Collection<DestinationConfiguration> destinations)

Array of destination configuration.

Parameters:

destinations - Array of destination configuration.

Returns:

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

setIdempotencyToken

public void setIdempotencyToken(String idempotencyToken)

Idempotency token.

Parameters:

idempotencyToken - Idempotency token.

getIdempotencyToken

public String getIdempotencyToken()

Idempotency token.

Returns:

Idempotency token.

withIdempotencyToken

public StartCompositionRequest withIdempotencyToken(String idempotencyToken)

Idempotency token.

Parameters:

idempotencyToken - Idempotency token.

Returns:

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

setLayout

public void setLayout(LayoutConfiguration layout)

Layout object to configure composition parameters.

Parameters:

layout - Layout object to configure composition parameters.

getLayout

public LayoutConfiguration getLayout()

Layout object to configure composition parameters.

Returns:

Layout object to configure composition parameters.

withLayout

public StartCompositionRequest withLayout(LayoutConfiguration layout)

Layout object to configure composition parameters.

Parameters:

layout - Layout object to configure composition parameters.

Returns:

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

setStageArn

public void setStageArn(String stageArn)

ARN of the stage to be used for compositing.

Parameters:

stageArn - ARN of the stage to be used for compositing.

getStageArn

public String getStageArn()

ARN of the stage to be used for compositing.

Returns:

ARN of the stage to be used for compositing.

withStageArn

public StartCompositionRequest withStageArn(String stageArn)

ARN of the stage to be used for compositing.

Parameters:

stageArn - ARN of the stage to be used for compositing.

Returns:

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

getTags

public Map<String,String> getTags()

Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

Returns:

Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

setTags

public void setTags(Map<String,String> tags)

Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

Parameters:

tags - Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

withTags

public StartCompositionRequest withTags(Map<String,String> tags)

Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

Parameters:

tags - Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

Returns:

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

addTagsEntry

public StartCompositionRequest addTagsEntry(String key,
                                            String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public StartCompositionRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartCompositionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()