java.lang.Object
- software.amazon.awssdk.services.ivsrealtime.model.IngestConfiguration

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<IngestConfiguration.Builder,IngestConfiguration>

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

Object specifying an ingest configuration.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface IngestConfiguration.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`arn()`	Ingest configuration ARN.
`Map<String,String>`	`attributes()`	Application-provided attributes to to store in the IngestConfiguration and attach to a stage.
`static IngestConfiguration.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttributes()`	For responses, this returns true if the service returned a value for the Attributes property.
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`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 IngestConfiguration.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.
`String`	`streamKey()`	Ingest-key value for the RTMP(S) protocol.
`Map<String,String>`	`tags()`	Tags attached to the resource.
`IngestConfiguration.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
  - streamKey
```
public final String streamKey()
```
    Ingest-key value for the RTMP(S) protocol.
    
    Returns:
    
    Ingest-key value for the RTMP(S) protocol.
  - 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.
  - hasAttributes
```
public final boolean hasAttributes()
```
    For responses, this returns true if the service returned a value for the Attributes 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.
  - attributes
```
public final Map<String,String> attributes()
```
    Application-provided attributes to to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
    
    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 hasAttributes() method.
    
    Returns:
    
    Application-provided attributes to to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
  - 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 Map<String,String> tags()
```
    Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor 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.
    
    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:
    
    Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor 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.
  - toBuilder
```
public IngestConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<IngestConfiguration.Builder,IngestConfiguration>
  - builder
```
public static IngestConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends IngestConfiguration.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

Class IngestConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

arn

ingestProtocol

ingestProtocolAsString

streamKey

stageArn

participantId

state

stateAsString

userId

hasAttributes

attributes

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField