Class CreateBridgeRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateBridgeRequest.Builder,CreateBridgeRequest>

@Generated("software.amazon.awssdk:codegen") public final class CreateBridgeRequest extends MediaConnectRequest implements ToCopyableBuilder<CreateBridgeRequest.Builder,CreateBridgeRequest>
Creates a new bridge. The request must include one source.
  • Method Details

    • egressGatewayBridge

      public final AddEgressGatewayBridgeRequest egressGatewayBridge()
      Create a bridge with the egress bridge type. An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.
      Returns:
      Create a bridge with the egress bridge type. An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.
    • ingressGatewayBridge

      public final AddIngressGatewayBridgeRequest ingressGatewayBridge()
      Create a bridge with the ingress bridge type. An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.
      Returns:
      Create a bridge with the ingress bridge type. An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.
    • name

      public final String name()
      The name of the bridge. This name can not be modified after the bridge is created.
      Returns:
      The name of the bridge. This name can not be modified after the bridge is created.
    • hasOutputs

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

      public final List<AddBridgeOutputRequest> outputs()
      The outputs that you want to add to this bridge.

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

      Returns:
      The outputs that you want to add to this bridge.
    • placementArn

      public final String placementArn()
      The bridge placement Amazon Resource Number (ARN).
      Returns:
      The bridge placement Amazon Resource Number (ARN).
    • sourceFailoverConfig

      public final FailoverConfig sourceFailoverConfig()
      The settings for source failover.
      Returns:
      The settings for source failover.
    • hasSources

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

      public final List<AddBridgeSourceRequest> sources()
      The sources that you want to add to this bridge.

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

      Returns:
      The sources that you want to add to this bridge.
    • toBuilder

      public CreateBridgeRequest.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<CreateBridgeRequest.Builder,CreateBridgeRequest>
      Specified by:
      toBuilder in class MediaConnectRequest
      Returns:
      a builder for type T
    • builder

      public static CreateBridgeRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends CreateBridgeRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • 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.