GatewayInstance (AWS Java SDK :: Services :: MediaConnect 2.20.84 API)

java.lang.Object
- software.amazon.awssdk.services.mediaconnect.model.GatewayInstance

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<GatewayInstance.Builder,GatewayInstance>

@Generated(value="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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GatewayInstance.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GatewayInstance.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BridgePlacement`	`bridgePlacement()` The availability of the instance to host new bridges.
`String`	`bridgePlacementAsString()` The availability of the instance to host new bridges.
`static GatewayInstance.Builder`	`builder()`
`ConnectionStatus`	`connectionStatus()` The connection state of the instance.
`String`	`connectionStatusAsString()` The connection state of the instance.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`gatewayArn()` The Amazon Resource Name (ARN) of the instance.
`String`	`gatewayInstanceArn()` The Amazon Resource Name (ARN) of the gateway.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasInstanceMessages()` For responses, this returns true if the service returned a value for the InstanceMessages property.
`String`	`instanceId()` The managed instance ID generated by the SSM install.
`List<MessageDetail>`	`instanceMessages()` Returns the value of the InstanceMessages property for this object.
`InstanceState`	`instanceState()` The status of the instance.
`String`	`instanceStateAsString()` The status of the instance.
`Integer`	`runningBridgeCount()` The running bridge count.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GatewayInstance.Builder>`	`serializableBuilderClass()`
`GatewayInstance.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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 added 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 added to this instance.
    
    See Also:
    
    BridgePlacement
  - 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 added 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 added to this instance.
    
    See Also:
    
    BridgePlacement
  - 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:
    
    ConnectionStatus
  - 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:
    
    ConnectionStatus
  - 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 Amazon Resource Name (ARN) of the gateway.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the gateway.
  - instanceId
```
public final String instanceId()
```
    The managed instance ID generated by the SSM install. This will begin with "mi-".
    
    Returns:
    
    The managed 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()
```
    Returns the value of the InstanceMessages property for this object.
    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:
    
    The value of the InstanceMessages property for this object.
  - 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:
    
    InstanceState
  - 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:
    
    InstanceState
  - runningBridgeCount
```
public final Integer runningBridgeCount()
```
    The running bridge count.
    
    Returns:
    
    The running bridge count.
  - toBuilder
```
public GatewayInstance.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GatewayInstance.Builder,GatewayInstance>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class GatewayInstance

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

bridgePlacement

bridgePlacementAsString

connectionStatus

connectionStatusAsString

gatewayArn

gatewayInstanceArn

instanceId

hasInstanceMessages

instanceMessages

instanceState

instanceStateAsString

runningBridgeCount

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields