Class SourceEndpoint

java.lang.Object
software.amazon.awssdk.services.mediaconnect.model.SourceEndpoint
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SourceEndpoint.Builder,SourceEndpoint>
@Generated("software.amazon.awssdk:codegen") public final class SourceEndpoint extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SourceEndpoint.Builder,SourceEndpoint>

The details of a source endpoint in MediaConnect, including its configuration, state, and connection details.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the source endpoint.

      Returns:
      The name of the source endpoint.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the source endpoint.

      Returns:
      The Amazon Resource Name (ARN) of the source endpoint.

    • id

      public final String id()

      The unique identifier of the source endpoint.

      Returns:
      The unique identifier of the source endpoint.

    • description

      public final String description()

      The description of the source endpoint.

      Returns:
      The description of the source endpoint.

    • regionName

      public final String regionName()

      The name of the Amazon Web Services Region in which the source endpoint is located.

      Returns:
      The name of the Amazon Web Services Region in which the source endpoint is located.

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone in which the source endpoint is located.

      Returns:
      The Availability Zone in which the source endpoint is located.

    • availabilityZoneId

      public final String availabilityZoneId()

      The ID of the Availability Zone in which the source endpoint is located.

      Returns:
      The ID of the Availability Zone in which the source endpoint is located.

    • createdAt

      public final Instant createdAt()

      The date and time when the source endpoint was created.

      Returns:
      The date and time when the source endpoint was created.

    • updatedAt

      public final Instant updatedAt()

      The date and time when the source endpoint was last updated.

      Returns:
      The date and time when the source endpoint was last updated.

    • lifecycleManagement

      public final EndpointLifecycle lifecycleManagement()

      The entity that manages the lifecycle of the source endpoint.

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

      Returns:
      The entity that manages the lifecycle of the source endpoint.
      See Also:

    • lifecycleManagementAsString

      public final String lifecycleManagementAsString()

      The entity that manages the lifecycle of the source endpoint.

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

      Returns:
      The entity that manages the lifecycle of the source endpoint.
      See Also:

    • hasMessages

      public final boolean hasMessages()
      For responses, this returns true if the service returned a value for the Messages 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.

    • messages

      public final List<SourceEndpointMessage> messages()

      The status messages for the source endpoint.

      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 hasMessages() method.

      Returns:
      The status messages for the source endpoint.

    • sourceType

      public final SourceEndpointType sourceType()

      The type of the source endpoint. Valid values include the following:

      • STANDARD – A source endpoint that represents an external source over a standard protocol, such as RTP, RIST, or SRT.

      • ROUTER_OUTPUT – A source endpoint that represents a router output.

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

      Returns:
      The type of the source endpoint. Valid values include the following:

      • STANDARD – A source endpoint that represents an external source over a standard protocol, such as RTP, RIST, or SRT.

      • ROUTER_OUTPUT – A source endpoint that represents a router output.

      See Also:

    • sourceTypeAsString

      public final String sourceTypeAsString()

      The type of the source endpoint. Valid values include the following:

      • STANDARD – A source endpoint that represents an external source over a standard protocol, such as RTP, RIST, or SRT.

      • ROUTER_OUTPUT – A source endpoint that represents a router output.

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

      Returns:
      The type of the source endpoint. Valid values include the following:

      • STANDARD – A source endpoint that represents an external source over a standard protocol, such as RTP, RIST, or SRT.

      • ROUTER_OUTPUT – A source endpoint that represents a router output.

      See Also:

    • configuration

      public final SourceEndpointConfiguration configuration()

      The configuration settings for the source endpoint.

      Returns:
      The configuration settings for the source endpoint.

    • resourceShareOwnership

      public final ResourceShareOwnership resourceShareOwnership()

      Indicates whether this account owns the source endpoint or consumes it from another account through RAM.

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

      Returns:
      Indicates whether this account owns the source endpoint or consumes it from another account through RAM.
      See Also:

    • resourceShareOwnershipAsString

      public final String resourceShareOwnershipAsString()

      Indicates whether this account owns the source endpoint or consumes it from another account through RAM.

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

      Returns:
      Indicates whether this account owns the source endpoint or consumes it from another account through RAM.
      See Also:

    • resourceShareDetails

      public final ResourceShareDetails resourceShareDetails()
      Returns the value of the ResourceShareDetails property for this object.
      Returns:
      The value of the ResourceShareDetails property for this object.

    • registrationState

      public final SourceEndpointRegistrationState registrationState()

      The registration state of the source endpoint. Valid values include the following:

      • REGISTERED – The source endpoint is registered and ready to use.

      • REGISTERING – MediaConnect is registering the source endpoint.

      • DEREGISTERING – MediaConnect is deregistering the source endpoint.

      • REGISTRATION_FAILED – MediaConnect couldn't register the source endpoint.

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

      Returns:
      The registration state of the source endpoint. Valid values include the following:

      • REGISTERED – The source endpoint is registered and ready to use.

      • REGISTERING – MediaConnect is registering the source endpoint.

      • DEREGISTERING – MediaConnect is deregistering the source endpoint.

      • REGISTRATION_FAILED – MediaConnect couldn't register the source endpoint.

      See Also:

    • registrationStateAsString

      public final String registrationStateAsString()

      The registration state of the source endpoint. Valid values include the following:

      • REGISTERED – The source endpoint is registered and ready to use.

      • REGISTERING – MediaConnect is registering the source endpoint.

      • DEREGISTERING – MediaConnect is deregistering the source endpoint.

      • REGISTRATION_FAILED – MediaConnect couldn't register the source endpoint.

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

      Returns:
      The registration state of the source endpoint. Valid values include the following:

      • REGISTERED – The source endpoint is registered and ready to use.

      • REGISTERING – MediaConnect is registering the source endpoint.

      • DEREGISTERING – MediaConnect is deregistering the source endpoint.

      • REGISTRATION_FAILED – MediaConnect couldn't register the source endpoint.

      See Also:

    • connectionState

      public final SourceEndpointConnectionState connectionState()

      The connection state of the source endpoint. Valid values include the following:

      • CONNECTED – The source endpoint is connected to a destination endpoint.

      • DISCONNECTED – The source endpoint isn't connected to a destination endpoint.

      • CONNECTING – The source endpoint is connecting to a destination endpoint.

      • DISCONNECTING – The source endpoint is disconnecting from a destination endpoint.

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

      Returns:
      The connection state of the source endpoint. Valid values include the following:

      • CONNECTED – The source endpoint is connected to a destination endpoint.

      • DISCONNECTED – The source endpoint isn't connected to a destination endpoint.

      • CONNECTING – The source endpoint is connecting to a destination endpoint.

      • DISCONNECTING – The source endpoint is disconnecting from a destination endpoint.

      See Also:

    • connectionStateAsString

      public final String connectionStateAsString()

      The connection state of the source endpoint. Valid values include the following:

      • CONNECTED – The source endpoint is connected to a destination endpoint.

      • DISCONNECTED – The source endpoint isn't connected to a destination endpoint.

      • CONNECTING – The source endpoint is connecting to a destination endpoint.

      • DISCONNECTING – The source endpoint is disconnecting from a destination endpoint.

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

      Returns:
      The connection state of the source endpoint. Valid values include the following:

      • CONNECTED – The source endpoint is connected to a destination endpoint.

      • DISCONNECTED – The source endpoint isn't connected to a destination endpoint.

      • CONNECTING – The source endpoint is connecting to a destination endpoint.

      • DISCONNECTING – The source endpoint is disconnecting from a destination endpoint.

      See Also:

    • connectionDetails

      public final SourceEndpointConnectionDetails connectionDetails()

      The connection details for the source endpoint.

      Returns:
      The connection details for the source endpoint.

    • hasConnectedDestinations

      public final boolean hasConnectedDestinations()
      For responses, this returns true if the service returned a value for the ConnectedDestinations 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.

    • connectedDestinations

      public final List<String> connectedDestinations()

      The Amazon Resource Names (ARNs) of the destination endpoints that are connected to the source endpoint.

      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 hasConnectedDestinations() method.

      Returns:
      The Amazon Resource Names (ARNs) of the destination endpoints that are connected to the source endpoint.

    • encryptionType

      public final EndpointEncryptionType encryptionType()

      The type of encryption used for the source endpoint connection.

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

      Returns:
      The type of encryption used for the source endpoint connection.
      See Also:

    • encryptionTypeAsString

      public final String encryptionTypeAsString()

      The type of encryption used for the source endpoint connection.

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

      Returns:
      The type of encryption used for the source endpoint connection.
      See Also:

    • encryptionConfiguration

      public final EndpointEncryptionConfiguration encryptionConfiguration()
      Returns the value of the EncryptionConfiguration property for this object.
      Returns:
      The value of the EncryptionConfiguration property for this object.

    • associatedResourceDetails

      public final SourceEndpointAssociatedResourceDetails associatedResourceDetails()

      The details of the resource that is associated with the source endpoint.

      Returns:
      The details of the resource that is associated with the source endpoint.

    • 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()

      The tags associated with the source endpoint. Each tag is a key-value pair.

      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 tags associated with the source endpoint. Each tag is a key-value pair.

    • toBuilder

      public SourceEndpoint.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SourceEndpoint.Builder,SourceEndpoint>
      Returns:
      a builder for type T

    • builder

      public static SourceEndpoint.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SourceEndpoint.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.