Class Gateway
- java.lang.Object
-
- software.amazon.awssdk.services.mediaconnect.model.Gateway
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Gateway.Builder,Gateway>
@Generated("software.amazon.awssdk:codegen") public final class Gateway extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Gateway.Builder,Gateway>
The settings for a gateway, including its networks.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGateway.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Gateway.Builderbuilder()List<String>egressCidrBlocks()The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringgatewayArn()The Amazon Resource Name (ARN) of the gateway.List<MessageDetail>gatewayMessages()Returns the value of the GatewayMessages property for this object.GatewayStategatewayState()The current status of the gateway.StringgatewayStateAsString()The current status of the gateway.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasEgressCidrBlocks()For responses, this returns true if the service returned a value for the EgressCidrBlocks property.booleanhasGatewayMessages()For responses, this returns true if the service returned a value for the GatewayMessages property.inthashCode()booleanhasNetworks()For responses, this returns true if the service returned a value for the Networks property.Stringname()The name of the gateway.List<GatewayNetwork>networks()The list of networks in the gateway.List<SdkField<?>>sdkFields()static Class<? extends Gateway.Builder>serializableBuilderClass()Gateway.BuildertoBuilder()StringtoString()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
-
hasEgressCidrBlocks
public final boolean hasEgressCidrBlocks()
For responses, this returns true if the service returned a value for the EgressCidrBlocks property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
egressCidrBlocks
public final List<String> egressCidrBlocks()
The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.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
hasEgressCidrBlocks()method.- Returns:
- The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
-
gatewayArn
public final String gatewayArn()
The Amazon Resource Name (ARN) of the gateway.- Returns:
- The Amazon Resource Name (ARN) of the gateway.
-
hasGatewayMessages
public final boolean hasGatewayMessages()
For responses, this returns true if the service returned a value for the GatewayMessages property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
gatewayMessages
public final List<MessageDetail> gatewayMessages()
Returns the value of the GatewayMessages 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
hasGatewayMessages()method.- Returns:
- The value of the GatewayMessages property for this object.
-
gatewayState
public final GatewayState gatewayState()
The current status of the gateway.If the service returns an enum value that is not available in the current SDK version,
gatewayStatewill returnGatewayState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromgatewayStateAsString().- Returns:
- The current status of the gateway.
- See Also:
GatewayState
-
gatewayStateAsString
public final String gatewayStateAsString()
The current status of the gateway.If the service returns an enum value that is not available in the current SDK version,
gatewayStatewill returnGatewayState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromgatewayStateAsString().- Returns:
- The current status of the gateway.
- See Also:
GatewayState
-
name
public final String name()
The name of the gateway. This name can not be modified after the gateway is created.- Returns:
- The name of the gateway. This name can not be modified after the gateway is created.
-
hasNetworks
public final boolean hasNetworks()
For responses, this returns true if the service returned a value for the Networks property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
networks
public final List<GatewayNetwork> networks()
The list of networks in 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
hasNetworks()method.- Returns:
- The list of networks in the gateway.
-
toBuilder
public Gateway.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Gateway.Builder,Gateway>
-
builder
public static Gateway.Builder builder()
-
serializableBuilderClass
public static Class<? extends Gateway.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-