Class DescribeNetworkSummary
- java.lang.Object
-
- software.amazon.awssdk.services.medialive.model.DescribeNetworkSummary
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<DescribeNetworkSummary.Builder,DescribeNetworkSummary>
@Generated("software.amazon.awssdk:codegen") public final class DescribeNetworkSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DescribeNetworkSummary.Builder,DescribeNetworkSummary>
Used in ListNetworksResult.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDescribeNetworkSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()The ARN of this Network.List<String>associatedClusterIds()Returns the value of the AssociatedClusterIds property for this object.static DescribeNetworkSummary.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAssociatedClusterIds()For responses, this returns true if the service returned a value for the AssociatedClusterIds property.inthashCode()booleanhasIpPools()For responses, this returns true if the service returned a value for the IpPools property.booleanhasRoutes()For responses, this returns true if the service returned a value for the Routes property.Stringid()The ID of the Network.List<IpPool>ipPools()An array of IpPools in your organization's network that identify a collection of IP addresses in your organization's network that are reserved for use in MediaLive Anywhere.Stringname()The name that you specified for this Network.List<Route>routes()An array of routes that MediaLive Anywhere needs to know about in order to route encoding traffic.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends DescribeNetworkSummary.Builder>serializableBuilderClass()NetworkStatestate()The current state of the Network.StringstateAsString()The current state of the Network.DescribeNetworkSummary.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
-
arn
public final String arn()
The ARN of this Network. It is automatically assigned when the Network is created.- Returns:
- The ARN of this Network. It is automatically assigned when the Network is created.
-
hasAssociatedClusterIds
public final boolean hasAssociatedClusterIds()
For responses, this returns true if the service returned a value for the AssociatedClusterIds 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.
-
associatedClusterIds
public final List<String> associatedClusterIds()
Returns the value of the AssociatedClusterIds 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
hasAssociatedClusterIds()method.- Returns:
- The value of the AssociatedClusterIds property for this object.
-
id
public final String id()
The ID of the Network. Unique in the AWS account. The ID is the resource-id portion of the ARN.- Returns:
- The ID of the Network. Unique in the AWS account. The ID is the resource-id portion of the ARN.
-
hasIpPools
public final boolean hasIpPools()
For responses, this returns true if the service returned a value for the IpPools 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.
-
ipPools
public final List<IpPool> ipPools()
An array of IpPools in your organization's network that identify a collection of IP addresses in your organization's network that are reserved for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPool specifies one CIDR block.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
hasIpPools()method.- Returns:
- An array of IpPools in your organization's network that identify a collection of IP addresses in your organization's network that are reserved for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPool specifies one CIDR block.
-
name
public final String name()
The name that you specified for this Network.- Returns:
- The name that you specified for this Network.
-
hasRoutes
public final boolean hasRoutes()
For responses, this returns true if the service returned a value for the Routes 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.
-
routes
public final List<Route> routes()
An array of routes that MediaLive Anywhere needs to know about in order to route encoding traffic.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
hasRoutes()method.- Returns:
- An array of routes that MediaLive Anywhere needs to know about in order to route encoding traffic.
-
state
public final NetworkState state()
The current state of the Network. Only MediaLive Anywhere can change the state.If the service returns an enum value that is not available in the current SDK version,
statewill returnNetworkState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The current state of the Network. Only MediaLive Anywhere can change the state.
- See Also:
NetworkState
-
stateAsString
public final String stateAsString()
The current state of the Network. Only MediaLive Anywhere can change the state.If the service returns an enum value that is not available in the current SDK version,
statewill returnNetworkState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The current state of the Network. Only MediaLive Anywhere can change the state.
- See Also:
NetworkState
-
toBuilder
public DescribeNetworkSummary.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DescribeNetworkSummary.Builder,DescribeNetworkSummary>
-
builder
public static DescribeNetworkSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeNetworkSummary.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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-