Class GatewayInstance

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

The settings for an instance in a gateway.

See Also:

  • Method Details

    • bridgePlacement

      public final BridgePlacement bridgePlacement()

      The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be deployed to this instance.

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

      Returns:
      The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be deployed to this instance.
      See Also:

    • bridgePlacementAsString

      public final String bridgePlacementAsString()

      The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be deployed to this instance.

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

      Returns:
      The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be deployed to this instance.
      See Also:

    • connectionStatus

      public final ConnectionStatus connectionStatus()

      The connection state of the instance.

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

      Returns:
      The connection state of the instance.
      See Also:

    • connectionStatusAsString

      public final String connectionStatusAsString()

      The connection state of the instance.

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

      Returns:
      The connection state of the instance.
      See Also:

    • gatewayArn

      public final String gatewayArn()

      The Amazon Resource Name (ARN) of the instance.

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

    • gatewayInstanceArn

      public final String gatewayInstanceArn()

      The ARN of the gateway.

      Returns:
      The ARN of the gateway.

    • instanceId

      public final String instanceId()

      The instance ID generated by the SSM install. This will begin with "mi-".

      Returns:
      The instance ID generated by the SSM install. This will begin with "mi-".

    • hasInstanceMessages

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

    • instanceMessages

      public final List<MessageDetail> instanceMessages()

      Messages with information about the gateway.

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

      Returns:
      Messages with information about the gateway.

    • instanceState

      public final InstanceState instanceState()

      The status of the instance.

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

      Returns:
      The status of the instance.
      See Also:

    • instanceStateAsString

      public final String instanceStateAsString()

      The status of the instance.

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

      Returns:
      The status of the instance.
      See Also:

    • runningBridgeCount

      public final Integer runningBridgeCount()

      The running bridge count.

      Returns:
      The running bridge count.

    • toBuilder

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

    • builder

      public static GatewayInstance.Builder builder()

    • serializableBuilderClass

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