InstancePortInfo (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Describes information about the instance ports.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

InstancePortInfo()

Constructors
Constructor and Description
`InstancePortInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InstancePortInfo`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAccessDirection()` The access direction (`inbound` or `outbound`).
`String`	`getAccessFrom()` The location from which access is allowed (e.g., `Anywhere (0.0.0.0/0)`).
`String`	`getAccessType()` The type of access (`Public` or `Private`).
`String`	`getCommonName()` The common name.
`Integer`	`getFromPort()` The first port in the range.
`String`	`getProtocol()` The protocol being used.
`Integer`	`getToPort()` The last port in the range.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAccessDirection(AccessDirection accessDirection)` The access direction (`inbound` or `outbound`).
`void`	`setAccessDirection(String accessDirection)` The access direction (`inbound` or `outbound`).
`void`	`setAccessFrom(String accessFrom)` The location from which access is allowed (e.g., `Anywhere (0.0.0.0/0)`).
`void`	`setAccessType(PortAccessType accessType)` The type of access (`Public` or `Private`).
`void`	`setAccessType(String accessType)` The type of access (`Public` or `Private`).
`void`	`setCommonName(String commonName)` The common name.
`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`	`setToPort(Integer toPort)` The last port in the range.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`InstancePortInfo`	`withAccessDirection(AccessDirection accessDirection)` The access direction (`inbound` or `outbound`).
`InstancePortInfo`	`withAccessDirection(String accessDirection)` The access direction (`inbound` or `outbound`).
`InstancePortInfo`	`withAccessFrom(String accessFrom)` The location from which access is allowed (e.g., `Anywhere (0.0.0.0/0)`).
`InstancePortInfo`	`withAccessType(PortAccessType accessType)` The type of access (`Public` or `Private`).
`InstancePortInfo`	`withAccessType(String accessType)` The type of access (`Public` or `Private`).
`InstancePortInfo`	`withCommonName(String commonName)` The common name.
`InstancePortInfo`	`withFromPort(Integer fromPort)` The first port in the range.
`InstancePortInfo`	`withProtocol(NetworkProtocol protocol)` The protocol being used.
`InstancePortInfo`	`withProtocol(String protocol)` The protocol being used.
`InstancePortInfo`	`withToPort(Integer toPort)` The last port in the range.

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

- Constructor Detail
  - InstancePortInfo
```
public InstancePortInfo()
```
- 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 InstancePortInfo 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 InstancePortInfo 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 InstancePortInfo 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 InstancePortInfo 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
  - setAccessFrom
```
public void setAccessFrom(String accessFrom)
```
    The location from which access is allowed (e.g., Anywhere (0.0.0.0/0)).
    
    Parameters:
    
    accessFrom - The location from which access is allowed (e.g., Anywhere (0.0.0.0/0)).
  - getAccessFrom
```
public String getAccessFrom()
```
    The location from which access is allowed (e.g., Anywhere (0.0.0.0/0)).
    
    Returns:
    
    The location from which access is allowed (e.g., Anywhere (0.0.0.0/0)).
  - withAccessFrom
```
public InstancePortInfo withAccessFrom(String accessFrom)
```
    The location from which access is allowed (e.g., Anywhere (0.0.0.0/0)).
    
    Parameters:
    
    accessFrom - The location from which access is allowed (e.g., Anywhere (0.0.0.0/0)).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccessType
```
public void setAccessType(String accessType)
```
    The type of access (Public or Private).
    
    Parameters:
    
    accessType - The type of access (Public or Private).
    
    See Also:
    
    PortAccessType
  - getAccessType
```
public String getAccessType()
```
    The type of access (Public or Private).
    
    Returns:
    
    The type of access (Public or Private).
    
    See Also:
    
    PortAccessType
  - withAccessType
```
public InstancePortInfo withAccessType(String accessType)
```
    The type of access (Public or Private).
    
    Parameters:
    
    accessType - The type of access (Public or Private).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PortAccessType
  - setAccessType
```
public void setAccessType(PortAccessType accessType)
```
    The type of access (Public or Private).
    
    Parameters:
    
    accessType - The type of access (Public or Private).
    
    See Also:
    
    PortAccessType
  - withAccessType
```
public InstancePortInfo withAccessType(PortAccessType accessType)
```
    The type of access (Public or Private).
    
    Parameters:
    
    accessType - The type of access (Public or Private).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PortAccessType
  - setCommonName
```
public void setCommonName(String commonName)
```
    The common name.
    
    Parameters:
    
    commonName - The common name.
  - getCommonName
```
public String getCommonName()
```
    The common name.
    
    Returns:
    
    The common name.
  - withCommonName
```
public InstancePortInfo withCommonName(String commonName)
```
    The common name.
    
    Parameters:
    
    commonName - The common name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccessDirection
```
public void setAccessDirection(String accessDirection)
```
    The access direction (inbound or outbound).
    
    Parameters:
    
    accessDirection - The access direction (inbound or outbound).
    
    See Also:
    
    AccessDirection
  - getAccessDirection
```
public String getAccessDirection()
```
    The access direction (inbound or outbound).
    
    Returns:
    
    The access direction (inbound or outbound).
    
    See Also:
    
    AccessDirection
  - withAccessDirection
```
public InstancePortInfo withAccessDirection(String accessDirection)
```
    The access direction (inbound or outbound).
    
    Parameters:
    
    accessDirection - The access direction (inbound or outbound).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AccessDirection
  - setAccessDirection
```
public void setAccessDirection(AccessDirection accessDirection)
```
    The access direction (inbound or outbound).
    
    Parameters:
    
    accessDirection - The access direction (inbound or outbound).
    
    See Also:
    
    AccessDirection
  - withAccessDirection
```
public InstancePortInfo withAccessDirection(AccessDirection accessDirection)
```
    The access direction (inbound or outbound).
    
    Parameters:
    
    accessDirection - The access direction (inbound or outbound).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AccessDirection
  - 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 InstancePortInfo 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 InstancePortInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InstancePortInfo

Method Detail

setFromPort

getFromPort

withFromPort

setToPort

getToPort

withToPort

setProtocol

getProtocol

withProtocol

setProtocol

withProtocol

setAccessFrom

getAccessFrom

withAccessFrom

setAccessType

getAccessType

withAccessType

setAccessType

withAccessType

setCommonName

getCommonName

withCommonName

setAccessDirection

getAccessDirection

withAccessDirection

setAccessDirection

withAccessDirection

toString

equals

hashCode

clone

marshall