OrganizationsorganizationIdappliancevpnthirdPartyVPNPeersPeers implements ModelInterface, ArrayAccess
OrganizationsorganizationIdappliancevpnthirdPartyVPNPeersPeers Class Doc Comment
Tags
Interfaces, Classes and Traits
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
Table of Contents
- DISCRIMINATOR = null
- IKE_VERSION__1 = '1'
- IKE_VERSION__2 = '2'
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- $swaggerFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $swaggerModelName : string
- The original name of the model.
- $swaggerTypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getIkeVersion() : string
- Gets ike_version
- getIkeVersionAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getIpsecPolicies() : OrganizationsorganizationIdappliancevpnthirdPartyVPNPeersIpsecPolicies
- Gets ipsec_policies
- getIpsecPoliciesPreset() : string
- Gets ipsec_policies_preset
- getModelName() : string
- The original name of the model.
- getName() : string
- Gets name
- getNetworkTags() : array<string|int, string>
- Gets network_tags
- getPrivateSubnets() : array<string|int, string>
- Gets private_subnets
- getPublicIp() : string
- Gets public_ip
- getRemoteId() : string
- Gets remote_id
- getSecret() : string
- Gets secret
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- setIkeVersion() : $this
- Sets ike_version
- setIpsecPolicies() : $this
- Sets ipsec_policies
- setIpsecPoliciesPreset() : $this
- Sets ipsec_policies_preset
- setName() : $this
- Sets name
- setNetworkTags() : $this
- Sets network_tags
- setPrivateSubnets() : $this
- Sets private_subnets
- setPublicIp() : $this
- Sets public_ip
- setRemoteId() : $this
- Sets remote_id
- setSecret() : $this
- Sets secret
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- swaggerFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- swaggerTypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- valid() : bool
- Validate all the properties in the model return true if all passed
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
IKE_VERSION__1
public
mixed
IKE_VERSION__1
= '1'
IKE_VERSION__2
public
mixed
IKE_VERSION__2
= '2'
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['name' => 'name', 'public_ip' => 'publicIp', 'remote_id' => 'remoteId', 'private_subnets' => 'privateSubnets', 'ipsec_policies' => 'ipsecPolicies', 'ipsec_policies_preset' => 'ipsecPoliciesPreset', 'secret' => 'secret', 'ike_version' => 'ikeVersion', 'network_tags' => 'networkTags']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['name' => 'getName', 'public_ip' => 'getPublicIp', 'remote_id' => 'getRemoteId', 'private_subnets' => 'getPrivateSubnets', 'ipsec_policies' => 'getIpsecPolicies', 'ipsec_policies_preset' => 'getIpsecPoliciesPreset', 'secret' => 'getSecret', 'ike_version' => 'getIkeVersion', 'network_tags' => 'getNetworkTags']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['name' => 'setName', 'public_ip' => 'setPublicIp', 'remote_id' => 'setRemoteId', 'private_subnets' => 'setPrivateSubnets', 'ipsec_policies' => 'setIpsecPolicies', 'ipsec_policies_preset' => 'setIpsecPoliciesPreset', 'secret' => 'setSecret', 'ike_version' => 'setIkeVersion', 'network_tags' => 'setNetworkTags']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['name' => null, 'public_ip' => null, 'remote_id' => null, 'private_subnets' => null, 'ipsec_policies' => null, 'ipsec_policies_preset' => null, 'secret' => null, 'ike_version' => null, 'network_tags' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'organizationsorganizationIdappliancevpnthirdPartyVPNPeers_peers'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['name' => 'string', 'public_ip' => 'string', 'remote_id' => 'string', 'private_subnets' => 'string[]', 'ipsec_policies' => '\Swagger\Client\Model\OrganizationsorganizationIdappliancevpnthirdPartyVPNPeersIpsecPolicies', 'ipsec_policies_preset' => 'string', 'secret' => 'string', 'ike_version' => 'string', 'network_tags' => 'string[]']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getIkeVersion()
Gets ike_version
public
getIkeVersion() : string
Return values
string —getIkeVersionAllowableValues()
Gets allowable values of the enum
public
getIkeVersionAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getIpsecPolicies()
Gets ipsec_policies
public
getIpsecPolicies() : OrganizationsorganizationIdappliancevpnthirdPartyVPNPeersIpsecPolicies
Return values
OrganizationsorganizationIdappliancevpnthirdPartyVPNPeersIpsecPolicies —getIpsecPoliciesPreset()
Gets ipsec_policies_preset
public
getIpsecPoliciesPreset() : string
Return values
string —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string
Return values
string —getNetworkTags()
Gets network_tags
public
getNetworkTags() : array<string|int, string>
Return values
array<string|int, string> —getPrivateSubnets()
Gets private_subnets
public
getPrivateSubnets() : array<string|int, string>
Return values
array<string|int, string> —getPublicIp()
Gets public_ip
public
getPublicIp() : string
Return values
string —getRemoteId()
Gets remote_id
public
getRemoteId() : string
Return values
string —getSecret()
Gets secret
public
getSecret() : string
Return values
string —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —listInvalidProperties()
Show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed
Parameters
- $offset : int
-
Offset
Return values
mixed —offsetSet()
Sets value based on offset.
public
offsetSet(int $offset, mixed $value) : void
Parameters
- $offset : int
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —setIkeVersion()
Sets ike_version
public
setIkeVersion(string $ike_version) : $this
Parameters
- $ike_version : string
-
[optional] The IKE version to be used for the IPsec VPN peer configuration. Defaults to '1' when omitted.
Return values
$this —setIpsecPolicies()
Sets ipsec_policies
public
setIpsecPolicies(OrganizationsorganizationIdappliancevpnthirdPartyVPNPeersIpsecPolicies $ipsec_policies) : $this
Parameters
- $ipsec_policies : OrganizationsorganizationIdappliancevpnthirdPartyVPNPeersIpsecPolicies
-
ipsec_policies
Return values
$this —setIpsecPoliciesPreset()
Sets ipsec_policies_preset
public
setIpsecPoliciesPreset(string $ipsec_policies_preset) : $this
Parameters
- $ipsec_policies_preset : string
-
One of the following available presets: 'default', 'aws', 'azure'. If this is provided, the 'ipsecPolicies' parameter is ignored.
Return values
$this —setName()
Sets name
public
setName(string $name) : $this
Parameters
- $name : string
-
The name of the VPN peer
Return values
$this —setNetworkTags()
Sets network_tags
public
setNetworkTags(array<string|int, string> $network_tags) : $this
Parameters
- $network_tags : array<string|int, string>
-
A list of network tags that will connect with this peer. Use ['all'] for all networks. Use ['none'] for no networks. If not included, the default is ['all'].
Return values
$this —setPrivateSubnets()
Sets private_subnets
public
setPrivateSubnets(array<string|int, string> $private_subnets) : $this
Parameters
- $private_subnets : array<string|int, string>
-
The list of the private subnets of the VPN peer
Return values
$this —setPublicIp()
Sets public_ip
public
setPublicIp(string $public_ip) : $this
Parameters
- $public_ip : string
-
The public IP of the VPN peer
Return values
$this —setRemoteId()
Sets remote_id
public
setRemoteId(string $remote_id) : $this
Parameters
- $remote_id : string
-
[optional] The remote ID is used to identify the connecting VPN peer. This can either be a valid IPv4 Address, FQDN or User FQDN.
Return values
$this —setSecret()
Sets secret
public
setSecret(string $secret) : $this
Parameters
- $secret : string
-
The shared secret with the VPN peer
Return values
$this —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerFormats()
Array of property to format mappings. Used for (de)serialization
public
static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerTypes()
Array of property to type mappings. Used for (de)serialization
public
static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properties are valid