InstancePortState (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.lightsail.model.InstancePortState

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class InstancePortState
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes the port state.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

InstancePortState()

Constructors
Constructor and Description
`InstancePortState()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InstancePortState`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getFromPort()` The first port in the range.
`String`	`getProtocol()` The protocol being used.
`String`	`getState()` Specifies whether the instance port is `open` or `closed`.
`Integer`	`getToPort()` The last port in the range.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setFromPort(Integer fromPort)` The first port in the range.
`void`	`setProtocol(NetworkProtocol protocol)` The protocol being used.
`void`	`setProtocol(String protocol)` The protocol being used.
`void`	`setState(PortState state)` Specifies whether the instance port is `open` or `closed`.
`void`	`setState(String state)` Specifies whether the instance port is `open` or `closed`.
`void`	`setToPort(Integer toPort)` The last port in the range.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`InstancePortState`	`withFromPort(Integer fromPort)` The first port in the range.
`InstancePortState`	`withProtocol(NetworkProtocol protocol)` The protocol being used.
`InstancePortState`	`withProtocol(String protocol)` The protocol being used.
`InstancePortState`	`withState(PortState state)` Specifies whether the instance port is `open` or `closed`.
`InstancePortState`	`withState(String state)` Specifies whether the instance port is `open` or `closed`.
`InstancePortState`	`withToPort(Integer toPort)` The last port in the range.

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

- Constructor Detail
  - InstancePortState
```
public InstancePortState()
```
- Method Detail
  - setFromPort
```
public void setFromPort(Integer fromPort)
```
    The first port in the range.
    
    Parameters:
    
    fromPort - The first port in the range.
  - getFromPort
```
public Integer getFromPort()
```
    The first port in the range.
    
    Returns:
    
    The first port in the range.
  - withFromPort
```
public InstancePortState withFromPort(Integer fromPort)
```
    The first port in the range.
    
    Parameters:
    
    fromPort - The first port in the range.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setToPort
```
public void setToPort(Integer toPort)
```
    The last port in the range.
    
    Parameters:
    
    toPort - The last port in the range.
  - getToPort
```
public Integer getToPort()
```
    The last port in the range.
    
    Returns:
    
    The last port in the range.
  - withToPort
```
public InstancePortState withToPort(Integer toPort)
```
    The last port in the range.
    
    Parameters:
    
    toPort - The last port in the range.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProtocol
```
public void setProtocol(String protocol)
```
    The protocol being used. Can be one of the following.
    - tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead.
    - all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
    - udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
    Parameters:
    protocol - The protocol being used. Can be one of the following.
    
    tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead.
    
    all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
    
    udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
    See Also:
    
    NetworkProtocol
  - getProtocol
```
public String getProtocol()
```
    The protocol being used. Can be one of the following.
    - tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead.
    - all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
    - udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
    Returns:
    The protocol being used. Can be one of the following.
    
    tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead.
    
    all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
    
    udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
    See Also:
    
    NetworkProtocol
  - withProtocol
```
public InstancePortState withProtocol(String protocol)
```
    The protocol being used. Can be one of the following.
    - tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead.
    - all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
    - udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
    Parameters:
    protocol - The protocol being used. Can be one of the following.
    
    tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead.
    
    all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
    
    udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NetworkProtocol
  - setProtocol
```
public void setProtocol(NetworkProtocol protocol)
```
    The protocol being used. Can be one of the following.
    - tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead.
    - all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
    - udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
    Parameters:
    protocol - The protocol being used. Can be one of the following.
    
    tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead.
    
    all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
    
    udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
    See Also:
    
    NetworkProtocol
  - withProtocol
```
public InstancePortState withProtocol(NetworkProtocol protocol)
```
    The protocol being used. Can be one of the following.
    - tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead.
    - all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
    - udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
    Parameters:
    protocol - The protocol being used. Can be one of the following.
    
    tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead.
    
    all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
    
    udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NetworkProtocol
  - setState
```
public void setState(String state)
```
    Specifies whether the instance port is open or closed.
    
    Parameters:
    
    state - Specifies whether the instance port is open or closed.
    
    See Also:
    
    PortState
  - getState
```
public String getState()
```
    Specifies whether the instance port is open or closed.
    
    Returns:
    
    Specifies whether the instance port is open or closed.
    
    See Also:
    
    PortState
  - withState
```
public InstancePortState withState(String state)
```
    Specifies whether the instance port is open or closed.
    
    Parameters:
    
    state - Specifies whether the instance port is open or closed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PortState
  - setState
```
public void setState(PortState state)
```
    Specifies whether the instance port is open or closed.
    
    Parameters:
    
    state - Specifies whether the instance port is open or closed.
    
    See Also:
    
    PortState
  - withState
```
public InstancePortState withState(PortState state)
```
    Specifies whether the instance port is open or closed.
    
    Parameters:
    
    state - Specifies whether the instance port is open or closed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PortState
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public InstancePortState clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class InstancePortState

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InstancePortState

Method Detail

setFromPort

getFromPort

withFromPort

setToPort

getToPort

withToPort

setProtocol

getProtocol

withProtocol

setProtocol

withProtocol

setState

getState

withState

setState

withState

toString

equals

hashCode

clone

marshall