Package software.amazon.awssdk.services.ivsrealtime.model

Class IngestConfigurationSummary

java.lang.Object

software.amazon.awssdk.services.ivsrealtime.model.IngestConfigurationSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<IngestConfigurationSummary.Builder,IngestConfigurationSummary>

@Generated("software.amazon.awssdk:codegen")
public final class IngestConfigurationSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<IngestConfigurationSummary.Builder,IngestConfigurationSummary>

Summary information about an IngestConfiguration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IngestConfigurationSummary.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	Ingest configuration ARN.
static IngestConfigurationSummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
IngestProtocol	ingestProtocol()	Type of ingest protocol that the user employs for broadcasting.
String	ingestProtocolAsString()	Type of ingest protocol that the user employs for broadcasting.
String	name()	Ingest name.
String	participantId()	ID of the participant within the stage.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends IngestConfigurationSummary.Builder>	serializableBuilderClass()
String	stageArn()	ARN of the stage with which the IngestConfiguration is associated.
IngestConfigurationState	state()	State of the ingest configuration.
String	stateAsString()	State of the ingest configuration.
IngestConfigurationSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userId()	Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems.

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

name

public final String name()

Ingest name.

Returns:

Ingest name.

arn

public final String arn()

Ingest configuration ARN.

Returns:

Ingest configuration ARN.

ingestProtocol

public final IngestProtocol ingestProtocol()

Type of ingest protocol that the user employs for broadcasting.

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

Returns:

Type of ingest protocol that the user employs for broadcasting.

See Also:

IngestProtocol

ingestProtocolAsString

public final String ingestProtocolAsString()

Type of ingest protocol that the user employs for broadcasting.

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

Returns:

Type of ingest protocol that the user employs for broadcasting.

See Also:

IngestProtocol

stageArn

public final String stageArn()

ARN of the stage with which the IngestConfiguration is associated.

Returns:

ARN of the stage with which the IngestConfiguration is associated.

participantId

public final String participantId()

ID of the participant within the stage.

Returns:

ID of the participant within the stage.

state

public final IngestConfigurationState state()

State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration.

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

Returns:

State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration.

See Also:

IngestConfigurationState

stateAsString

public final String stateAsString()

State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration.

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

Returns:

State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration.

See Also:

IngestConfigurationState

userId

public final String userId()

Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

Returns:

Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

toBuilder

public IngestConfigurationSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IngestConfigurationSummary.Builder,IngestConfigurationSummary>

builder

public static IngestConfigurationSummary.Builder builder()

serializableBuilderClass

public static Class<? extends IngestConfigurationSummary.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo