Interface SourceEndpoint.Builder

  • Method Details

    • name

      The name of the source endpoint.

      Parameters:
      name - The name of the source endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • arn

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

      Parameters:
      arn - The Amazon Resource Name (ARN) of the source endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • id

      The unique identifier of the source endpoint.

      Parameters:
      id - The unique identifier of the source endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • description

      SourceEndpoint.Builder description(String description)

      The description of the source endpoint.

      Parameters:
      description - The description of the source endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • regionName

      SourceEndpoint.Builder regionName(String regionName)

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

      Parameters:
      regionName - The name of the Amazon Web Services Region in which the source endpoint is located.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • availabilityZone

      SourceEndpoint.Builder availabilityZone(String availabilityZone)

      The Availability Zone in which the source endpoint is located.

      Parameters:
      availabilityZone - The Availability Zone in which the source endpoint is located.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • availabilityZoneId

      SourceEndpoint.Builder availabilityZoneId(String availabilityZoneId)

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

      Parameters:
      availabilityZoneId - The ID of the Availability Zone in which the source endpoint is located.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • createdAt

      SourceEndpoint.Builder createdAt(Instant createdAt)

      The date and time when the source endpoint was created.

      Parameters:
      createdAt - The date and time when the source endpoint was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • updatedAt

      SourceEndpoint.Builder updatedAt(Instant updatedAt)

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

      Parameters:
      updatedAt - The date and time when the source endpoint was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • lifecycleManagement

      SourceEndpoint.Builder lifecycleManagement(String lifecycleManagement)

      The entity that manages the lifecycle of the source endpoint.

      Parameters:
      lifecycleManagement - The entity that manages the lifecycle of the source endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • lifecycleManagement

      SourceEndpoint.Builder lifecycleManagement(EndpointLifecycle lifecycleManagement)

      The entity that manages the lifecycle of the source endpoint.

      Parameters:
      lifecycleManagement - The entity that manages the lifecycle of the source endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • messages

      The status messages for the source endpoint.

      Parameters:
      messages - The status messages for the source endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • messages

      The status messages for the source endpoint.

      Parameters:
      messages - The status messages for the source endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • messages

      The status messages for the source endpoint.

      This is a convenience method that creates an instance of the SourceEndpointMessage.Builder avoiding the need to create one manually via SourceEndpointMessage.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to messages(List<SourceEndpointMessage>).

      Parameters:
      messages - a consumer that will call methods on SourceEndpointMessage.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • sourceType

      SourceEndpoint.Builder sourceType(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • configuration

      The configuration settings for the source endpoint.

      Parameters:
      configuration - The configuration settings for the source endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • configuration

      The configuration settings for the source endpoint.

      This is a convenience method that creates an instance of the SourceEndpointConfiguration.Builder avoiding the need to create one manually via SourceEndpointConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to configuration(SourceEndpointConfiguration).

      Parameters:
      configuration - a consumer that will call methods on SourceEndpointConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • resourceShareOwnership

      SourceEndpoint.Builder resourceShareOwnership(String resourceShareOwnership)

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

      Parameters:
      resourceShareOwnership - Indicates whether this account owns the source endpoint or consumes it from another account through RAM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • resourceShareOwnership

      SourceEndpoint.Builder resourceShareOwnership(ResourceShareOwnership resourceShareOwnership)

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

      Parameters:
      resourceShareOwnership - Indicates whether this account owns the source endpoint or consumes it from another account through RAM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • resourceShareDetails

      SourceEndpoint.Builder resourceShareDetails(ResourceShareDetails resourceShareDetails)
      Sets the value of the ResourceShareDetails property for this object.
      Parameters:
      resourceShareDetails - The new value for the ResourceShareDetails property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • resourceShareDetails

      default SourceEndpoint.Builder resourceShareDetails(Consumer<ResourceShareDetails.Builder> resourceShareDetails)
      Sets the value of the ResourceShareDetails property for this object. This is a convenience method that creates an instance of the ResourceShareDetails.Builder avoiding the need to create one manually via ResourceShareDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resourceShareDetails(ResourceShareDetails).

      Parameters:
      resourceShareDetails - a consumer that will call methods on ResourceShareDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • registrationState

      SourceEndpoint.Builder registrationState(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • registrationState

      SourceEndpoint.Builder registrationState(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • connectionState

      SourceEndpoint.Builder connectionState(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • connectionState

      SourceEndpoint.Builder connectionState(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • connectionDetails

      SourceEndpoint.Builder connectionDetails(SourceEndpointConnectionDetails connectionDetails)

      The connection details for the source endpoint.

      Parameters:
      connectionDetails - The connection details for the source endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • connectionDetails

      default SourceEndpoint.Builder connectionDetails(Consumer<SourceEndpointConnectionDetails.Builder> connectionDetails)

      The connection details for the source endpoint.

      This is a convenience method that creates an instance of the SourceEndpointConnectionDetails.Builder avoiding the need to create one manually via SourceEndpointConnectionDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to connectionDetails(SourceEndpointConnectionDetails).

      Parameters:
      connectionDetails - a consumer that will call methods on SourceEndpointConnectionDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • connectedDestinations

      SourceEndpoint.Builder connectedDestinations(Collection<String> connectedDestinations)

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

      Parameters:
      connectedDestinations - The Amazon Resource Names (ARNs) of the destination endpoints that are connected to the source endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • connectedDestinations

      SourceEndpoint.Builder connectedDestinations(String... connectedDestinations)

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

      Parameters:
      connectedDestinations - The Amazon Resource Names (ARNs) of the destination endpoints that are connected to the source endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • encryptionType

      SourceEndpoint.Builder encryptionType(String encryptionType)

      The type of encryption used for the source endpoint connection.

      Parameters:
      encryptionType - The type of encryption used for the source endpoint connection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • encryptionType

      SourceEndpoint.Builder encryptionType(EndpointEncryptionType encryptionType)

      The type of encryption used for the source endpoint connection.

      Parameters:
      encryptionType - The type of encryption used for the source endpoint connection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • encryptionConfiguration

      SourceEndpoint.Builder encryptionConfiguration(EndpointEncryptionConfiguration encryptionConfiguration)
      Sets the value of the EncryptionConfiguration property for this object.
      Parameters:
      encryptionConfiguration - The new value for the EncryptionConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • encryptionConfiguration

      default SourceEndpoint.Builder encryptionConfiguration(Consumer<EndpointEncryptionConfiguration.Builder> encryptionConfiguration)
      Sets the value of the EncryptionConfiguration property for this object. This is a convenience method that creates an instance of the EndpointEncryptionConfiguration.Builder avoiding the need to create one manually via EndpointEncryptionConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionConfiguration(EndpointEncryptionConfiguration).

      Parameters:
      encryptionConfiguration - a consumer that will call methods on EndpointEncryptionConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • associatedResourceDetails

      SourceEndpoint.Builder associatedResourceDetails(SourceEndpointAssociatedResourceDetails associatedResourceDetails)

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

      Parameters:
      associatedResourceDetails - The details of the resource that is associated with the source endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • associatedResourceDetails

      default SourceEndpoint.Builder associatedResourceDetails(Consumer<SourceEndpointAssociatedResourceDetails.Builder> associatedResourceDetails)

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

      This is a convenience method that creates an instance of the SourceEndpointAssociatedResourceDetails.Builder avoiding the need to create one manually via SourceEndpointAssociatedResourceDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to associatedResourceDetails(SourceEndpointAssociatedResourceDetails).

      Parameters:
      associatedResourceDetails - a consumer that will call methods on SourceEndpointAssociatedResourceDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • tags

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

      Parameters:
      tags - The tags associated with the source endpoint. Each tag is a key-value pair.
      Returns:
      Returns a reference to this object so that method calls can be chained together.