Class DestinationEndpoint

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

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

See Also:

  • Method Details

    • name

      public final String name()

      The name of the destination endpoint.

      Returns:
      The name of the destination endpoint.

    • arn

      public final String arn()

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

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

    • id

      public final String id()

      The unique identifier of the destination endpoint.

      Returns:
      The unique identifier of the destination endpoint.

    • description

      public final String description()

      The description of the destination endpoint.

      Returns:
      The description of the destination endpoint.

    • regionName

      public final String regionName()

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

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

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone in which the destination endpoint is located.

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

    • availabilityZoneId

      public final String availabilityZoneId()

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

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

    • createdAt

      public final Instant createdAt()

      The date and time when the destination endpoint was created.

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

    • updatedAt

      public final Instant updatedAt()

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

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

    • lifecycleManagement

      public final EndpointLifecycle lifecycleManagement()

      The entity that manages the lifecycle of the destination 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 destination endpoint.
      See Also:

    • lifecycleManagementAsString

      public final String lifecycleManagementAsString()

      The entity that manages the lifecycle of the destination 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 destination 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<DestinationEndpointMessage> messages()

      The status messages for the destination 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 destination endpoint.

    • destinationType

      public final DestinationEndpointType destinationType()

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

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

      • ROUTER_INPUT – A destination endpoint that represents a router input.

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

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

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

      • ROUTER_INPUT – A destination endpoint that represents a router input.

      See Also:

    • destinationTypeAsString

      public final String destinationTypeAsString()

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

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

      • ROUTER_INPUT – A destination endpoint that represents a router input.

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

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

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

      • ROUTER_INPUT – A destination endpoint that represents a router input.

      See Also:

    • configuration

      public final DestinationEndpointConfiguration configuration()

      The configuration settings for the destination endpoint.

      Returns:
      The configuration settings for the destination endpoint.

    • resourceShareOwnership

      public final ResourceShareOwnership resourceShareOwnership()

      Indicates whether this account owns the destination 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 destination endpoint or consumes it from another account through RAM.
      See Also:

    • resourceShareOwnershipAsString

      public final String resourceShareOwnershipAsString()

      Indicates whether this account owns the destination 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 destination 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 DestinationEndpointRegistrationState registrationState()

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

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

      • REGISTERING – MediaConnect is registering the destination endpoint.

      • DEREGISTERING – MediaConnect is deregistering the destination endpoint.

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

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

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

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

      • REGISTERING – MediaConnect is registering the destination endpoint.

      • DEREGISTERING – MediaConnect is deregistering the destination endpoint.

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

      See Also:

    • registrationStateAsString

      public final String registrationStateAsString()

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

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

      • REGISTERING – MediaConnect is registering the destination endpoint.

      • DEREGISTERING – MediaConnect is deregistering the destination endpoint.

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

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

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

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

      • REGISTERING – MediaConnect is registering the destination endpoint.

      • DEREGISTERING – MediaConnect is deregistering the destination endpoint.

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

      See Also:

    • connectionDetails

      public final DestinationEndpointConnectionDetails connectionDetails()

      The connection details for the destination endpoint.

      Returns:
      The connection details for the destination endpoint.

    • connectionState

      public final DestinationEndpointConnectionState connectionState()

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

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

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

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

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

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

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

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

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

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

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

      See Also:

    • connectionStateAsString

      public final String connectionStateAsString()

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

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

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

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

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

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

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

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

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

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

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

      See Also:

    • connectedSource

      public final String connectedSource()

      The Amazon Resource Name (ARN) of the source endpoint that is connected to the destination endpoint.

      Returns:
      The Amazon Resource Name (ARN) of the source endpoint that is connected to the destination endpoint.

    • decryptionType

      public final EndpointEncryptionType decryptionType()

      The type of decryption used for the destination endpoint connection.

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

      Returns:
      The type of decryption used for the destination endpoint connection.
      See Also:

    • decryptionTypeAsString

      public final String decryptionTypeAsString()

      The type of decryption used for the destination endpoint connection.

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

      Returns:
      The type of decryption used for the destination endpoint connection.
      See Also:

    • decryptionConfiguration

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

    • associatedResourceDetails

      public final DestinationEndpointAssociatedResourceDetails associatedResourceDetails()

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

      Returns:
      The details of the resource that is associated with the destination 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 destination 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 destination endpoint. Each tag is a key-value pair.

    • toBuilder

      public DestinationEndpoint.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<DestinationEndpoint.Builder,DestinationEndpoint>
      Returns:
      a builder for type T

    • builder

      public static DestinationEndpoint.Builder builder()

    • serializableBuilderClass

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