software.amazon.awssdk.services.workspacesweb.model

Class NetworkSettings

java.lang.Object

software.amazon.awssdk.services.workspacesweb.model.NetworkSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<NetworkSettings.Builder,NetworkSettings>

@Generated(value="software.amazon.awssdk:codegen")
public final class NetworkSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<NetworkSettings.Builder,NetworkSettings>

A network settings resource that can be associated with a web portal. Once associated with a web portal, network settings define how streaming instances will connect with your specified VPC.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NetworkSettings.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	associatedPortalArns() A list of web portal ARNs that this network settings is associated with.
static NetworkSettings.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAssociatedPortalArns() For responses, this returns true if the service returned a value for the AssociatedPortalArns property.
int	hashCode()
boolean	hasSecurityGroupIds() For responses, this returns true if the service returned a value for the SecurityGroupIds property.
boolean	hasSubnetIds() For responses, this returns true if the service returned a value for the SubnetIds property.
String	networkSettingsArn() The ARN of the network settings.
List<SdkField<?>>	sdkFields()
List<String>	securityGroupIds() One or more security groups used to control access from streaming instances to your VPC.
static Class<? extends NetworkSettings.Builder>	serializableBuilderClass()
List<String>	subnetIds() The subnets in which network interfaces are created to connect streaming instances to your VPC.
NetworkSettings.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	vpcId() The VPC that streaming instances will connect to.

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

hasAssociatedPortalArns

public final boolean hasAssociatedPortalArns()

For responses, this returns true if the service returned a value for the AssociatedPortalArns 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.

associatedPortalArns

public final List<String> associatedPortalArns()

A list of web portal ARNs that this network settings is associated with.

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

Returns:

A list of web portal ARNs that this network settings is associated with.

networkSettingsArn

public final String networkSettingsArn()

The ARN of the network settings.

Returns:

The ARN of the network settings.

hasSecurityGroupIds

public final boolean hasSecurityGroupIds()

For responses, this returns true if the service returned a value for the SecurityGroupIds 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.

securityGroupIds

public final List<String> securityGroupIds()

One or more security groups used to control access from streaming instances to your VPC.

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

Returns:

One or more security groups used to control access from streaming instances to your VPC.

hasSubnetIds

public final boolean hasSubnetIds()

For responses, this returns true if the service returned a value for the SubnetIds 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.

subnetIds

public final List<String> subnetIds()

The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.

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

Returns:

The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.

vpcId

public final String vpcId()

The VPC that streaming instances will connect to.

Returns:

The VPC that streaming instances will connect to.

toBuilder

public NetworkSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NetworkSettings.Builder,NetworkSettings>

builder

public static NetworkSettings.Builder builder()

serializableBuilderClass

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