software.amazon.awssdk.services.chimesdkmediapipelines.model

Class CreateMediaCapturePipelineRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.chimesdkmediapipelines.model.ChimeSdkMediaPipelinesRequest

software.amazon.awssdk.services.chimesdkmediapipelines.model.CreateMediaCapturePipelineRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateMediaCapturePipelineRequest.Builder,CreateMediaCapturePipelineRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateMediaCapturePipelineRequest
extends ChimeSdkMediaPipelinesRequest
implements ToCopyableBuilder<CreateMediaCapturePipelineRequest.Builder,CreateMediaCapturePipelineRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateMediaCapturePipelineRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateMediaCapturePipelineRequest.Builder	builder()
ChimeSdkMeetingConfiguration	chimeSdkMeetingConfiguration() The configuration for a specified media capture pipeline.
String	clientRequestToken() The token assigned to the client making the pipeline request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateMediaCapturePipelineRequest.Builder>	serializableBuilderClass()
String	sinkArn() The ARN of the sink type.
MediaPipelineSinkType	sinkType() Destination type to which the media artifacts are saved.
String	sinkTypeAsString() Destination type to which the media artifacts are saved.
String	sourceArn() ARN of the source from which the media artifacts are captured.
MediaPipelineSourceType	sourceType() Source type from which the media artifacts are captured.
String	sourceTypeAsString() Source type from which the media artifacts are captured.
List<Tag>	tags() The list of tags.
CreateMediaCapturePipelineRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

sourceType

public final MediaPipelineSourceType sourceType()

Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.

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

Returns:

Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.

See Also:

MediaPipelineSourceType

sourceTypeAsString

public final String sourceTypeAsString()

Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.

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

Returns:

Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.

See Also:

MediaPipelineSourceType

sourceArn

public final String sourceArn()

ARN of the source from which the media artifacts are captured.

Returns:

ARN of the source from which the media artifacts are captured.

sinkType

public final MediaPipelineSinkType sinkType()

Destination type to which the media artifacts are saved. You must use an S3 bucket.

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

Returns:

Destination type to which the media artifacts are saved. You must use an S3 bucket.

See Also:

MediaPipelineSinkType

sinkTypeAsString

public final String sinkTypeAsString()

Destination type to which the media artifacts are saved. You must use an S3 bucket.

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

Returns:

Destination type to which the media artifacts are saved. You must use an S3 bucket.

See Also:

MediaPipelineSinkType

sinkArn

public final String sinkArn()

The ARN of the sink type.

Returns:

The ARN of the sink type.

clientRequestToken

public final String clientRequestToken()

The token assigned to the client making the pipeline request.

Returns:

The token assigned to the client making the pipeline request.

chimeSdkMeetingConfiguration

public final ChimeSdkMeetingConfiguration chimeSdkMeetingConfiguration()

The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.

Returns:

The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

The list of tags.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

The list of tags.

toBuilder

public CreateMediaCapturePipelineRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateMediaCapturePipelineRequest.Builder,CreateMediaCapturePipelineRequest>

Specified by:

toBuilder in class ChimeSdkMediaPipelinesRequest

builder

public static CreateMediaCapturePipelineRequest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo